time_series

Plots time series.

plot_time_series

plot_time_series(
    sdat: StagyyData,
    names: Sequence[Sequence[Sequence[str]]],
    conf: Optional[Config] = None,
) -> None

Plot requested time series.

Parameters:

Name	Type	Description	Default
sdat	StagyyData	a StagyyData instance.	required
names	Sequence[Sequence[Sequence[str]]]	time series names organized by figures, plots and subplots.	required
conf	Optional[Config]	configuration.	None

compstat

compstat(
    sdat: StagyyData,
    *names: str,
    tstart: Optional[float] = None,
    tend: Optional[float] = None
) -> DataFrame

Compute statistics from series output by StagYY.

Parameters:

Name	Type	Description	Default
sdat	StagyyData	a StagyyData instance.	required
names	str	variables whose statistics should be computed.	()
tstart	Optional[float]	starting time. Set to None to start at the beginning of available data.	None
tend	Optional[float]	ending time. Set to None to stop at the end of available data.	None

Returns:

Type	Description
DataFrame	statistics. "mean" and "rms" as index, variable names as columns.

cmd

cmd(conf: Config) -> None

Implementation of time subcommand.