API Reference

Application Layer

class pid_controllers.rootLocusTool.app.RootLocusApp(in_dir: 'str' = 'pid_controllers/rootLocusTool/in', out_dir: 'str' = 'pid_controllers/rootLocusTool/out')

Parameters:

• in_dir (str)

• out_dir (str)

in_dir: str

out_dir: str

run(*, example=None, num=None, den=None, backend='plotly', save=None, export_json=None, export_csv=None, **kwargs)

Parameters:

• example (str | None)

• num (str | None)

• den (str | None)

• backend (str)

• save (str | None)

• export_json (str | None)

• export_csv (str | None)

Command Line Interface

pid_controllers.rootLocusTool.cli.build_parser()

Return type:

ArgumentParser

pid_controllers.rootLocusTool.cli.main(argv=None)

Parameters:

argv (list[str] | None)

Return type:

int