Cyclic Polarization

Create cyclic polarization method parameters.

The method is equivalent to Cyclic Voltammetry.

Methods:

• to_dict –

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

• from_dict –

  Structure technique instance from dict.

• from_method_id –

  Create new instance of appropriate technique from method ID.

Attributes:

• material (Material) –

  Stores material settings for corrosion measurements.

• general (General) –

  Sets general/other settings.

• data_processing (DataProcessing) –

  Set the data processing settings.

• measurement_triggers (MeasurementTriggers) –

  Set the trigger at measurement settings.

• equilibrion_triggers (EquilibrationTriggers) –

  Set the trigger at equilibration settings.

• ir_drop_compensation (IrDropCompensation) –

  Set the iR drop compensation settings.

• current_limits (CurrentLimits) –

  Set the current limit settings.

• post_measurement (PostMeasurement) –

  Set the post measurement settings.

• bipot (BiPot) –

  Set the bipot settings.

• versus_ocp (VersusOCP) –

  Set the versus OCP settings.

• pretreatment (Pretreatment) –

  Set the pretreatment settings.

• current_range (CurrentRange) –

  Set the autoranging current.

• equilibration_time (float) –

  Equilibration time in s.

• begin_potential (float) –

  Potential where the scan starts and stops at in V.

• vertex1_potential (float) –

  First potential where direction reverses in V.

• vertex2_potential (float) –

  Second potential where direction reverses. V.

• step_potential (float) –

  Potential step size in V.

• scanrate (float) –

  Scan rate in V/s.

• n_scans (int) –

  Number of repetitions for this scan.

• 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.

• id (Literal['cp']) –

  Unique method identifier.

material: Material = Field(default_factory=Material)

general: General = Field(default_factory=General)

data_processing: DataProcessing = Field(default_factory=DataProcessing)

measurement_triggers: MeasurementTriggers = Field(default_factory=MeasurementTriggers)

equilibrion_triggers: EquilibrationTriggers = Field(default_factory=EquilibrationTriggers)

ir_drop_compensation: IrDropCompensation = Field(default_factory=IrDropCompensation)

current_limits: CurrentLimits = Field(default_factory=CurrentLimits)

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

bipot: BiPot = Field(default_factory=BiPot)

versus_ocp: VersusOCP = Field(default_factory=VersusOCP)

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

current_range: CurrentRange = Field(default_factory=CurrentRange)

equilibration_time: float = 0.0

begin_potential: float = -0.5

vertex1_potential: float = 0.5

vertex2_potential: float = -0.5

step_potential: float = 0.1

scanrate: float = 1.0

n_scans: int = 1

enable_bipot_current: bool = False

record_auxiliary_input: bool = False

record_cell_potential: bool = False

record_we_potential: bool = False

id: Literal['cp'] = 'cp'

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()

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()