Skip to content
Snippets Groups Projects
Verified Commit 78292f94 authored by Björn Ludwig's avatar Björn Ludwig
Browse files

docs(README): improve and extend README with Disclaimer and License sections as well as new links

parent 94ed4c01
Branches
Tags
No related merge requests found
Pipeline #16333 failed
# zema_emc_annotated # zema_emc_annotated
[![pipeline status](https://gitlab1.ptb.de/m4d/zema_emc_annotated/badges/main/pipeline.svg)](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/commits/main) [![pipeline status](https://gitlab1.ptb.de/m4d/zema_emc_annotated/badges/main/pipeline.svg)](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/commits/main)
[![Documentation Status](https://readthedocs.org/projects/zema-emc-annotated/badge/?version=latest)](https://zema-emc-annotated.readthedocs.io/en/latest/?badge=latest)
[![coverage report](https://gitlab1.ptb.de/m4d/zema_emc_annotated/badges/main/coverage.svg)](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/commits/main) [![coverage report](https://gitlab1.ptb.de/m4d/zema_emc_annotated/badges/main/coverage.svg)](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/commits/main)
[![Latest Release](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/badges/release.svg)](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/releases) [![Latest Release](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/badges/release.svg)](https://github.com/PTB-M4D/zema_emc_annotated/releases/latest)
This software provides a convenient API to access the annotated ZeMA dataset about This software provides a convenient API to access the annotated ZeMA dataset about
remaining useful life of an electro-mechanical cylinder on Zenodo ( remaining useful life of an electro-mechanical cylinder on Zenodo
[![DOI 10.5281/zenodo.5185953 ([![DOI
](https://zenodo.org/badge/DOI/10.5281/zenodo.5185953.svg) 10.5281/zenodo.5185953](https://zenodo.org/badge/DOI/10.5281/zenodo.5185953.svg)
](https://doi.org/10.5281/zenodo.5185953)) The code was written for _Python 3.10_. ](https://doi.org/10.5281/zenodo.5185953)). The code was written for _Python 3.10_.
## Getting started ## Getting started
The [INSTALL guide](INSTALL.md) assists in installing the required packages. The [INSTALL guide](INSTALL.md) assists in installing the required packages.
Afterwards please visit our
[example page](https://zema-emc-annotated.readthedocs.io/en/latest/examples.html).
## Documentation ## Documentation
To locally build the HTML or pdf documentation first the required dependencies need The documentation can be found on
to be installed into your virtual environment (check the [INSTALL guide](INSTALL.md) [ReadTheDocs](https://zema-emc-annotated.readthedocs.io/en/latest/).
first and upon completion execute the following):
```shell ## Disclaimer
(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 This software is developed at Physikalisch-Technische Bundesanstalt (PTB). The software
_docs/\_build/index.html_ in any browser. is made available "as is" free of cost. PTB assumes no responsibility whatsoever for
its use by other parties, and makes no guarantees, expressed or implied, about its
quality, reliability, safety, suitability or any other characteristic. In no event
will PTB be liable for any direct, indirect or consequential damage arising in
connection with the use of this software.
In the near future the documentation will be available on ReadTheDocs. ## License
pytorch_gum_uncertainty_propagation is distributed under the [MIT
license](https://github.com/BjoernLudwigPTB/pytorch_gum_uncertainty_propagation/blob/main/LICENSE).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment