yadg.parsers.electrochem.eclabcommon package

Submodules

eclabtechniques: Parameters for implemented techniques.

Implemented techniques:

  • CA - Chronoamperometry / Chronocoulometry

  • CP - Chronopotentiometry

  • CV - Cyclic Voltammetry

  • 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.parsers.electrochem.eclabcommon.techniques.technique_params(technique, settings)

Constructs the parameter names for different techniques.

Parameters:

  • technique (str) – The full name of the technique.

  • settings (list[str]) – The list of settings from the start of an .mpt or .mps file.

Returns:

The short technique name and a full list of technique parameter names depending on what is present in the file.

Return type:

tuple[str, list]

yadg.parsers.electrochem.eclabcommon.techniques.param_from_key(param, key, to_str=True)

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 (str) – 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 (Union[int, str]) – The key of the parameter that is to be converted to a different representation.

  • to_str (bool) – A switch between str and float output.

Returns:

key – The key converted to the requested format.

Return type:

Union[str, float, int]

yadg.parsers.electrochem.eclabcommon.techniques.get_resolution(name, value, unit, Erange, Irange)

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

The values used here are hard-coded from VMP-3 potentiostats. Generally, the resolution is returned, however in some cases only the accuracy is specified (currently freq and Phase).

Return type:

float