MethodSCRIPT

Create a method script sandbox object.

The MethodSCRIPT Sandbox allows you to write your own MethodSCRIPT and run them on your instrument.

The MethodSCRIPT language allows for programming a human-readable script directly into the potentiostat. The simple script language makes it easy to combine different measurements and other tasks.

For more information see: https://www.palmsens.com/methodscript/

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.

• from_file –

  Load methodscript from file.

• to_file –

  Save script to file.

• from_url –

  Download script over http.

Attributes:

• id (Literal['ms']) –

  Unique method identifier.

• script (str) –

  Script to run.

• custom_units (dict[Literal['as', 'at', 'au'], CustomUnits]) –

  Define custom quantities and units for 'as', 'at', 'au' variable types.

id: Literal['ms'] = 'ms'

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

custom_units: dict[Literal['as', 'at', 'au'], CustomUnits] = Field(default_factory=dict)

to_dict() -> dict[str, Any]

45
46
47

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]) -> MethodType

49
50
51
52
53
54

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

    Opposite of `.to_dict()`"""
    return cls.model_validate(obj)  # type:ignore

from_method_id(id: str) -> MethodType

56
57
58
59
60

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

from_file(path: str | Path = 'methodscript.mscr') -> MethodScript

2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330

@classmethod
def from_file(cls, path: str | Path = 'methodscript.mscr') -> MethodScript:
    """Load methodscript from file.

    Parameters
    ----------
    path: str | Path
        Path to methodscript file.

    Returns
    -------
    method: MethodScript
    """
    with Path(path).open('r') as f:
        script = f.read()

    return cls(script=script)

to_file(path: str | Path = 'methodscript.mscr') -> None

2332
2333
2334
2335
2336
2337
2338
2339
2340
2341

def to_file(self, path: str | Path = 'methodscript.mscr') -> None:
    """Save script to file.

    Parameters
    ----------
    path: str | Path
        Path to methodscript file.
    """
    with Path(path).open('w') as f:
        _ = f.write(self.script)

from_url(url: str) -> MethodScript

2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359

@classmethod
def from_url(cls, url: str) -> MethodScript:
    """Download script over http.

    Parameters
    ----------
    url : url
        URL to download methodscript file from.

    Returns
    -------
    method: MethodScript
    """
    with urllib.request.urlopen(url) as response:
        script = response.read().decode()

    return cls(script=script)