cellpy.readers.instruments.configurations package

cellpy.readers.instruments.configurations package#

Submodules#

cellpy.readers.instruments.configurations.maccor_txt_one module#

Configuration for tab-delimited Maccor txt files with three comment rows (used by UBham in the SIMBA project).

cellpy.readers.instruments.configurations.maccor_txt_three module#

Configuration for tab-delimited Maccor txt files with two comment rows (used by WMG in the SIMBA project).

cellpy.readers.instruments.configurations.maccor_txt_two module#

Configuration for tab-delimited Maccor txt files with 12 comment rows (used by KIT in the SIMBA project).

cellpy.readers.instruments.configurations.maccor_txt_zero module#

cellpy.readers.instruments.configurations.neware_txt_one module#

cellpy.readers.instruments.configurations.neware_txt_zero module#

Module contents#

Very simple implementation of a plugin-like infrastructure

class ModelParameters(name: str, file_info: dict = <factory>, unit_labels: dict = <factory>, incremental_unit_labels: dict = <factory>, normal_headers_renaming_dict: dict = <factory>, not_implemented_in_cellpy_yet_renaming_dict: dict = <factory>, columns_to_keep: list = <factory>, states: dict = <factory>, raw_units: dict = <factory>, raw_limits: dict = <factory>, formatters: dict = <factory>, meta_keys: dict = <factory>, pre_processors: dict = <factory>, post_processors: dict = <factory>, prefixes: dict = <factory>)[source]#

Bases: object

Dataclass to store sub-model specific parameters.

columns_to_keep: list#
file_info: dict#
formatters: dict#
incremental_unit_labels: dict#
meta_keys: dict#
name: str#
normal_headers_renaming_dict: dict#
not_implemented_in_cellpy_yet_renaming_dict: dict#
post_processors: dict#
pre_processors: dict#
prefixes: dict#
raw_limits: dict#
raw_units: dict#
states: dict#
unit_labels: dict#
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