Input Data Guidance

Supported cyclers and formats

PyProBE is able to import data from the following cyclers:

• Neware: 'neware'

  • .csv

  • .xlsx

• BioLogic: 'biologic' or for Modulo Bat files 'biologic_MB'

  • .mpt

  • .txt

• Arbin: 'arbin'

  • .csv

  • .xlsx

• Maccor: 'maccor'

  • .csv

• Basytec: 'basytec'

  • .txt

PyProBE data columns

Once converted into the standard PyProBE format, the data columns stored in RawData.base_dataframe are as follows:

• ‘Date’ (polars.datatypes.Datetime): the timestamp

  Date and time the measurement was taken

• ‘Time [s]’ (polars.datatypes.Float64): elapsed time

  From the start of the filtered data section

• ‘Step’ (polars.datatypes.Int64): the unique step number

  Corresponds to a single instruction in the cycling program. Step numbers repeat when instructions are cycled, i.e. the column might look like [1, 1, 1…, 2, 2, 2…, 1, 1, 1…, 2,2,2…, 3, 3, 3…] if steps 1 and 2 were cycled twice

• ‘Cycle’ (polars.datatypes.Int64): the cycle number

  Automatically identified when Step decreases

• ‘Event’ (polars.datatypes.Int64): the event number

  Automatically identified when Step changes

• ‘Current [A]’ (polars.datatypes.Float64): the current in Amperes

• ‘Voltage [V]’ (polars.datatypes.Float64): the voltage in Volts

• ‘Capacity [Ah]’ (polars.datatypes.Float64): the capacity passed

  Taken relative to the start of the filtered section in Ampere-hours. Its value increases when charge current is passed and decreases when discharge current is passed.

The table below summarises the data columns in the PyProBE format and the corresponding column names that are required in data from supported cyclers:

PyProBE	Required?	Neware	BioLogic	Arbin	Maccor	Basytec
Date	No	Date	Acquisition started on in header	Date Time	DPT Time	~Start of Test in header
Time [s]	Yes	Auto from Date	time/*	Test Time (*)	Test Time (sec)	~Time[*]
Step	Yes	Step Index	Ns	Step Index	Step	Line
Cycle	Yes	Auto from Step	Auto from Step	Auto from Step	Auto from Step	Auto from Step
Event	Yes	Auto from Step	Auto from Step	Auto from Step	Auto from Step	Auto from Step
Current [A]	Yes	Current(*)	I/*	Current (*)	Current	I[*]
Voltage [V]	Yes	Voltage(*)	Ecell/*	Voltage (*)	Voltage	U[*]
Capacity [Ah]	Yes	Chg. Cap.(*), DChg. Cap.(*)	Q charge/*, Q discharge/*	Charge Capacity (*), Discharge Capacity (*)	Capacity	Ah[*]
Temperature [C]	No	T1(*)	Temperature/*	Aux_Temperature_1 (*)	Temp 1	T1[*]

Where no units are provided (as is the case with Maccor), the PyProBE default units are assumed.

The columns marked with Auto from … are automatically generated by the PyProBE data import process. This process includes automatic unit conversion to the PyProBE base units using the Units class.