yadg.extractors.eclab.common package

yadg.extractors.eclab.common.mpr_columns module

yadg.extractors.eclab.common.mpt_columns module

yadg.extractors.eclab.common.techniques module

eclabtechniques: Parameters for implemented techniques.

Implemented techniques:

  • CA - Chronoamperometry / Chronocoulometry

  • CP - Chronopotentiometry

  • CV - Cyclic Voltammetry

  • CVA - Cyclic Voltammetry Advanced

  • GCPL - Galvanostatic Cycling with Potential Limitation

  • GEIS - Galvano Electrochemical Impedance Spectroscopy

  • LOOP - Loop

  • LSV - Linear Sweep Voltammetry

  • MB - Modulo Bat

  • OCV - Open Circuit Voltage

  • PEIS - Potentio Electrochemical Impedance Spectroscopy

  • WAIT - Wait

  • ZIR - IR compensation (PEIS)

The module also implements resolution determination for parameters of techniques, in get_resolution().

yadg.extractors.eclab.common.techniques.param_from_key(param: str, key: int | str, to_str: bool = True) → str | float

Convert a supplied key of a certain parameter to its string or float value.

The function uses the map defined in param_map to convert between the entries in the tuples, which contain the str value of the parameter (present in .mpt files), the int value of the parameter (present in .mpr files), and the corresponding float value in SI units.

Parameters:

  • param – The name of the parameter, a key within the param_map. If param is not present in param_map, the supplied key is returned back.

  • key – The key of the parameter that is to be converted to a different representation.

  • to_str – A switch between str and float output.

Returns:

key – The key converted to the requested format.

Return type:

Union[str, float, int]

yadg.extractors.eclab.common.techniques.dev_VI(name: str, value: float, unit: str, Erange: float, Irange: float) → float

Function that returns the resolution of a voltage or current based on its name, value, E-range and I-range.

The values used here are hard-coded from VMP-3 potentiostats.

yadg.extractors.eclab.common.techniques.dev_derived(name: str, unit: str, val: float, rtol_I: float, rtol_V: float, rtol_VI: float) → float

Function that returns the resolution of a derived quantity based on its unit, value, and the relative error in the current and voltage.

The values used here are hard-coded from VMP-3 potentiostats.

yadg.extractors.eclab.common.techniques.get_devs(vals: dict[str, Any], units: dict[str, str], Erange: float, Irange: float, devs: dict[str, float] = None) → dict[str, float]