Cyclic Voltammetry

              flowchart TD
              pypalmsens.CyclicVoltammetry[CyclicVoltammetry]
              pypalmsens._methods.base.BaseTechnique[BaseTechnique]
              pypalmsens._methods.mixins.CurrentRangeMixin[CurrentRangeMixin]
              pypalmsens._methods.mixins.PretreatmentMixin[PretreatmentMixin]
              pypalmsens._methods.mixins.VersusOCPMixin[VersusOCPMixin]
              pypalmsens._methods.mixins.BiPotMixin[BiPotMixin]
              pypalmsens._methods.mixins.PostMeasurementMixin[PostMeasurementMixin]
              pypalmsens._methods.mixins.CurrentLimitsMixin[CurrentLimitsMixin]
              pypalmsens._methods.mixins.IrDropCompensationMixin[IrDropCompensationMixin]
              pypalmsens._methods.mixins.EquilibrationTriggersMixin[EquilibrationTriggersMixin]
              pypalmsens._methods.mixins.MeasurementTriggersMixin[MeasurementTriggersMixin]
              pypalmsens._methods.mixins.DataProcessingMixin[DataProcessingMixin]
              pypalmsens._methods.mixins.GeneralMixin[GeneralMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

                              pypalmsens._methods.base.BaseTechnique --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.base.BaseTechnique
                

                pypalmsens._methods.mixins.CurrentRangeMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.CurrentRangeMixin
                

                pypalmsens._methods.mixins.PretreatmentMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PretreatmentMixin
                

                pypalmsens._methods.mixins.VersusOCPMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.VersusOCPMixin
                

                pypalmsens._methods.mixins.BiPotMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.BiPotMixin
                

                pypalmsens._methods.mixins.PostMeasurementMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.PostMeasurementMixin
                

                pypalmsens._methods.mixins.CurrentLimitsMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.CurrentLimitsMixin
                

                pypalmsens._methods.mixins.IrDropCompensationMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.IrDropCompensationMixin
                

                pypalmsens._methods.mixins.EquilibrationTriggersMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.EquilibrationTriggersMixin
                

                pypalmsens._methods.mixins.MeasurementTriggersMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MeasurementTriggersMixin
                

                pypalmsens._methods.mixins.DataProcessingMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.DataProcessingMixin
                

                pypalmsens._methods.mixins.GeneralMixin --> pypalmsens.CyclicVoltammetry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.GeneralMixin
                



              click pypalmsens.CyclicVoltammetry href "" "pypalmsens.CyclicVoltammetry"
              click pypalmsens._methods.base.BaseTechnique href "" "pypalmsens._methods.base.BaseTechnique"
              click pypalmsens._methods.mixins.CurrentRangeMixin href "" "pypalmsens._methods.mixins.CurrentRangeMixin"
              click pypalmsens._methods.mixins.PretreatmentMixin href "" "pypalmsens._methods.mixins.PretreatmentMixin"
              click pypalmsens._methods.mixins.VersusOCPMixin href "" "pypalmsens._methods.mixins.VersusOCPMixin"
              click pypalmsens._methods.mixins.BiPotMixin href "" "pypalmsens._methods.mixins.BiPotMixin"
              click pypalmsens._methods.mixins.PostMeasurementMixin href "" "pypalmsens._methods.mixins.PostMeasurementMixin"
              click pypalmsens._methods.mixins.CurrentLimitsMixin href "" "pypalmsens._methods.mixins.CurrentLimitsMixin"
              click pypalmsens._methods.mixins.IrDropCompensationMixin href "" "pypalmsens._methods.mixins.IrDropCompensationMixin"
              click pypalmsens._methods.mixins.EquilibrationTriggersMixin href "" "pypalmsens._methods.mixins.EquilibrationTriggersMixin"
              click pypalmsens._methods.mixins.MeasurementTriggersMixin href "" "pypalmsens._methods.mixins.MeasurementTriggersMixin"
              click pypalmsens._methods.mixins.DataProcessingMixin href "" "pypalmsens._methods.mixins.DataProcessingMixin"
              click pypalmsens._methods.mixins.GeneralMixin href "" "pypalmsens._methods.mixins.GeneralMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Create cyclic voltammetry method parameters.

In Cyclic Voltammetry, recurrent potential scans are performed between the potentials vertex1_potential and vertex2_potential going back the number of times determined by the n_scans. The scan starts at the begin_potential which can be at one of these vertex potentials or anywhere in between. The experiment will always terminate at the same potential set as the 'begin_potential'.

Methods:

• from_dict –

  Structure technique instance from dict.

• from_method_id –

  Create new instance of appropriate technique from method ID.

• to_dict –

  Return the technique instance as a new key/value dictionary mapping.

Attributes:

• begin_potential (float) –

  Potential where the scan starts and stops at in V.

• bipot (BiPot) –

  Set the bipot settings.

• current_limits (CurrentLimits) –

  Set the current limit settings.

• current_range (CurrentRange) –

  Set the autoranging current.

• data_processing (DataProcessing) –

  Set the data processing settings.

• enable_bipot_current (bool) –

  Enable bipot current.

• equilibration_time (float) –

  Equilibration time in s.

• equilibrion_triggers (EquilibrationTriggers) –

  Set the trigger at equilibration settings.

• general (General) –

  Sets general/other settings.

• ir_drop_compensation (IrDropCompensation) –

  Set the iR drop compensation settings.

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• n_scans (int) –

  Number of repetitions for this scan.

• post_measurement (PostMeasurement) –

  Set the post measurement settings.

• pretreatment (Pretreatment) –

  Set the pretreatment settings.

• record_auxiliary_input (bool) –

  Record auxiliary input.

• record_cell_potential (bool) –

  Record cell potential.

• record_we_potential (bool) –

  Record applied working electrode potential.

• scanrate (float) –

  Scan rate in V/s.

• step_potential (float) –

  Potential step size in V.

• versus_ocp (VersusOCP) –

  Set the versus OCP settings.

• vertex1_potential (float) –

  First potential where direction reverses in V.

• vertex2_potential (float) –

  Second potential where direction reverses. V.

begin_potential: float = -0.5

bipot: BiPot = Field(default_factory=BiPot)

current_limits: CurrentLimits = Field(default_factory=CurrentLimits)

current_range: CurrentRange = Field(default_factory=CurrentRange)

data_processing: DataProcessing = Field(default_factory=DataProcessing)

enable_bipot_current: bool = False

equilibration_time: float = 0.0

equilibrion_triggers: EquilibrationTriggers = Field(default_factory=EquilibrationTriggers)

general: General = Field(default_factory=General)

ir_drop_compensation: IrDropCompensation = Field(default_factory=IrDropCompensation)

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

n_scans: int = 1

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

record_auxiliary_input: bool = False

record_cell_potential: bool = False

record_we_potential: bool = False

scanrate: float = 1.0

step_potential: float = 0.1

versus_ocp: VersusOCP = Field(default_factory=VersusOCP)

vertex1_potential: float = 0.5

vertex2_potential: float = -0.5

from_dict(obj: dict[str, Any]) -> BaseTechnique

35
36
37
38
39
40

@classmethod
def from_dict(cls, obj: dict[str, Any]) -> BaseTechnique:
    """Structure technique instance from dict.

    Opposite of `.to_dict()`"""
    return cls.model_validate(obj)

from_method_id(id: str) -> BaseTechnique

42
43
44
45
46

@classmethod
def from_method_id(cls, id: str) -> BaseTechnique:
    """Create new instance of appropriate technique from method ID."""
    new = cls._registry[id]
    return new()

to_dict() -> dict[str, Any]

31
32
33

def to_dict(self) -> dict[str, Any]:
    """Return the technique instance as a new key/value dictionary mapping."""
    return self.model_dump()