Multi-step Amperometry

              flowchart TD
              pypalmsens.MultiStepAmperometry[MultiStepAmperometry]
              pypalmsens._methods.base.BaseTechnique[BaseTechnique]
              pypalmsens._methods.mixins.CurrentRangeMixin[CurrentRangeMixin]
              pypalmsens._methods.mixins.PretreatmentMixin[PretreatmentMixin]
              pypalmsens._methods.mixins.BiPotMixin[BiPotMixin]
              pypalmsens._methods.mixins.PostMeasurementMixin[PostMeasurementMixin]
              pypalmsens._methods.mixins.CurrentLimitsMixin[CurrentLimitsMixin]
              pypalmsens._methods.mixins.IrDropCompensationMixin[IrDropCompensationMixin]
              pypalmsens._methods.mixins.DataProcessingMixin[DataProcessingMixin]
              pypalmsens._methods.mixins.MultiplexerMixin[MultiplexerMixin]
              pypalmsens._methods.mixins.GeneralMixin[GeneralMixin]
              pypalmsens._methods.base_model.BaseModel[BaseModel]

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

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

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

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

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

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

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

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

                pypalmsens._methods.mixins.MultiplexerMixin --> pypalmsens.MultiStepAmperometry
                                pypalmsens._methods.base_model.BaseModel --> pypalmsens._methods.mixins.MultiplexerMixin
                

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



              click pypalmsens.MultiStepAmperometry href "" "pypalmsens.MultiStepAmperometry"
              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.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.DataProcessingMixin href "" "pypalmsens._methods.mixins.DataProcessingMixin"
              click pypalmsens._methods.mixins.MultiplexerMixin href "" "pypalmsens._methods.mixins.MultiplexerMixin"
              click pypalmsens._methods.mixins.GeneralMixin href "" "pypalmsens._methods.mixins.GeneralMixin"
              click pypalmsens._methods.base_model.BaseModel href "" "pypalmsens._methods.base_model.BaseModel"
            

Create multi-step amperometry method parameters.

With Multistep amperometry you can specify the number of potential steps to apply and how long each step should last. Each step works exactly as a Chronoamperometry step. The current is continuously sampled with the specified interval time. A whole cycle of steps can be repeated several times.

Levels can be specified using pypalmsens.settings.ELevel.

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:

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

• general (General) –

  Sets general/other settings.

• interval_time (float) –

  The time between two samples in s.

• ir_drop_compensation (IrDropCompensation) –

  Set the iR drop compensation settings.

• levels (list[ELevel]) –

  The cto apply within a cycle.

• multiplexer (Multiplexer) –

  Set the multiplexer settings.

• n_cycles (int) –

  Number of repetitions.

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

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

general: General = Field(default_factory=General)

interval_time: float = 0.1

ir_drop_compensation: IrDropCompensation = Field(default_factory=IrDropCompensation)

levels: list[ELevel] = Field(default_factory=lambda: [ELevel()])

multiplexer: Multiplexer = Field(default_factory=Multiplexer)

n_cycles: 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

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