txt

Parsers of text output files.

tseries

tseries(timefile: Path) -> DataFrame | None

Read temporal series text file.

Parameters:

Name	Type	Description	Default
`timefile`	`Path`	path of the time.dat file.	required

Returns:

Type	Description
`DataFrame \| None`	A `pandas.DataFrame` containing the time series, organized by variables in columns and time steps in rows.

rprof(
    rproffile: Path,
) -> tuple[dict[int, DataFrame], DataFrame | None]

Extract radial profiles data.

Parameters:

Name	Type	Description	Default
`rproffile`	`Path`	path of the rprof.dat file.	required

Returns:

Name	Type	Description
`profs`	`dict[int, DataFrame]`	a dict mapping istep to radial profiles.
`times`	`DataFrame \| None`	the time indexed by time steps.

refstate(
    reffile: Path, ncols: int = 8
) -> tuple[list[list[DataFrame]], list[DataFrame]] | None

Extract reference state profiles.

Parameters:

Name	Type	Description	Default
`reffile`	`Path`	path of the refstate file.	required
`ncols`	`int`	number of columns.	`8`

Returns:

Name	Type	Description
`syst`	`tuple[list[list[DataFrame]], list[DataFrame]] \| None`	list of list of `pandas.DataFrame` containing the reference state profiles for each system and each phase in these systems.
`adia`	`tuple[list[list[DataFrame]], list[DataFrame]] \| None`	list of `pandas.DataFrame` containing the adiabatic reference state profiles for each system, the last item being the combined adiabat.