Methods

This page contains a listing of all available techniques in PyPalmSens.

For example to set up a CV experiment:

import pypalmsens

method = pypalmsens.CyclicVoltammetry(
    begin_potential = -1,
    vertex1_potential = -1,
    vertex2_potential = 1,
    step_potential = 0.25,
    scanrate = 5,
    n_scans = 2,
    current_range = pypalmsens.settings.CurrentRange(
        max = pypalmsens.settings.CURRENT_RANGE.cr_1_mA,
        min = pypalmsens.settings.CURRENT_RANGE.cr_100_nA,
        start = pypalmsens.settings.CURRENT_RANGE.cr_100_uA,
    ),
)

Shared settings

Many configuration settings are shared between methods, like the current ranges above or versus OCP or trigger settings. These are listed in Method settings.

`pypalmsens`

Classes:

ChronoAmperometry – Create chrono amperometry method parameters.
ChronoPotentiometry – Create potentiometry method parameters.
CyclicVoltammetry – Create cyclic voltammetry method parameters.
DifferentialPulseVoltammetry – Create square wave method parameters.
ElectrochemicalImpedanceSpectroscopy – Create potentiometry method parameters.
GalvanostaticImpedanceSpectroscopy – Create potentiometry method parameters.
LinearSweepVoltammetry – Create linear sweep method parameters.
MethodScript – Create a method script sandbox object.
MultiStepAmperometry – Create multi-step amperometry method parameters.
OpenCircuitPotentiometry – Create open circuit potentiometry method parameters.
SquareWaveVoltammetry – Create square wave method parameters.

`ChronoAmperometry`

Create chrono amperometry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
pretreatment (Pretreatment) – Set the pretreatment settings.
versus_ocp (VersusOCP) – Set the versus OCP settings.
bipot (BiPot) – Set the bipot settings
post_measurement (PostMeasurement) – Set the post measurement settings.
current_limits (CurrentLimits) – Set the current limit settings.
charge_limits (ChargeLimits) – Set the charge limit settings
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
equilibration_time (float) – Equilibration time in s.
interval_time (float) – Interval time in s.
potential (float) – Potential in V.
run_time (float) – Run time in s.
enable_bipot_current (bool) – Enable bipot current.
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_potential (bool) – Record applied working electrode potential.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`versus_ocp`

versus_ocp: VersusOCP = attrs.field(factory=VersusOCP)

Set the versus OCP settings.

`bipot`

bipot: BiPot = attrs.field(factory=BiPot)

Set the bipot settings

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`current_limits`

current_limits: CurrentLimits = attrs.field(factory=CurrentLimits)

Set the current limit settings.

`charge_limits`

charge_limits: ChargeLimits = attrs.field(factory=ChargeLimits)

Set the charge limit settings

`ir_drop_compensation`

ir_drop_compensation: IrDropCompensation = attrs.field(factory=IrDropCompensation)

Set the iR drop compensation settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s.

`interval_time`

interval_time: float = 0.1

Interval time in s.

`potential`

potential: float = 0.0

Potential in V.

`run_time`

run_time: float = 1.0

Run time in s.

`enable_bipot_current`

enable_bipot_current: bool = False

Enable bipot current.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_potential`

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

`ChronoPotentiometry`

Create potentiometry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
potential_range (PotentialRange) – Set the autoranging potential.
pretreatment (Pretreatment) – Set the pretreatment settings.
post_measurement (PostMeasurement) – Set the post measurement settings.
potential_limits (PotentialLimits) – Set the potential limit settings
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
current (float) – The current to apply in the given current range.
applied_current_range (CURRENT_RANGE) – Applied current range.
interval_time (float) – Interval time in s (default: 0.1)
run_time (float) – Run time in s (default: 1.0)
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_current (bool) – Record working electrode current.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`potential_range`

potential_range: PotentialRange = attrs.field(factory=PotentialRange, converter=potential_converter)

Set the autoranging potential.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`potential_limits`

potential_limits: PotentialLimits = attrs.field(factory=PotentialLimits)

Set the potential limit settings

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`current`

current: float = 0.0

The current to apply in the given current range.

Note that this value acts as a multiplier in the applied current range.

So if 10 uA is the applied current range and 1.5 is given as current value, the applied current will be 15 uA.

`applied_current_range`

applied_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_100_uA

Applied current range.

Use CURRENT_RANGE to define the range.

`interval_time`

interval_time: float = 0.1

Interval time in s (default: 0.1)

`run_time`

run_time: float = 1.0

Run time in s (default: 1.0)

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_current`

record_we_current: bool = False

Record working electrode current.

`CyclicVoltammetry`

Create cyclic voltammetry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
pretreatment (Pretreatment) – Set the pretreatment settings.
versus_ocp (VersusOCP) – Set the versus OCP settings.
post_measurement (PostMeasurement) – Set the post measurement settings.
current_limits (CurrentLimits) – Set the current limit settings.
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
equilibration_time (float) – Equilibration time in s
begin_potential (float) – Begin potential in V
vertex1_potential (float) – Vertex 1 potential in V
vertex2_potential (float) – Vertex 2 potential in V
step_potential (float) – Step potential in V
scanrate (float) – Scan rate in V/s
n_scans (float) – Number of scans
enable_bipot_current (bool) – Enable bipot current.
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_potential (bool) – Record applied working electrode potential.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`versus_ocp`

versus_ocp: VersusOCP = attrs.field(factory=VersusOCP)

Set the versus OCP settings.

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`current_limits`

current_limits: CurrentLimits = attrs.field(factory=CurrentLimits)

Set the current limit settings.

`ir_drop_compensation`

ir_drop_compensation: IrDropCompensation = attrs.field(factory=IrDropCompensation)

Set the iR drop compensation settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s

`begin_potential`

begin_potential: float = -0.5

Begin potential in V

`vertex1_potential`

vertex1_potential: float = 0.5

Vertex 1 potential in V

`vertex2_potential`

vertex2_potential: float = -0.5

Vertex 2 potential in V

`step_potential`

step_potential: float = 0.1

Step potential in V

`scanrate`

scanrate: float = 1.0

Scan rate in V/s

`n_scans`

n_scans: float = 1

Number of scans

`enable_bipot_current`

enable_bipot_current: bool = False

Enable bipot current.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_potential`

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

`DifferentialPulseVoltammetry`

Create square wave method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
pretreatment (Pretreatment) – Set the pretreatment settings.
versus_ocp (VersusOCP) – Set the versus OCP settings.
bipot (BiPot) – Set the bipot settings
post_measurement (PostMeasurement) – Set the post measurement settings.
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
equilibration_time (float) – Equilibration time in s.
begin_potential (float) – Begin potential in V.
end_potential (float) – End potential in V.
step_potential (float) – Step potential in V.
pulse_potential (float) – Pulse potential in V.
pulse_time (float) – Pulse time in s.
scan_rate (float) – Scan rate (potential/time) in V/s.
enable_bipot_current (bool) – Enable bipot current.
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_potential (bool) – Record applied working electrode potential.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`versus_ocp`

versus_ocp: VersusOCP = attrs.field(factory=VersusOCP)

Set the versus OCP settings.

`bipot`

bipot: BiPot = attrs.field(factory=BiPot)

Set the bipot settings

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`ir_drop_compensation`

ir_drop_compensation: IrDropCompensation = attrs.field(factory=IrDropCompensation)

Set the iR drop compensation settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s.

`begin_potential`

begin_potential: float = -0.5

Begin potential in V.

`end_potential`

end_potential: float = 0.5

End potential in V.

`step_potential`

step_potential: float = 0.1

Step potential in V.

`pulse_potential`

pulse_potential: float = 0.05

Pulse potential in V.

`pulse_time`

pulse_time: float = 0.01

Pulse time in s.

`scan_rate`

scan_rate: float = 1.0

Scan rate (potential/time) in V/s.

`enable_bipot_current`

enable_bipot_current: bool = False

Enable bipot current.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_potential`

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

`ElectrochemicalImpedanceSpectroscopy`

Create potentiometry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
potential_range (PotentialRange) – Set the autoranging potential.
pretreatment (Pretreatment) – Set the pretreatment settings.
versus_ocp (VersusOCP) – Set the versus OCP settings.
post_measurement (PostMeasurement) – Set the post measurement settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
general (General) – Sets general/other settings.
equilibration_time (float) – Equilibration time in s.
dc_potential (float) – DC potential in V.
ac_potential (float) – AC potential in V RMS.
n_frequencies (int) – Number of frequencies.
max_frequency (float) – Maximum frequency in Hz.
min_frequency (float) – Minimum frequency in Hz.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`potential_range`

potential_range: PotentialRange = attrs.field(factory=PotentialRange, converter=potential_converter)

Set the autoranging potential.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`versus_ocp`

versus_ocp: VersusOCP = attrs.field(factory=VersusOCP)

Set the versus OCP settings.

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s.

`dc_potential`

dc_potential: float = 0.0

DC potential in V.

`ac_potential`

ac_potential: float = 0.01

AC potential in V RMS.

`n_frequencies`

n_frequencies: int = 11

Number of frequencies.

`max_frequency`

max_frequency: float = 100000.0

Maximum frequency in Hz.

`min_frequency`

min_frequency: float = 1000.0

Minimum frequency in Hz.

`GalvanostaticImpedanceSpectroscopy`

Create potentiometry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
potential_range (PotentialRange) – Set the autoranging potential.
pretreatment (Pretreatment) – Set the pretreatment settings.
post_measurement (PostMeasurement) – Set the post measurement settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
general (General) – Sets general/other settings.
applied_current_range (CURRENT_RANGE) – Applied current range.
equilibration_time (float) – Equilibration time in s.
ac_current (float) – AC current in applied current range RMS.
dc_current (float) – DC current in applied current range.
n_frequencies (int) – Number of frequencies.
max_frequency (float) – Maximum frequency in Hz.
min_frequency (float) – Minimum frequency in Hz.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`potential_range`

potential_range: PotentialRange = attrs.field(factory=PotentialRange, converter=potential_converter)

Set the autoranging potential.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`applied_current_range`

applied_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_100_uA

Applied current range.

Use CURRENT_RANGE to define the range.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s.

`ac_current`

ac_current: float = 0.01

AC current in applied current range RMS.

`dc_current`

dc_current: float = 0.0

DC current in applied current range.

`n_frequencies`

n_frequencies: int = 11

Number of frequencies.

`max_frequency`

max_frequency: float = 100000.0

Maximum frequency in Hz.

`min_frequency`

min_frequency: float = 1000.0

Minimum frequency in Hz.

`LinearSweepVoltammetry`

Create linear sweep method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
pretreatment (Pretreatment) – Set the pretreatment settings.
versus_ocp (VersusOCP) – Set the versus OCP settings.
bipot (BiPot) – Set the bipot settings
post_measurement (PostMeasurement) – Set the post measurement settings.
current_limits (CurrentLimits) – Set the current limit settings.
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
begin_potential (float) – Begin potential in V.
end_potential (float) – End potential in V.
step_potential (float) – Step potential in V.
scanrate (float) – Scan rate in V/s.
enable_bipot_current (bool) – Enable bipot current.
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_potential (bool) – Record applied working electrode potential.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`versus_ocp`

versus_ocp: VersusOCP = attrs.field(factory=VersusOCP)

Set the versus OCP settings.

`bipot`

bipot: BiPot = attrs.field(factory=BiPot)

Set the bipot settings

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`current_limits`

current_limits: CurrentLimits = attrs.field(factory=CurrentLimits)

Set the current limit settings.

`ir_drop_compensation`

ir_drop_compensation: IrDropCompensation = attrs.field(factory=IrDropCompensation)

Set the iR drop compensation settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`begin_potential`

begin_potential: float = -0.5

Begin potential in V.

`end_potential`

end_potential: float = 0.5

End potential in V.

`step_potential`

step_potential: float = 0.1

Step potential in V.

`scanrate`

scanrate: float = 1.0

Scan rate in V/s.

`enable_bipot_current`

enable_bipot_current: bool = False

Enable bipot current.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_potential`

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

`MethodScript`

Create a method script sandbox object.

Attributes:

script (str) – Script to run.

`script`

script: str = 'e\nwait 100m\nif 1 < 2\n    send_string "Hello world"\nendif\n\n'

Script to run.

For more info on MethodSCRIPT, see: https://www.palmsens.com/methodscript/ for more information.

`MultiStepAmperometry`

Create multi-step amperometry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
pretreatment (Pretreatment) – Set the pretreatment settings.
bipot (BiPot) – Set the bipot settings
post_measurement (PostMeasurement) – Set the post measurement settings.
current_limits (CurrentLimits) – Set the current limit settings.
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
equilibration_time (float) – Equilibration time in s.
interval_time (float) – Interval time in s.
n_cycles (float) – Number of cycles.
levels (link:#list[link:#pypalmsens._methods._shared.ELevel]) – List of levels.
enable_bipot_current (bool) – Enable bipot current.
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_potential (bool) – Record applied working electrode potential.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`bipot`

bipot: BiPot = attrs.field(factory=BiPot)

Set the bipot settings

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`current_limits`

current_limits: CurrentLimits = attrs.field(factory=CurrentLimits)

Set the current limit settings.

`ir_drop_compensation`

ir_drop_compensation: IrDropCompensation = attrs.field(factory=IrDropCompensation)

Set the iR drop compensation settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s.

`interval_time`

interval_time: float = 0.1

Interval time in s.

`n_cycles`

n_cycles: float = 1

Number of cycles.

`levels`

levels: list[ELevel] = attrs.field(factory=(lambda: [ELevel()]))

List of levels.

Use ELevel() to create levels.

`enable_bipot_current`

enable_bipot_current: bool = False

Enable bipot current.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_potential`

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

`OpenCircuitPotentiometry`

Create open circuit potentiometry method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
potential_range (PotentialRange) – Set the autoranging potential.
pretreatment (Pretreatment) – Set the pretreatment settings.
post_measurement (PostMeasurement) – Set the post measurement settings.
potential_limits (PotentialLimits) – Set the potential limit settings
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
interval_time (float) – Interval time in s.
run_time (float) – Run time in s.
record_auxiliary_input (bool) – Record auxiliary input.
record_we_current (bool) – Record working electrode current.
record_we_current_range (CURRENT_RANGE) – Record working electrode current range.

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`potential_range`

potential_range: PotentialRange = attrs.field(factory=PotentialRange, converter=potential_converter)

Set the autoranging potential.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`potential_limits`

potential_limits: PotentialLimits = attrs.field(factory=PotentialLimits)

Set the potential limit settings

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`interval_time`

interval_time: float = 0.1

Interval time in s.

`run_time`

run_time: float = 1.0

Run time in s.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_we_current`

record_we_current: bool = False

Record working electrode current.

`record_we_current_range`

record_we_current_range: CURRENT_RANGE = CURRENT_RANGE.cr_1_uA

Record working electrode current range.

Use CURRENT_RANGE to define the range.

`SquareWaveVoltammetry`

Create square wave method parameters.

Attributes:

current_range (CurrentRange) – Set the autoranging current.
pretreatment (Pretreatment) – Set the pretreatment settings.
versus_ocp (VersusOCP) – Set the versus OCP settings.
bipot (BiPot) – Set the bipot settings
post_measurement (PostMeasurement) – Set the post measurement settings.
ir_drop_compensation (IrDropCompensation) – Set the iR drop compensation settings.
equilibrion_triggers (EquilibrationTriggers) – Set the trigger at equilibration settings.
measurement_triggers (MeasurementTriggers) – Set the trigger at measurement settings.
multiplexer (Multiplexer) – Set the multiplexer settings
data_processing (DataProcessing) – Set the data processing settings.
general (General) – Sets general/other settings.
equilibration_time (float) – Equilibration time in s.
begin_potential (float) – Begin potential in V.
end_potential (float) – End potential in V.
step_potential (float) – Step potential in V.
frequency (float) – Frequency in Hz.
amplitude (float) – Amplitude in V as half peak-to-peak value.
enable_bipot_current (bool) – Enable bipot current.
record_auxiliary_input (bool) – Record auxiliary input.
record_cell_potential (bool) – Record cell potential.
record_we_potential (bool) – Record applied working electrode potential.
record_forward_and_reverse_currents (bool) – Record forward and reverse currents

`current_range`

current_range: CurrentRange = attrs.field(factory=CurrentRange, converter=current_converter)

Set the autoranging current.

`pretreatment`

pretreatment: Pretreatment = attrs.field(factory=Pretreatment)

Set the pretreatment settings.

`versus_ocp`

versus_ocp: VersusOCP = attrs.field(factory=VersusOCP)

Set the versus OCP settings.

`bipot`

bipot: BiPot = attrs.field(factory=BiPot)

Set the bipot settings

`post_measurement`

post_measurement: PostMeasurement = attrs.field(factory=PostMeasurement)

Set the post measurement settings.

`ir_drop_compensation`

ir_drop_compensation: IrDropCompensation = attrs.field(factory=IrDropCompensation)

Set the iR drop compensation settings.

`equilibrion_triggers`

equilibrion_triggers: EquilibrationTriggers = attrs.field(factory=EquilibrationTriggers)

Set the trigger at equilibration settings.

`measurement_triggers`

measurement_triggers: MeasurementTriggers = attrs.field(factory=MeasurementTriggers)

Set the trigger at measurement settings.

`multiplexer`

multiplexer: Multiplexer = attrs.field(factory=Multiplexer)

Set the multiplexer settings

`data_processing`

data_processing: DataProcessing = attrs.field(factory=DataProcessing)

Set the data processing settings.

`general`

general: General = attrs.field(factory=General)

Sets general/other settings.

`equilibration_time`

equilibration_time: float = 0.0

Equilibration time in s.

`begin_potential`

begin_potential: float = -0.5

Begin potential in V.

`end_potential`

end_potential: float = 0.5

End potential in V.

`step_potential`

step_potential: float = 0.1

Step potential in V.

`frequency`

frequency: float = 10.0

Frequency in Hz.

`amplitude`

amplitude: float = 0.05

Amplitude in V as half peak-to-peak value.

`enable_bipot_current`

enable_bipot_current: bool = False

Enable bipot current.

`record_auxiliary_input`

record_auxiliary_input: bool = False

Record auxiliary input.

`record_cell_potential`

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

`record_we_potential`

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

`record_forward_and_reverse_currents`

record_forward_and_reverse_currents: bool = False

Record forward and reverse currents