IO

liso.io.open_sim(path: str)

Open simulation data from a single file or a directory.

Parameters

path – file or directory path.

liso.io.open_run(path: str)

Open experimental data from a single file or a directory.

Parameters

path – File or directory path.

class liso.io.reader.SimDataCollection(files)

Bases: liso.io.reader._DataCollectionBase

A collection of simulated data.

info()

Override.

get_controls(*, sorted: bool = False)

Return control data in a Pandas.DataFrame.

Parameters

sorted – Sort the index, which is indeed the ID, of the returned dataframe. This is sometime needed because the simulation data are not stored with the simulation IDs monotonically increasing.

from_index(index: int)

Return pulse-train data from the nth pulse given index.

Parameters

index – pulse index.

channel(address: str, columns: Optional[Union[str, list]] = None)

Return an array for a particular data field.

Parameters

• address – Address of the channel.

• columns – Columns for the phasespace data. If None, all the columns are taken.

class liso.io.reader.ExpDataCollection(files)

Bases: liso.io.reader._DataCollectionBase

A collection of experimental data.

info()

Override.

get_controls(*, sorted: bool = False)

Return control data in a Pandas.DataFrame.

Parameters

sorted – Sort the index, which is indeed the ID, of the returned dataframe. This is sometime needed because the simulation data are not stored with the simulation IDs monotonically increasing.

from_index(index: int)

Return pulse-train data from the nth pulse given index.

Parameters

index – pulse index.

channel(address: str, columns: Optional[Union[str, list]] = None)

Return an array for a particular data field.

Parameters

• address – Address of the channel.

• columns – Columns for the phasespace data. If None, all the columns are taken.