cellpy¶

Create a CellpyCell object.

Parameters:

• filename (str, os.PathLike, OtherPath, or list of raw-file names, default: None ) –

  path to file(s) or data-set(s) to load.

• instrument (str, default: None ) –

  instrument to use (defaults to the one in your cellpy config file).

• instrument_file (str or path, default: None ) –

  yaml file for custom file type.

• cellpy_file (str, os.PathLike, or OtherPath, default: None ) –

  if both filename (a raw-file) and cellpy_file (a cellpy file) is provided, cellpy will try to check if the raw file has been updated since the creation of the cellpy-file and select this instead of the raw file if cellpy thinks they are similar (use with care!).

• logging_mode (str, default: None ) –

  "INFO" or "DEBUG".

• cycle_mode (str, default: None ) –

  the cycle mode (e.g. "anode" or "full_cell").

• mass (float or str, default: None ) –

  mass of active material in cellpy_units (default mg) (defaults to mass given in cellpy-file or 1.0). Pass a string with unit (e.g. "1.14 mg") to override cellpy_units.

• nominal_capacity (float or str, default: None ) –

  nominal capacity in cellpy_units (default mAh/g; used for finding C-rates). Pass a string with unit (e.g. "155 mAh/g") to override cellpy_units. The expected unit depends on nom_cap_specifics (gravimetric/areal/volumetric/absolute).

• nom_cap_specifics (str, default: None ) –

  either "gravimetric" (per mass), or "areal" (per area). ("volumetric" is not fully implemented yet - let us know if you need it).

• loading (float or str, default: None ) –

  loading in units [mass] / [area] (cellpy_units).

• area (float or str, default: None ) –

  active electrode area in cellpy_units (default cm2; e.g. used for finding the areal capacity). Pass a string with unit (e.g. "2.12 cm2") to override cellpy_units.

• estimate_area (bool, default: True ) –

  calculate area from loading if given (defaults to True).

• auto_pick_cellpy_format (bool, default: True ) –

  decide if it is a cellpy-file based on suffix. For .h5 / .hdf5, a set instrument= wins over suffix auto-pick (raw loader path). .cellpy / .cpy still auto-pick when enabled.

• auto_summary (bool, default: True ) –

  (re-) create summary.

• units (dict, default: None ) –

  update cellpy units (used after the file is loaded, e.g. when creating summary).

• step_kwargs (dict, default: None ) –

  sent to make_steps.

• summary_kwargs (dict, default: None ) –

  sent to make_summary.

• selector (dict, default: None ) –

  passed to load (when loading cellpy-files).

• testing (bool, default: False ) –

  set to True if testing (will for example prevent making .log files)

• refuse_copying (bool, default: False ) –

  set to True if you do not want to copy the raw-file before loading.

• initialize (bool, default: False ) –

  set to True if you want to initialize the CellpyCell object (probably only useful if you want to return a cellpy-file with no data in it).

• debug (bool, default: False ) –

  set to True if you want to debug the loader.

• **kwargs –

  sent to the loader.

Returns:

• –

  CellpyCell object (if successful, None if not).

Examples:

>>> # read an arbin .res file and create a cellpy object with
>>> # populated summary and step-table:
>>> c = cellpy.get("my_data.res", instrument="arbin_res", mass=1.14, area=2.12, loading=1.2, nominal_capacity=155.2)
>>>
>>> # load a cellpy-file:
>>> c = cellpy.get("my_cellpy_file.cellpy")
>>>
>>> # load a txt-file exported from Maccor:
>>> c = cellpy.get("my_data.txt", instrument="maccor_txt", model="one")
>>>
>>> # load a raw-file if it is newer than the corresponding cellpy-file,
>>> # if not, load the cellpy-file:
>>> c = cellpy.get("my_data.res", cellpy_file="my_data.cellpy")
>>>
>>> # load a file with a custom file-description:
>>> c = cellpy.get("my_file.csv", instrument_file="my_instrument.yaml")
>>>
>>> # load three subsequent raw-files (of one cell) and merge them:
>>> c = cellpy.get(["my_data_01.res", "my_data_02.res", "my_data_03.res"])
>>>
>>> # load a data set and get the summary charge and discharge capacities
>>> # in Ah/g:
>>> c = cellpy.get("my_data.res", units=dict(capacity="Ah"))
>>>
>>> # get an empty CellpyCell instance:
>>> c = cellpy.get()  # or c = cellpy.get(initialize=True) if you want to initialize it.

Merge several cells into a new CellpyCell without mutating any of them.

Convenience wrapper around merge: the first cell is deep-copied and the rest are folded in. See the method docstring for the "campaign" vs "continuation" semantics.

Parameters:

• cells –

  sequence of CellpyCell (or Data) instances; order matters.

• mode (str, default: 'campaign' ) –

  "campaign" (default) or "continuation".

• **kwargs –

  forwarded to merge.

Returns:

• CellpyCell –

  A new CellpyCell holding the merged object.

Prints out the available instrument loaders and their models.