From 78292f94a4a86365d44e56525a7c26171807c665 Mon Sep 17 00:00:00 2001 From: Bjoern Ludwig <bjoern.ludwig@ptb.de> Date: Sat, 21 Jan 2023 02:39:50 +0100 Subject: [PATCH] docs(README): improve and extend README with Disclaimer and License sections as well as new links --- README.md | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fee81f2..5d00caa 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,37 @@ # zema_emc_annotated [](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/commits/main) +[](https://zema-emc-annotated.readthedocs.io/en/latest/?badge=latest) [](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/commits/main) -[](https://gitlab1.ptb.de/m4d/zema_emc_annotated/-/releases) +[](https://github.com/PTB-M4D/zema_emc_annotated/releases/latest) This software provides a convenient API to access the annotated ZeMA dataset about -remaining useful life of an electro-mechanical cylinder on Zenodo ( -[ -](https://doi.org/10.5281/zenodo.5185953)) The code was written for _Python 3.10_. +remaining useful life of an electro-mechanical cylinder on Zenodo +([ +](https://doi.org/10.5281/zenodo.5185953)). The code was written for _Python 3.10_. ## 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 -To locally build the HTML or pdf documentation first the required dependencies need -to be installed into your virtual environment (check the [INSTALL guide](INSTALL.md) -first and upon completion execute the following): +The documentation can be found on +[ReadTheDocs](https://zema-emc-annotated.readthedocs.io/en/latest/). -```shell -(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. -``` +## Disclaimer -After that the documentation can be viewed by opening the file -_docs/\_build/index.html_ in any browser. +This software is developed at Physikalisch-Technische Bundesanstalt (PTB). The software +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). -- GitLab