cellpy.parameters.prms

cellpy parameters

Module Contents

Classes

BatchClass	Settings for batch processing.
CellInfoClass	Values used for setting the parameters related to the cell and the cycling
CellPyConfig	Session settings (global).
CellPyDataConfig	Settings that can be unique for each CellpyCell instance.
DbClass	Settings for the handling the simple database.
DbColsClass	Names of the columns in the simple database.
DbColsUnitClass	Unit of the columns in the simple database.
FileNamesClass	Settings for file names and file handling.
InstrumentsClass	Settings for the instruments.
MaterialsClass	Default material-specific values used in processing the data.
PathsClass	Paths used in cellpy.
ReaderClass	Settings for reading data.

Attributes

Arbin
Batch
CellInfo
Db
DbCols
FileNames
Instruments
Maccor
Materials
Neware
Paths
Reader
cur_dir
op_wdir
script_dir
user_dir
wdir

class BatchClass

Bases: CellPyConfig

Settings for batch processing.

auto_use_file_list: bool = False

backend: str = 'plotly'

color_style_label: str = 'seaborn-deep'

dpi: int = 300

fig_extension: str = 'png'

figure_type: str = 'unlimited'

markersize: int = 4

notebook: bool = True

summary_plot_height: int = 800

summary_plot_height_fractions: List[float]

summary_plot_width: int = 900

symbol_label: str = 'simple'

template: str = 'standard'

class CellInfoClass

Bases: CellPyDataConfig

Values used for setting the parameters related to the cell and the cycling

active_electrode_area: float = 1.0

active_electrode_current_collector: str = 'standard'

active_electrode_thickness: float = 1.0

active_electrode_type: str = 'standard'

cell_type: str = 'standard'

comment: str = ''

counter_electrode_type: str = 'standard'

electrolyte_type: str = 'standard'

electrolyte_volume: float = 1.0

experiment_type: str = 'cycling'

reference_electrode_current_collector: str = 'standard'

reference_electrode_type: str = 'standard'

separator_type: str = 'standard'

voltage_lim_high: float = 1.0

voltage_lim_low: float = 0.0

class CellPyConfig

Session settings (global).

keys()

class CellPyDataConfig

Settings that can be unique for each CellpyCell instance.

class DbClass

Bases: CellPyConfig

Settings for the handling the simple database.

db_connection: str | None

db_data_start_row: int = 2

db_file_sqlite: str = 'excel.db'

db_header_row: int = 0

db_search_end_row: int

db_search_start_row: int = 2

db_table_name: str = 'db_table'

db_type: str = 'simple_excel_reader'

db_unit_row: int = 1

class DbColsClass

Bases: CellPyConfig

Names of the columns in the simple database.

area: str = 'area'

argument: str = 'argument'

batch: str = 'batch'

cell_name: str = 'cell'

cell_type: str = 'cell_type'

cellpy_file_name: str = 'cellpy_file_name'

comment_cell: str = 'comment_cell'

comment_general: str = 'comment_general'

comment_slurry: str = 'comment_slurry'

exists: str = 'exists'

experiment_type: str = 'experiment_type'

file_name_indicator: str = 'file_name_indicator'

freeze: str = 'freeze'

group: str = 'group'

id: str = 'id'

instrument: str = 'instrument'

label: str = 'label'

loading: str = 'loading_active_material'

mass_active: str = 'mass_active_material'

mass_total: str = 'mass_total'

nom_cap: str = 'nominal_capacity'

project: str = 'project'

raw_file_names: str = 'raw_file_names'

selected: str = 'selected'

sub_batch_01: str = 'b01'

sub_batch_02: str = 'b02'

sub_batch_03: str = 'b03'

sub_batch_04: str = 'b04'

sub_batch_05: str = 'b05'

sub_batch_06: str = 'b06'

sub_batch_07: str = 'b07'

class DbColsUnitClass

Bases: CellPyConfig

Unit of the columns in the simple database.

area: str = 'float'

argument: str = 'str'

batch: str = 'str'

cell_name: str = 'str'

cell_type: str = 'str'

cellpy_file_name: str = 'str'

comment_cell: str = 'str'

comment_general: str = 'str'

comment_slurry: str = 'str'

exists: str = 'int'

experiment_type: str = 'str'

file_name_indicator: str = 'str'

freeze: str = 'int'

group: str = 'str'

id: str = 'str'

instrument: str = 'str'

label: str = 'str'

loading: str = 'float'

mass_active: str = 'float'

mass_total: str = 'float'

nom_cap: str = 'float'

project: str = 'str'

raw_file_names: str = 'str'

selected: str = 'int'

sub_batch_01: str = 'str'

sub_batch_02: str = 'str'

sub_batch_03: str = 'str'

sub_batch_04: str = 'str'

sub_batch_05: str = 'str'

sub_batch_06: str = 'str'

sub_batch_07: str = 'str'

class FileNamesClass

Bases: CellPyConfig

Settings for file names and file handling.

cellpy_file_extension: str = 'h5'

file_list_location: str

file_list_name: str

file_list_type: str

file_name_format: str = 'YYYYMMDD_[NAME]EEE_CC_TT_RR'

raw_extension: str = 'res'

reg_exp: str

sub_folders: bool = True

class InstrumentsClass

Bases: CellPyConfig

Settings for the instruments.

Arbin: box.Box

Maccor: box.Box

Neware: box.Box

custom_instrument_definitions_file: str | None

tester: str | None

class MaterialsClass

Bases: CellPyDataConfig

Default material-specific values used in processing the data.

cell_class: str = 'Li-Ion'

default_mass: float = 1.0

default_material: str = 'silicon'

default_nom_cap: float = 1.0

default_nom_cap_specifics: str = 'gravimetric'

class PathsClass

Bases: CellPyConfig

Paths used in cellpy.

property cellpydatadir: cellpy.internals.core.OtherPath

property rawdatadir: cellpy.internals.core.OtherPath

batchfiledir: pathlib.Path | str

db_filename: str = 'cellpy_db.xlsx'

db_path: pathlib.Path | str

env_file: pathlib.Path | str

examplesdir: pathlib.Path | str

filelogdir: pathlib.Path | str

instrumentdir: pathlib.Path | str

notebookdir: pathlib.Path | str

outdatadir: pathlib.Path | str

templatedir: pathlib.Path | str

class ReaderClass

Bases: CellPyConfig

Settings for reading data.

auto_dirs: bool = True

capacity_interpolation_step: float = 2.0

cycle_mode: str = 'anode'

diagnostics: bool = False

ensure_step_table: bool = False

ensure_summary_table: bool = False

filestatuschecker: str = 'size'

force_all: bool = False

force_step_table_creation: bool = True

jupyter_executable: str = 'jupyter'

limit_loaded_cycles: int | None

select_minimal: bool = False

sep: str = ';'

sorted_data: bool = True

time_interpolation_step: float = 10.0

use_cellpy_stat_file: bool = False

voltage_interpolation_step: float = 0.01

Arbin

Batch

CellInfo

Db

DbCols

FileNames

Instruments

Maccor

Materials

Neware

Paths

Reader

cur_dir

op_wdir

script_dir

user_dir

wdir