IO

liso.io.open_sim(path: Union[str, pathlib.Path]) → liso.io.reader.SimDataCollection

Open simulation data from a single file or a directory.

Parameters

path – file or directory path.

liso.io.open_run(path: Union[str, pathlib.Path]) → liso.io.reader.ExpDataCollection

Open experimental data from a single file or a directory.

Parameters

path – File or directory path.

class liso.io.reader.SimDataCollection(files: List[liso.io.file_access.SimFileAccess])

Bases: liso.io.reader.DataCollection

A collection of simulated data.

info() → None

Override.

get_controls(*, ordered: bool = False) → pandas.core.frame.DataFrame

Return control data in a Pandas.DataFrame.

Parameters

ordered – True for sorting 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) → liso.io.channel_data.ChannelData

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: List[liso.io.file_access.ExpFileAccess])

Bases: liso.io.reader.DataCollection

A collection of experimental data.

info() → None

Override.

get_controls(*, ordered: bool = False) → pandas.core.frame.DataFrame

Return control data in a Pandas.DataFrame.

Parameters

ordered – True for sorting 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) → liso.io.channel_data.ChannelData

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.