Skip to content

Multi-step Amperometry

This page documents the Multi-step Amperometry (MSA) method.

pypalmsens.MultiStepAmperometry

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:

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

general class-attribute instance-attribute

general: General = Field(default_factory=General)

Sets general/other settings.

multiplexer class-attribute instance-attribute

multiplexer: Multiplexer = Field(default_factory=Multiplexer)

Set the multiplexer settings.

data_processing class-attribute instance-attribute

data_processing: DataProcessing = Field(default_factory=DataProcessing)

Set the data processing settings.

ir_drop_compensation class-attribute instance-attribute

ir_drop_compensation: IrDropCompensation = Field(default_factory=IrDropCompensation)

Set the iR drop compensation settings.

current_limits class-attribute instance-attribute

current_limits: CurrentLimits = Field(default_factory=CurrentLimits)

Set the current limit settings.

post_measurement class-attribute instance-attribute

post_measurement: PostMeasurement = Field(default_factory=PostMeasurement)

Set the post measurement settings.

bipot class-attribute instance-attribute

bipot: BiPot = Field(default_factory=BiPot)

Set the bipot settings.

pretreatment class-attribute instance-attribute

pretreatment: Pretreatment = Field(default_factory=Pretreatment)

Set the pretreatment settings.

current_range class-attribute instance-attribute

current_range: CurrentRange = Field(default_factory=CurrentRange)

Set the autoranging current.

id class-attribute instance-attribute

id: Literal['ma'] = 'ma'

Unique method identifier.

equilibration_time class-attribute instance-attribute

equilibration_time: float = 0.0

Equilibration time in s.

interval_time class-attribute instance-attribute

interval_time: float = 0.1

The time between two samples in s.

n_cycles class-attribute instance-attribute

n_cycles: int = 1

Number of repetitions.

levels class-attribute instance-attribute

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

The cto apply within a cycle.

Use ELevel() to create levels.

enable_bipot_current class-attribute instance-attribute

enable_bipot_current: bool = False

Enable bipot current.

record_auxiliary_input class-attribute instance-attribute

record_auxiliary_input: bool = False

Record auxiliary input.

record_cell_potential class-attribute instance-attribute

record_cell_potential: bool = False

Record cell potential.

Counter electrode vs ground.

record_we_potential class-attribute instance-attribute

record_we_potential: bool = False

Record applied working electrode potential.

Reference electrode vs ground.

to_dict

to_dict() -> dict[str, Any]

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

Source code in src/pypalmsens/_methods/base.py
30
31
32
def to_dict(self) -> dict[str, Any]:
    """Return the technique instance as a new key/value dictionary mapping."""
    return self.model_dump()

from_dict classmethod

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

Structure technique instance from dict.

Opposite of .to_dict()

Source code in src/pypalmsens/_methods/base.py
34
35
36
37
38
39
@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 classmethod

from_method_id(id: str) -> BaseTechnique

Create new instance of appropriate technique from method ID.

Source code in src/pypalmsens/_methods/base.py
41
42
43
44
45
@classmethod
def from_method_id(cls, id: str) -> BaseTechnique:
    """Create new instance of appropriate technique from method ID."""
    new = cls._registry[id]
    return new()