cellpy.parameters.legacy.update_headers

Module Contents

Classes

HeadersJournalV5	Subclass of BaseSetting including option to add postfixes.
HeadersJournalV7	Subclass of BaseSetting including option to add postfixes.
HeadersRawV4	Subclass of BaseSetting including option to add postfixes.
HeadersRawV5	Subclass of BaseSetting including option to add postfixes.
HeadersRawV6	Subclass of BaseSetting including option to add postfixes.
HeadersRawV7	Subclass of BaseSetting including option to add postfixes.
HeadersStepTableV7	Subclass of BaseSetting including option to add postfixes.
HeadersSummaryV5	Subclass of BaseSetting including option to add postfixes.
HeadersSummaryV6	Subclass of BaseSetting including option to add postfixes.
HeadersSummaryV7	Subclass of BaseSetting including option to add postfixes.

Functions

get_column_name_mapper(→ Tuple[Dict[str, str], ...)	Create a dictionary that maps old column names to new column names.
rename_columns(→ pandas.DataFrame)	Rename the column headers of a cells dataframe.
rename_fid_columns(→ pandas.DataFrame)
rename_raw_columns(→ pandas.DataFrame)
rename_step_columns(→ pandas.DataFrame)
rename_summary_columns(→ pandas.DataFrame)	Rename the summary headers to new format.

Attributes

HEADERS_KEYS_STEP_TABLE_EXTENDED
HEADERS_STEP_TABLE_EXTENSIONS
headers_journal_v0
journal_header_versions
raw_header_versions
steps_header_versions
summary_header_versions

class HeadersJournalV5

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

cell_type: str = 'cell_types'

cellpy_file_name: str = 'cellpy_file_names'

filename: str = 'filenames'

fixed: str = 'fixed'

group: str = 'groups'

label: str = 'labels'

loading: str = 'loadings'

mass: str = 'masses'

raw_file_names: str = 'raw_file_names'

sub_group: str = 'sub_groups'

total_mass: str = 'total_masses'

class HeadersJournalV7

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

argument: str = 'argument'

cell_type: str = 'cell_type'

cellpy_file_name: str = 'cellpy_file_name'

comment: str = 'comment'

experiment: str = 'experiment'

filename: str = 'filename'

fixed: str = 'fixed'

group: str = 'group'

instrument: str = 'instrument'

label: str = 'label'

loading: str = 'loading'

mass: str = 'mass'

nom_cap: str = 'nom_cap'

raw_file_names: str = 'raw_file_names'

sub_group: str = 'sub_group'

total_mass: str = 'total_mass'

class HeadersRawV4

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

ac_impedance_txt: str = 'AC_Impedance'

aci_phase_angle_txt: str = 'ACI_Phase_Angle'

amplitude_txt: str = 'Amplitude'

charge_capacity_txt: str = 'Charge_Capacity'

charge_energy_txt: str = 'Charge_Energy'

current_txt: str = 'Current'

cycle_index_txt: str = 'Cycle_Index'

data_point_txt: str = 'Data_Point'

datetime_txt: str = 'DateTime'

discharge_capacity_txt: str = 'Discharge_Capacity'

discharge_energy_txt: str = 'Discharge_Energy'

dv_dt_txt: str = 'dV/dt'

frequency_txt: str = 'Frequency'

internal_resistance_txt: str = 'Internal_Resistance'

is_fc_data_txt: str = 'Is_FC_Data'

ref_ac_impedance_txt: str = 'Reference_AC_Impedance'

ref_aci_phase_angle_txt: str = 'Reference_ACI_Phase_Angle'

ref_voltage_txt: str = 'Reference_Voltage'

step_index_txt: str = 'Step_Index'

step_time_txt: str = 'Step_Time'

sub_step_index_txt: str = 'Sub_Step_Index'

sub_step_time_txt: str = 'Sub_Step_Time'

test_id_txt: str = 'Test_ID'

test_time_txt: str = 'Test_Time'

voltage_txt: str = 'Voltage'

class HeadersRawV5

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

ac_impedance_txt: str = 'AC_Impedance'

aci_phase_angle_txt: str = 'ACI_Phase_Angle'

amplitude_txt: str = 'Amplitude'

charge_capacity_txt: str = 'Charge_Capacity'

charge_energy_txt: str = 'Charge_Energy'

current_txt: str = 'Current'

cycle_index_txt: str = 'Cycle_Index'

data_point_txt: str = 'Data_Point'

datetime_txt: str = 'DateTime'

discharge_capacity_txt: str = 'Discharge_Capacity'

discharge_energy_txt: str = 'Discharge_Energy'

dv_dt_txt: str = 'dV/dt'

frequency_txt: str = 'Frequency'

internal_resistance_txt: str = 'Internal_Resistance'

is_fc_data_txt: str = 'Is_FC_Data'

ref_ac_impedance_txt: str = 'Reference_AC_Impedance'

ref_aci_phase_angle_txt: str = 'Reference_ACI_Phase_Angle'

ref_voltage_txt: str = 'Reference_Voltage'

step_index_txt: str = 'Step_Index'

step_time_txt: str = 'Step_Time'

sub_step_index_txt: str = 'Sub_Step_Index'

sub_step_time_txt: str = 'Sub_Step_Time'

test_id_txt: str = 'Test_ID'

test_time_txt: str = 'Test_Time'

voltage_txt: str = 'Voltage'

class HeadersRawV6

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

ac_impedance_txt: str = 'AC_Impedance'

aci_phase_angle_txt: str = 'ACI_Phase_Angle'

amplitude_txt: str = 'Amplitude'

charge_capacity_txt: str = 'Charge_Capacity'

charge_energy_txt: str = 'Charge_Energy'

current_txt: str = 'Current'

cycle_index_txt: str = 'Cycle_Index'

data_point_txt: str = 'Data_Point'

datetime_txt: str = 'DateTime'

discharge_capacity_txt: str = 'Discharge_Capacity'

discharge_energy_txt: str = 'Discharge_Energy'

dv_dt_txt: str = 'dV/dt'

frequency_txt: str = 'Frequency'

internal_resistance_txt: str = 'Internal_Resistance'

is_fc_data_txt: str = 'Is_FC_Data'

ref_ac_impedance_txt: str = 'Reference_AC_Impedance'

ref_aci_phase_angle_txt: str = 'Reference_ACI_Phase_Angle'

ref_voltage_txt: str = 'Reference_Voltage'

step_index_txt: str = 'Step_Index'

step_time_txt: str = 'Step_Time'

sub_step_index_txt: str = 'Sub_Step_Index'

sub_step_time_txt: str = 'Sub_Step_Time'

test_id_txt: str = 'Test_ID'

test_time_txt: str = 'Test_Time'

voltage_txt: str = 'Voltage'

class HeadersRawV7

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

ac_impedance_txt: str = 'ac_impedance'

aci_phase_angle_txt: str = 'aci_phase_angle'

amplitude_txt: str = 'amplitude'

channel_id_txt: str = 'channel_id'

charge_capacity_txt: str = 'charge_capacity'

charge_energy_txt: str = 'charge_energy'

current_txt: str = 'current'

cycle_index_txt: str = 'cycle_index'

data_flag_txt: str = 'data_flag'

data_point_txt: str = 'data_point'

datetime_txt: str = 'date_time'

discharge_capacity_txt: str = 'discharge_capacity'

discharge_energy_txt: str = 'discharge_energy'

dv_dt_txt: str = 'dv_dt'

frequency_txt: str = 'frequency'

internal_resistance_txt: str = 'internal_resistance'

is_fc_data_txt: str = 'is_fc_data'

power_txt: str = 'power'

ref_ac_impedance_txt: str = 'ref_ac_impedance'

ref_aci_phase_angle_txt: str = 'ref_aci_phase_angle'

ref_voltage_txt: str = 'reference_voltage'

step_index_txt: str = 'step_index'

step_time_txt: str = 'step_time'

sub_step_index_txt: str = 'sub_step_index'

sub_step_time_txt: str = 'sub_step_time'

test_id_txt: str = 'test_id'

test_name_txt: str = 'test_name'

test_time_txt: str = 'test_time'

voltage_txt: str = 'voltage'

class HeadersStepTableV7

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

charge: str = 'charge'

current: str = 'current'

cycle: str = 'cycle'

discharge: str = 'discharge'

info: str = 'info'

internal_resistance: str = 'ir'

internal_resistance_change: str = 'ir_pct_change'

point: str = 'point'

rate_avr: str = 'rate_avr'

step: str = 'step'

step_time: str = 'step_time'

sub_step: str = 'sub_step'

sub_type: str = 'sub_type'

test: str = 'test'

test_time: str = 'test_time'

type: str = 'type'

ustep: str = 'ustep'

voltage: str = 'voltage'

class HeadersSummaryV5

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

areal_charge_capacity: str = 'areal_charge_capacity_u_mAh_cm2'

areal_discharge_capacity: str = 'areal_discharge_capacity_u_mAh_cm2'

charge_c_rate: str = 'Charge_C_rate'

charge_capacity: str = 'charge_capacity_u_mAh_g'

charge_capacity_loss: str = 'charge_capacity_loss_u_mAh_g'

charge_capacity_raw: str = 'Charge_Capacity'

coulombic_difference: str = 'coulombic_difference_u_mAh_g'

coulombic_efficiency: str = 'Coulombic_Efficiency(percentage)'

cumulated_charge_capacity: str = 'cumulated_charge_capacity_u_mAh_g'

cumulated_charge_capacity_loss: str = 'cumulated_charge_capacity_loss_u_mAh_g'

cumulated_coulombic_difference: str = 'cumulated_coulombic_difference_u_mAh_g'

cumulated_coulombic_efficiency: str = 'cumulated_coulombic_efficiency_u_percentage'

cumulated_discharge_capacity: str = 'cumulated_discharge_capacity_u_mAh_g'

cumulated_discharge_capacity_loss: str = 'cumulated_discharge_capacity_loss_u_mAh_g'

cumulated_ric: str = 'RIC(none)'

cumulated_ric_disconnect: str = 'RIC_Disconnect(none)'

cumulated_ric_sei: str = 'RIC_SEI(none)'

cycle_index: str = 'Cycle_Index'

data_point: str = 'Data_Point'

datetime: str = 'DateTime'

discharge_c_rate: str = 'Discharge_C_rate'

discharge_capacity: str = 'discharge_capacity_u_mAh_g'

discharge_capacity_loss: str = 'discharge_capacity_loss_u_mAh_g'

discharge_capacity_raw: str = 'Discharge_Capacity'

end_voltage_charge: str = 'End_Voltage_Charge(V)'

end_voltage_discharge: str = 'End_Voltage_Discharge(V)'

high_level: str = 'High_Level(percentage)'

ir_charge: str = 'IR_Charge(Ohms)'

ir_discharge: str = 'IR_Discharge(Ohms)'

low_level: str = 'Low_Level(percentage)'

normalized_charge_capacity: str = 'normalized_charge_capacity'

normalized_cycle_index: str = 'Normalized_Cycle_Index'

normalized_discharge_capacity: str = 'normalized_discharge_capacity'

ocv_first_max: str = 'OCV_First_Max(V)'

ocv_first_min: str = 'OCV_First_Min(V)'

ocv_second_max: str = 'OCV_Second_Max(V)'

ocv_second_min: str = 'OCV_Second_Min(V)'

shifted_charge_capacity: str = 'Charge_Endpoint_Slippage(mAh/g)'

shifted_discharge_capacity: str = 'Discharge_Endpoint_Slippage(mAh/g)'

temperature_last: str = 'Last_Temperature(C)'

temperature_mean: str = 'Average_Temperature(C)'

test_time: str = 'Test_Time'

class HeadersSummaryV6

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

areal_charge_capacity: str = 'areal_charge_capacity_u_mAh_cm2'

areal_discharge_capacity: str = 'areal_discharge_capacity_u_mAh_cm2'

channel_id: str = 'channel_id'

charge_c_rate: str = 'charge_c_rate'

charge_capacity: str = 'charge_capacity_u_mAh_g'

charge_capacity_loss: str = 'charge_capacity_loss_u_mAh_g'

charge_capacity_raw: str = 'charge_capacity'

coulombic_difference: str = 'coulombic_difference_u_mAh_g'

coulombic_efficiency: str = 'coulombic_efficiency_u_percentage'

cumulated_charge_capacity: str = 'cumulated_charge_capacity_u_mAh_g'

cumulated_charge_capacity_loss: str = 'cumulated_charge_capacity_loss_u_mAh_g'

cumulated_coulombic_difference: str = 'cumulated_coulombic_difference_u_mAh_g'

cumulated_coulombic_efficiency: str = 'cumulated_coulombic_efficiency_u_percentage'

cumulated_discharge_capacity: str = 'cumulated_discharge_capacity_u_mAh_g'

cumulated_discharge_capacity_loss: str = 'cumulated_discharge_capacity_loss_u_mAh_g'

cumulated_ric: str = 'cumulated_ric_u_none'

cumulated_ric_disconnect: str = 'cumulated_ric_disconnect_u_none'

cumulated_ric_sei: str = 'cumulated_ric_sei_u_none'

cycle_index: str = 'cycle_index'

data_flag: str = 'data_flag'

data_point: str = 'data_point'

datetime: str = 'date_time'

discharge_c_rate: str = 'discharge_c_rate'

discharge_capacity: str = 'discharge_capacity_u_mAh_g'

discharge_capacity_loss: str = 'discharge_capacity_loss_u_mAh_g'

discharge_capacity_raw: str = 'discharge_capacity'

end_voltage_charge: str = 'end_voltage_charge_u_V'

end_voltage_discharge: str = 'end_voltage_discharge_u_V'

high_level: str = 'high_level_u_percentage'

ir_charge: str = 'ir_charge_u_Ohms'

ir_discharge: str = 'ir_discharge_u_Ohms'

low_level: str = 'low_level_u_percentage'

normalized_charge_capacity: str = 'normalized_charge_capacity'

normalized_cycle_index: str = 'normalized_cycle_index'

normalized_discharge_capacity: str = 'normalized_discharge_capacity'

ocv_first_max: str = 'ocv_first_max_u_V'

ocv_first_min: str = 'ocv_first_min_u_V'

ocv_second_max: str = 'ocv_second_max_u_V'

ocv_second_min: str = 'ocv_second_min_u_V'

shifted_charge_capacity: str = 'shifted_charge_capacity_u_mAh_g'

shifted_discharge_capacity: str = 'shifted_discharge_capacity_u_mAh_g'

temperature_last: str = 'temperature_last_u_C'

temperature_mean: str = 'temperature_mean_u_C'

test_name: str = 'test_name'

test_time: str = 'test_time'

class HeadersSummaryV7

Bases: cellpy.parameters.internal_settings.BaseHeaders

Subclass of BaseSetting including option to add postfixes.

Example

>>> header["key_postfix"]  # returns "value_postfix"

areal_charge_capacity: str = 'charge_capacity_areal'

areal_discharge_capacity: str = 'discharge_capacity_areal'

channel_id: str = 'channel_id'

charge_c_rate: str = 'charge_c_rate'

charge_capacity: str = 'charge_capacity_gravimetric'

charge_capacity_loss: str = 'charge_capacity_loss_gravimetric'

charge_capacity_raw: str = 'charge_capacity'

coulombic_difference: str = 'coulombic_difference_gravimetric'

coulombic_efficiency: str = 'coulombic_efficiency'

cumulated_charge_capacity: str = 'cumulated_charge_capacity_gravimetric'

cumulated_charge_capacity_loss: str = 'cumulated_charge_capacity_loss_gravimetric'

cumulated_coulombic_difference: str = 'cumulated_coulombic_difference_gravimetric'

cumulated_coulombic_efficiency: str = 'cumulated_coulombic_efficiency'

cumulated_discharge_capacity: str = 'cumulated_discharge_capacity_gravimetric'

cumulated_discharge_capacity_loss: str = 'cumulated_discharge_capacity_loss_gravimetric'

cumulated_ric: str = 'cumulated_ric'

cumulated_ric_disconnect: str = 'cumulated_ric_disconnect'

cumulated_ric_sei: str = 'cumulated_ric_sei'

cycle_index: str = 'cycle_index'

data_flag: str = 'data_flag'

data_point: str = 'data_point'

datetime: str = 'date_time'

discharge_c_rate: str = 'discharge_c_rate'

discharge_capacity: str = 'discharge_capacity_gravimetric'

discharge_capacity_loss: str = 'discharge_capacity_loss_gravimetric'

discharge_capacity_raw: str = 'discharge_capacity'

end_voltage_charge: str = 'end_voltage_charge'

end_voltage_discharge: str = 'end_voltage_discharge'

high_level: str = 'high_level'

ir_charge: str = 'ir_charge'

ir_discharge: str = 'ir_discharge'

low_level: str = 'low_level'

normalized_charge_capacity: str = 'normalized_charge_capacity'

normalized_cycle_index: str = 'normalized_cycle_index'

normalized_discharge_capacity: str = 'normalized_discharge_capacity'

ocv_first_max: str = 'ocv_first_max'

ocv_first_min: str = 'ocv_first_min'

ocv_second_max: str = 'ocv_second_max'

ocv_second_min: str = 'ocv_second_min'

shifted_charge_capacity: str = 'shifted_charge_capacity_gravimetric'

shifted_discharge_capacity: str = 'shifted_discharge_capacity_gravimetric'

temperature_last: str = 'temperature_last'

temperature_mean: str = 'temperature_mean'

test_name: str = 'test_name'

test_time: str = 'test_time'

get_column_name_mapper(old_columns: cellpy.parameters.internal_settings.BaseHeaders, new_columns: cellpy.parameters.internal_settings.BaseHeaders) → Tuple[Dict[str, str], List[str], List[str]]

Create a dictionary that maps old column names to new column names.

Parameters:

• old_columns – The BaseHeaders for the old format.

• new_columns – The BaseHeaders for the new format.

Returns:

Translation dictionary, list of missing keys in new format, list of missing keys in old format.

rename_columns(df: pandas.DataFrame, old: cellpy.parameters.internal_settings.BaseHeaders, new: cellpy.parameters.internal_settings.BaseHeaders, remove_missing_in_new: bool = False, populate_missing_in_old: bool = True) → pandas.DataFrame

Rename the column headers of a cells dataframe.

Usage:

>>>  old_format_headers = HeadersSummaryV6()
>>>  new_format_headers = HeadersSummaryV7()
>>>  df_new_format = rename_columns(df_old_format, old_format_headers, new_format_headers)

Parameters:

• df – The dataframe.

• old – The BaseHeaders for the old format.

• new – The BaseHeaders for the new format.

• remove_missing_in_new – remove the columns that are not defined in the new format.

• populate_missing_in_old – add “new-format” missing columns (with np.NAN).

Returns:

Dataframe with updated columns

rename_fid_columns(fid_table: pandas.DataFrame, old_version: int, new_version: int = CELLPY_FILE_VERSION, **kwargs) → pandas.DataFrame

rename_raw_columns(raw: pandas.DataFrame, old_version: int, new_version: int = CELLPY_FILE_VERSION, **kwargs) → pandas.DataFrame

rename_step_columns(steps: pandas.DataFrame, old_version: int, new_version: int = CELLPY_FILE_VERSION, **kwargs) → pandas.DataFrame

rename_summary_columns(summary: pandas.DataFrame, old_version: int, new_version: int = CELLPY_FILE_VERSION, **kwargs) → pandas.DataFrame

Rename the summary headers to new format.

Parameters:

• summary – summary dataframe in old format.

• old_version – old format (cellpy_file_format (might use summary format number instead soon)).

• new_version – new format (cellpy_file_format (might use summary format number instead soon)).

• **kwargs – remove_missing_in_new (bool): remove the columns that are not defined in the new format. populate_missing_in_old (bool): add “new-format” missing columns (with np.NAN).

Returns:

summary (pandas.DataFrame) with column headers in the new format.

HEADERS_KEYS_STEP_TABLE_EXTENDED = ['point', 'test_time', 'step_time', 'current', 'voltage', 'charge', 'discharge', 'internal_resistance']

HEADERS_STEP_TABLE_EXTENSIONS = ['min', 'max', 'avr', 'first', 'last', 'delta', 'std']

headers_journal_v0

journal_header_versions

raw_header_versions

steps_header_versions

summary_header_versions