Skip to content

Saving/loading

This page contains a listing of all functions to load and save .pssession and .psmethod files.

pypalmsens

PyPalmSens: Take full control of your PalmSens instruments and automate electrochemistry experiments.

Provides an API to: 1. Discover, connect, and manage instruments 2. Configure and automate experiments 3. Read, write, and analyze measured data

Visit https://dev.palmsens.com/python/latest/ for online documentation.

Functions:

load_method_file 

load_method_file(path: str | Path) -> MethodType

Load a method file (.psmethod).

Parameters:

  • path

    (Path | str) –

    Path to method file

Returns:

  • method ( MethodType ) –

    Return method parameters

Source code in src/pypalmsens/_io.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def load_method_file(path: str | Path) -> MethodType:
    """Load a method file (.psmethod).

    Parameters
    ----------
    path : Path | str
        Path to method file

    Returns
    -------
    method : MethodType
        Return method parameters
    """
    method = _load_method_file(path)
    return method.to_settings()

load_session_file 

load_session_file(path: str | Path) -> list[Measurement]

Load a session file (.pssession).

Parameters:

  • path

    (Path | str) –

    Path to session file

Returns:

Source code in src/pypalmsens/_io.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def load_session_file(
    path: str | Path,
) -> list[Measurement]:
    """Load a session file (.pssession).

    Parameters
    ----------
    path : Path | str
        Path to session file

    Returns
    -------
    measurements : list[Measurement]
        Return list of measurements
    """
    path = Path(path)

    session = PalmSens.Data.SessionManager()

    with stream_reader(str(path)) as stream:
        session.Load(stream.BaseStream, str(path))

    session.MethodForEditor.MethodFilename = str(path.absolute())

    for psmeasurement in session:
        psmeasurement.Method.MethodFilename = str(path.absolute())

    return [Measurement(psmeasurement=m) for m in session]

save_method_file 

save_method_file(path: str | Path, method: MethodType)

Load a method file (.psmethod).

Parameters:

  • path

    (Path | str) –

    Path to save the method file

  • method

    (MethodType) –

    Method to save

Source code in src/pypalmsens/_io.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def save_method_file(path: str | Path, method: MethodType):
    """Load a method file (.psmethod).

    Parameters
    ----------
    path : Path | str
        Path to save the method file
    method : MethodType
        Method to save
    """
    data = method._serialize()

    with open(path, 'w') as f:
        _ = f.write(data)

save_session_file 

save_session_file(path: str | Path, measurements: list[Measurement])

Load a session file (.pssession).

Parameters:

  • path

    (Path | str) –

    Path to save the session file

  • measurements

    (list[Measurement]) –

    List of measurements to save

Source code in src/pypalmsens/_io.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def save_session_file(path: str | Path, measurements: list[Measurement]):
    """Load a session file (.pssession).

    Parameters
    ----------
    path : Path | str
        Path to save the session file
    measurements : list[Measurement]
        List of measurements to save
    """
    path = Path(path)

    if any((measurement is None) for measurement in measurements):
        raise ValueError('cannot save null measurement')

    session = PalmSens.Data.SessionManager()
    session.MethodForEditor = measurements[0]._psmeasurement.Method
    session.MethodForEditor.MethodFilename = str(path.absolute())

    for measurement in measurements:
        session.AddMeasurement(measurement._psmeasurement)

    with stream_writer(str(path), False, Encoding.Unicode) as stream:
        session.Save(stream.BaseStream, str(path))