zema_emc_annotated

This software provides a convenient API to access the annotated ZeMA dataset about remaining useful life of an electro-mechanical cylinder on Zenodo ( ) The code was written for Python 3.10.

Getting started

The INSTALL guide assists in installing the required packages.

Documentation

To locally build the HTML or pdf documentation first the required dependencies need to be installed into your virtual environment (check the INSTALL guide first and upon completion execute the following):

(venv) $ python -m poetry install --with docs
(venv) $ sphinx-build docs/ docs/_build
sphinx-build docs/ docs/_build
Running Sphinx v5.3.0
loading pickled environment... done
[...]
The HTML pages are in docs/_build.

After that the documentation can be viewed by opening the file docs/_build/index.html in any browser.

In the near future the documentation will be available on ReadTheDocs.