API Reference

state_space_analysis.stateTool.cli

state_space_analysis.stateTool.cli.build_parser()[source]

Build the argument parser for state-space analysis.

Return type:

ArgumentParser

state_space_analysis.stateTool.cli.main(argv=None)[source]

Run the stateTool command line interface.

Parameters:

argv (list[str] | None)

Return type:

int

state_space_analysis.stateTool.apis

class state_space_analysis.stateTool.apis.AnalysisSummary(mode: 'str', results: 'Dict')[source]

Bases: object

Parameters:

  • mode (str)

  • results (Dict)

mode: str
results: Dict
class state_space_analysis.stateTool.apis.AnalyzerMode(*values)[source]

Bases: str, Enum

ALL = 'all'
ALT = 'alt'
DETECT = 'detect'
OBS = 'obs'
OBSALT = 'obsalt'
OBSSPLANE = 'obssplane'
OUTPUT = 'output'
STAB = 'stab'
STATE = 'state'
S_PLANE = 'splane'
class state_space_analysis.stateTool.apis.RunOptions(mode: 'AnalyzerMode' = <AnalyzerMode.ALL: 'all'>, pretty: 'bool' = False, numeric: 'bool' = False, digits: 'int' = 8, eps: 'float' = 0.0, export_json: 'Optional[str]' = None)[source]

Bases: object

Parameters:

  • mode (AnalyzerMode)

  • pretty (bool)

  • numeric (bool)

  • digits (int)

  • eps (float)

  • export_json (str | None)

digits: int = 8
eps: float = 0.0
export_json: str | None = None
mode: AnalyzerMode = 'all'
numeric: bool = False
pretty: bool = False
class state_space_analysis.stateTool.apis.StateSpaceAnalyzerAPI(out_dir='state_space_analysis/stateTool/out')[source]

Bases: object

Facade class: orchestrates parsing → model → analysis → summary.

Parameters:

out_dir (str)

analyze(model, options, tf_desc)[source]
Parameters:

  • model (StateSpaceModel)

  • options (RunOptions)

  • tf_desc (Dict)

Return type:

AnalysisSummary

build_from_state(A_txt, B_txt, C_txt=None, D_txt=None)[source]
Parameters:

  • A_txt (str)

  • B_txt (str)

  • C_txt (str | None)

  • D_txt (str | None)

Return type:

Tuple[StateSpaceModel, Dict]

build_from_tf(tf=None, num=None, den=None)[source]
Parameters:

  • tf (str | None)

  • num (str | None)

  • den (str | None)

Return type:

Tuple[StateSpaceModel, Dict]

state_space_analysis.stateTool.app

class state_space_analysis.stateTool.app.StateToolApp(out_dir='state_space_analysis/stateTool/out')[source]

Bases: object

High-level app orchestrator (CLI uses this).

Parameters:

out_dir (str)

run_from_state(*, A, B, C, D, options)[source]
Parameters:

  • A (str)

  • B (str)

  • C (str | None)

  • D (str | None)

  • options (RunOptions)

Return type:

Dict

run_from_tf(*, tf, num, den, options)[source]
Parameters:

  • tf (str | None)

  • num (str | None)

  • den (str | None)

  • options (RunOptions)

Return type:

Dict