API Reference

state_space_design.statePlotsTool.cli

state_space_design.statePlotsTool.cli.build_parser()

Return type:

ArgumentParser

state_space_design.statePlotsTool.cli.main(argv=None)

Parameters:

argv (list[str] | None)

Return type:

int

state_space_design.statePlotsTool.apis

class state_space_design.statePlotsTool.apis.RunRequest(data: 'Path', scenario: 'str' = 'auto', what: 'str' = 'auto', subplots: 'bool' = False, t: 'str' = '0:0.01:4', x0: 'Optional[str]' = None, backend: 'str' = 'both', save_png: 'Optional[str]' = None, save_html: 'Optional[str]' = None, save_csv: 'Optional[str]' = None, in_dir: 'Path' = PosixPath('/home/runner/work/control-systems/control-systems/state_space_design/statePlotsTool/in'), out_dir: 'Path' = PosixPath('/home/runner/work/control-systems/control-systems/state_space_design/statePlotsTool/out'), no_show: 'bool' = True)

Bases: object

Parameters:

• data (Path)

• scenario (str)

• what (str)

• subplots (bool)

• t (str)

• x0 (str | None)

• backend (str)

• save_png (str | None)

• save_html (str | None)

• save_csv (str | None)

• in_dir (Path)

• out_dir (Path)

• no_show (bool)

backend: str = 'both'

data: Path

in_dir: Path = PosixPath('/home/runner/work/control-systems/control-systems/state_space_design/statePlotsTool/in')

no_show: bool = True

out_dir: Path = PosixPath('/home/runner/work/control-systems/control-systems/state_space_design/statePlotsTool/out')

save_csv: str | None = None

save_html: str | None = None

save_png: str | None = None

scenario: str = 'auto'

subplots: bool = False

t: str = '0:0.01:4'

what: str = 'auto'

x0: str | None = None

class state_space_design.statePlotsTool.apis.StatePlotsAPI

Bases: object

run(req)

Parameters:

req (RunRequest)

Return type:

dict

state_space_design.statePlotsTool.app

class state_space_design.statePlotsTool.app.StatePlotsApp(api: 'StatePlotsAPI')

Bases: object

Parameters:

api (StatePlotsAPI)

api: StatePlotsAPI

run(**kwargs)

state_space_design.statePlotsTool.app.main_kwargs_from_args(args)

Return type:

dict

state_space_design.statePlotsTool.core

class state_space_design.statePlotsTool.core.ClosedLoopBuilder

Bases: object

static Acl_from_controller(cj)

Parameters:

cj (ControllerJSON)

Return type:

tuple[ndarray, list[str]]

class state_space_design.statePlotsTool.core.ScenarioDetector

Bases: object

static detect(payload)

Parameters:

payload (dict)

Return type:

str

class state_space_design.statePlotsTool.core.SimICResult(t: 'np.ndarray', X: 'np.ndarray', labels: 'list[str]')

Bases: object

Parameters:

• t (ndarray)

• X (ndarray)

• labels (list[str])

X: ndarray

labels: list[str]

t: ndarray

class state_space_design.statePlotsTool.core.SimStepResult(t: 'np.ndarray', series: 'list[np.ndarray]', labels: 'list[str]', kind: 'str')

Bases: object

Parameters:

• t (ndarray)

• series (list[ndarray])

• labels (list[str])

• kind (str)

kind: str

labels: list[str]

series: list[ndarray]

t: ndarray

class state_space_design.statePlotsTool.core.Simulator

Bases: object

static initial_condition(cj, t, x0)

Parameters:

• cj (ControllerJSON)

• t (ndarray)

• x0 (ndarray)

Return type:

SimICResult

static step(ioj, t, what='y')

Parameters:

• ioj (IOJSON)

• t (ndarray)

• what (str)

Return type:

SimStepResult

state_space_design.statePlotsTool.core.parse_time(s)

Parameters:

s (str)

Return type:

ndarray

state_space_design.statePlotsTool.core.parse_vec_real(s, n)

Parameters:

• s (str | None)

• n (int)

Return type:

ndarray

state_space_design.statePlotsTool.design

class state_space_design.statePlotsTool.design.CSVExporter

Bases: object

save_ic(res, filename=None, out_dir=None)

Parameters:

• res (SimICResult)

• filename (str | None)

• out_dir (Path | None)

Return type:

Path

save_step(res, filename=None, out_dir=None)

Parameters:

• res (SimStepResult)

• filename (str | None)

• out_dir (Path | None)

Return type:

Path

class state_space_design.statePlotsTool.design.PlotBackend(subplots: 'bool' = False)

Bases: object

Parameters:

subplots (bool)

mpl(t, series, labels, title, ylab, filename_png=None, out_dir=None)

Parameters:

• filename_png (str | None)

• out_dir (Path | None)

plotly(t, series, labels, title, ylab, filename_html=None, out_dir=None)

Parameters:

• filename_html (str | None)

• out_dir (Path | None)

subplots: bool = False

state_space_design.statePlotsTool.io

class state_space_design.statePlotsTool.io.ControllerJSON(mode: 'str', A: 'np.ndarray', B: 'Optional[np.ndarray]', C: 'Optional[np.ndarray]', K: 'Optional[np.ndarray]', L: 'Optional[np.ndarray]', state_names: 'list[str]')

Bases: object

Parameters:

• mode (str)

• A (ndarray)

• B (ndarray | None)

• C (ndarray | None)

• K (ndarray | None)

• L (ndarray | None)

• state_names (list[str])

A: ndarray

B: ndarray | None

C: ndarray | None

K: ndarray | None

L: ndarray | None

mode: str

state_names: list[str]

class state_space_design.statePlotsTool.io.IOJSON(Acl: 'np.ndarray', Bcl: 'np.ndarray', C: 'np.ndarray', D: 'np.ndarray', r: 'float', state_names: 'list[str]', output_names: 'list[str]')

Bases: object

Parameters:

• Acl (ndarray)

• Bcl (ndarray)

• C (ndarray)

• D (ndarray)

• r (float)

• state_names (list[str])

• output_names (list[str])

Acl: ndarray

Bcl: ndarray

C: ndarray

D: ndarray

output_names: list[str]

r: float

state_names: list[str]

state_space_design.statePlotsTool.io.load_json(path)

Parameters:

path (str | Path)

Return type:

dict

state_space_design.statePlotsTool.io.try_parse_controller(payload)

Parameters:

payload (dict)

Return type:

ControllerJSON | None

state_space_design.statePlotsTool.io.try_parse_io(payload)

Parameters:

payload (dict)

Return type:

IOJSON | None

state_space_design.statePlotsTool.utils

state_space_design.statePlotsTool.utils.ensure_dir(p)

Parameters:

p (Path)

Return type:

Path

state_space_design.statePlotsTool.utils.package_rel(pathlike)

Resolve a path relative to the package root.

Parameters:

pathlike (str | PathLike)

Return type:

Path

state_space_design.statePlotsTool.utils.resolve_out_path(filename, default_name, out_dir=None)

Parameters:

• filename (str | None)

• default_name (str)

• out_dir (Path | None)

Return type:

Path

state_space_design.statePlotsTool.utils.with_outdir(func)

Decorator that injects a default out_dir kwarg when not provided.