Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Z
zema_emc_annotated
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
M4D
zema_emc_annotated
Commits
78292f94
Verified
Commit
78292f94
authored
2 years ago
by
Björn Ludwig
Browse files
Options
Downloads
Patches
Plain Diff
docs(README): improve and extend README with Disclaimer and License sections as well as new links
parent
94ed4c01
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#16333
failed
2 years ago
Stage: test
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+22
-21
22 additions, 21 deletions
README.md
with
22 additions
and
21 deletions
README.md
+
22
−
21
View file @
78292f94
# 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://git
lab1.ptb.de/m4d
/zema_emc_annotated/
-/
releases)
[

](https://git
hub.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
)
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment