For Developers

Standards and Tools

Please comply with the following standards/guides as much as possible.

Coding style

• PEP 8: https://www.python.org/dev/peps/pep-0008/

CHANGELOG

• Keep a Changelog: https://keepachangelog.com/en/1.0.0/

Versioning

• Semantic Versioning: https://semver.org/spec/v2.0.0.html

Packaging

• PyPA: https://www.pypa.io
• python-packaging: https://python-packaging.readthedocs.io

Documentation

• NumPy docstrings: https://numpydoc.readthedocs.io/en/latest/format.html
• Sphinx: https://www.sphinx-doc.org/
• Read The Docs: https://readthedocs.org/
• Documenting Python Code: A Complete Guide: https://realpython.com/documenting-python-code/

How to Contribute

Just do it.

Pending

• Documentation.
• tests!
• Model reference sensor/actuator diagonalization
• Add support for reading Shoda-san’s SUMCON simulations.
• Controller optimization
• Optimal controller synthesis
• python-foton interface.
• Diaggui support.
• Issues: https://github.com/terrencetec/kontrol/issues

Cheat sheet

Auto generate source files (sphinx) in /kontrol, type

sphinx-apidoc -o docs/source kontrol