The cyclicvoltammetry.read_input sub-module

The CyclicVoltammetry class

class echemsuite.cyclicvoltammetry.read_input.CyclicVoltammetry(path)

The CyclicVoltammetry class represent the digital equivalent of a cyclic-voltammetry experiment. The class stores all the informations about the experiment and is capable of loading Gamry .DTA files, Biologic .mpt files and CH Instruments ASCII files.

Parameters:

path (str) – The string encoding the path to the experiment file.

Raises:

ValueError – Exception raised if the specified file does not exists or if any kind of error happens during its parsing.

Examples

An instance of the class can be created calling the __init__ method with a path argument specifying the location of the cyclic-voltammetry (CV) data file:

>>> cv = CyclicVoltammetry("./file_to_load.DTA")

The number of cycles associated to the CV measurement can be obtained using the len command of the CyclicVoltammetry class or can be found in the settings dictionary under the key n_cycles. The current and voltage values associated to each cycle can be obtained, in pandas.DataFrame format, by using the built in __getitem__ method accoding to:

>>> current, voltage = cv[index]

The class provides also a built-in iterator yielding the sequence of current and voltage series for each cycle.

property filepath: str

The path from which the data have been loaded

Returns:

The string encoding the path to the original datafile.

Return type:

str