exo-oscilloscope 0.0.2

A Python-based exosuit oscilloscope

template-python

A data visualizer to help view the exosuit data streams.

Install

To install the library run:

pip install exo-oscilloscope

OR

pip install git+https://github.com/TUM-Aries-Lab/exo-oscilloscope.git@<specific-tag>

Development

0. Install Poetry
1. Install pyenv
2. pyenv install <desired-python-version> # install the required python version
3. pyenv global <desired-python-version> # set the required python version
4. git clone [e-mail]:TUM-Aries-Lab/exo-oscilloscope.git
5. make init to create the virtual environment and install dependencies
6. make format to format the code and check for errors
7. make test to run the test suite
8. make clean to delete the temporary files and directories

Publishing

It's super easy to publish your own packages on PyPI. To build and publish this package run:

poetry build
poetry publish  # make sure your version in pyproject.toml is updated

The package can then be found at: https://pypi.org/project/exo-oscilloscope

Module Usage

"""Basic docstring for my module."""

from exo_oscilloscope.plotter import ExoPlotter

def main() -> None:
    """Run a simple demonstration."""
    gui = ExoPlotter()
    gui.run()

if __name__ == "__main__":
    main()

Program Usage

poetry run python -m exo_oscilloscope