Skip to content

Python package for handling signal flow for real-time control systems.

License

Notifications You must be signed in to change notification settings

terrencetec/sigflow

Repository files navigation

Logo

Construct real-time control systems using SigFlow

Website Release Read the Docs License travis-ci codecov

SigFlow is a python package allows you design and run custom control topology in real-time with actual hardware. It provides classes for control block diagram elements, such as filters, junctions, and matrices. These elements can be inter-connected to form a custom control systems and it can be run at real-time if hardware interfaces is provided.

features

  • Design control systems with custom topology by making custom block-dragrams.
  • Runs control systems in real-time with hardware interfaces.

Documentation: https://sigflow.readthedocs.io

Repository: https://github.com/terrencetec/sigflow

Required

  • Package 1
  • Package 2
  • Package 3

Optional

  • Package 4

Note on installing dependencies

In principle, if you are using pip, you don't have to install dependencies beforehand. When you install this package, :code`pip` will automatically install the required libraries. However if you are using Conda it is best to use its own package manager and not pip unless absolutely necessary.

If you use conda:

conda install -c conda-forge package1 package2

Now, let's say package 3 is not available, then we can use pip. But, be sure to use which pip to check if we are using the pip installed on the conda environment and not the global one.

pip install package3
git clone https://github.com/terrencetec/sigflow.git
cd sigflow
pip install .

Try out the package and file an issue if you find any!

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

Coding style

CHANGELOG

Versioning

Packaging

Documentation

Sphinx

Generate documentation base, in docs/,

sphinx-quickstart

Select separate build and source files when prompted.

Preview documentation page with modified source, in docs/

make html

Open index.html with a browser (if this was set as the first page).

About

Python package for handling signal flow for real-time control systems.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages