API Reference¶

Application Layer¶

class pid_controllers.tuningTool.app.TuningApp(repo: 'RulesRepository', engine: 'TuningEngine', service: 'TuningService', printer: 'PrintAPI', exporter: 'ExportAPI')[source]¶

Parameters:

repo (RulesRepository)
engine (TuningEngine)
service (TuningService)
printer (PrintAPI)
exporter (ExportAPI)

classmethod create_default()[source]¶

Return type:: TuningApp

engine: TuningEngine¶

exporter: ExportAPI¶

printer: PrintAPI¶

repo: RulesRepository¶

run_compute(*, method, controller, inputs, file=None)[source]¶

Parameters:

method (str)
controller (str)
inputs (TuningInputs)
file (str | None)

Return type:

TuningResult

save_json(data, filename)[source]¶

Parameters:

data (dict)
filename (str)

Return type:

Path

service: TuningService¶

API Schemas¶

class pid_controllers.tuningTool.apis.ExportAPI[source]¶

to_json(res)[source]¶

Parameters:: res (TuningResult)
Return type:: Dict[str, Any]

class pid_controllers.tuningTool.apis.PrintAPI[source]¶

Presentation helpers for console/UI output.

render_text(res, precision=6)[source]¶

Parameters:

res (TuningResult)
precision (int)

Return type:

str

Core Utilities¶

class pid_controllers.tuningTool.utils.TuningInputs(L: 'float | None' = None, T: 'float | None' = None, Kcr: 'float | None' = None, Pcr: 'float | None' = None)[source]¶

Parameters:

L (float | None)
T (float | None)
Kcr (float | None)
Pcr (float | None)

Kcr: float | None¶

L: float | None¶

Pcr: float | None¶

T: float | None¶

to_ctx()[source]¶

Return type:: Dict[str, Any]

pid_controllers.tuningTool.utils.fmt_num(x, digits=6)[source]¶

Parameters:

x (float | int | str)
digits (int)

Return type:

str

Command Line Interface¶

pid_controllers.tuningTool.cli.main(argv=None)[source]¶

Parameters:: argv (list[str] | None)
Return type:: int

Tool Paths¶

pid_controllers.tuningTool.tools.tool_paths.ensure_outdir()[source]¶

Return type:: None