cellpy.readers.instruments.configurations#

Very simple implementation of a plugin-like infrastructure

Submodules#

Package Contents#

Classes#

ModelParameters

Dataclass to store sub-model specific parameters.

Functions#

register_configuration_from_module(→ ModelParameters)

Register a python module (.py file) and return it.

register_local_configuration_from_yaml_file(...)

Register a module (.yml file) and return it.

Attributes#

HARD_CODED_MODULE_PATH

OPTIONAL_DICTIONARY_ATTRIBUTE_NAMES

OPTIONAL_LIST_ATTRIBUTE_NAMES

RAW_LIMITS

class ModelParameters[source]#

Dataclass to store sub-model specific parameters.

columns_to_keep: list[source]#
file_info: dict[source]#
formatters: dict[source]#
incremental_unit_labels: dict[source]#
meta_keys: dict[source]#
name: str[source]#
normal_headers_renaming_dict: dict[source]#
not_implemented_in_cellpy_yet_renaming_dict: dict[source]#
post_processors: dict[source]#
pre_processors: dict[source]#
prefixes: dict[source]#
raw_limits: dict[source]#
raw_units: dict[source]#
states: dict[source]#
unit_labels: dict[source]#
register_configuration_from_module(name: str = 'one', module: str = 'maccor_txt_one', _module_path=None, _m=None) ModelParameters[source]#

Register a python module (.py file) and return it.

This function will dynamically import the given module from the cellpy.readers.instruments.configurations module and return it.

Returns:

ModelParameters

register_local_configuration_from_yaml_file(instrument) ModelParameters[source]#

Register a module (.yml file) and return it.

This function will dynamically import the given module from the cellpy.readers.instruments.configurations module and return it.

Returns:

ModelParameters

HARD_CODED_MODULE_PATH = 'cellpy.readers.instruments.configurations'[source]#
OPTIONAL_DICTIONARY_ATTRIBUTE_NAMES = ['file_info', 'formatters', 'prefixes', 'pre_processors', 'post_processors', 'meta_keys',...[source]#
OPTIONAL_LIST_ATTRIBUTE_NAMES = ['columns_to_keep'][source]#
RAW_LIMITS[source]#