neclib.core package#

General operations and object model definitions of NECLIB.

Important

The implementations in this namespace should not depend on any other NECLIB subpackages without deep consideration. Such dependencies will someday create circular imports and make it hard to implement new features.

Aliases#

Configuration	None
ConfigurationView	Sliced configuration.
NECSTAccessibilityWarning	Warning on limited usage.
NECSTAuthorityError	Error related to controlling priority.
NECSTConfigurationError	Error related to parameter configuration.
NECSTParameterNameError	Error related to limitation on parameter name.
NECSTTimeoutError	Error related to communication timeout.
NPArrayValidator	Type validator, to force some instance variables to be Quantity.
Ordinal	Integer, with corresponding suffix as ordinal number in string representation.
Parameters	General format of NECLIB parameters.
QuantityValidator	Type validator, to force some instance variables to be Quantity.
RichParameters	Parameters with flexible look-up and high-level representation support.
StatusManager	Manage multiple contexts.
ValueRange	Value range bound by 2 values.
config	None
configure	Copy default configuration files into your local file system.
deprecated	Decorator to mark a function as deprecated.
deprecated_namespace	None
disabled	A decorator to disable a function or method.
find_config	Look for the configuration file from environment variables and defaults.
get_logger	Get logger instance which prints operation logs to console.
get_quantity	Convert a value to astropy Quantity.
partial	None
read	Read a file, if it’s accessible via any available way.

Subpackages#