pyprobe.cyclers.biologic module

A module to load and process Biologic battery cycler data.

pydantic model Biologic(*, input_data_path, column_dict={'<I>/*': 'Current [*]', 'Date': 'Date', 'Ecell/*': 'Voltage [*]', 'Ewe/*': 'Voltage [*]', 'I/*': 'Current [*]', 'Ns': 'Step', 'Q charge/*': 'Charge Capacity [*]', 'Q discharge/*': 'Discharge Capacity [*]', 'Temperature/*': 'Temperature [*]', 'time/*': 'Time [*]'}, datetime_format=None, header_row_index=0)

Bases: BaseCycler

A class to load and process Biologic battery cycler data.

Validators:

• _check_column_dict » column_dict

• _check_input_data_path » input_data_path

Parameters:

• input_data_path (str)

• column_dict (dict[str, str])

• datetime_format (str | None)

• header_row_index (int)

Return type:

None

field input_data_path: str [Required]

The path to the input data.

Validated by:

• _check_input_data_path

• import_and_validate_data

field column_dict: dict[str, str] = {'<I>/*': 'Current [*]', 'Date': 'Date', 'Ecell/*': 'Voltage [*]', 'Ewe/*': 'Voltage [*]', 'I/*': 'Current [*]', 'Ns': 'Step', 'Q charge/*': 'Charge Capacity [*]', 'Q discharge/*': 'Discharge Capacity [*]', 'Temperature/*': 'Temperature [*]', 'time/*': 'Time [*]'}

A dictionary mapping the column name format of the cycler to the PyProBE format. Units are indicated by an asterisk (*).

Validated by:

• _check_column_dict

• import_and_validate_data

static read_file(filepath, header_row_index=0)

Read a battery cycler file into a DataFrame.

Parameters:

• filepath (str) – The path to the file.

• header_row_index (int) – The index of the header row.

Returns:

The DataFrame.

Return type:

pl.DataFrame | pl.LazyFrame

pydantic model BiologicMB(*, input_data_path, column_dict={'<I>/*': 'Current [*]', 'Date': 'Date', 'Ecell/*': 'Voltage [*]', 'Ewe/*': 'Voltage [*]', 'I/*': 'Current [*]', 'Ns': 'Step', 'Q charge/*': 'Charge Capacity [*]', 'Q discharge/*': 'Discharge Capacity [*]', 'Temperature/*': 'Temperature [*]', 'time/*': 'Time [*]'}, datetime_format=None, header_row_index=0)

Bases: Biologic

A class to load and process Biologic Modulo Bat battery cycler data.

Validators:

Parameters:

• input_data_path (str)

• column_dict (dict[str, str])

• datetime_format (str | None)

• header_row_index (int)

Return type:

None

get_imported_dataframe(dataframe_list)

Read a battery cycler file into a DataFrame.

Parameters:

dataframe_list (List[DataFrame]) – The list of DataFrames to concatenate.

Returns:

The imported DataFrame.

Return type:

DataFrame | LazyFrame

static apply_step_correction(df)

Correct the step column.

This method adds the maximum step number from the previous MB file to the step number of the following MB file so they monotonically increase.

Parameters:

df (DataFrame | LazyFrame) – The DataFrame to correct.

Returns:

The corrected DataFrame.

Return type:

pl.DataFrame