Awesome
<!-- SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR), Forschungszentrum Jülich SPDX-License-Identifier: CC-BY-SA-4.0 --> <!-- SPDX-FileContributor: Stephan Druskat SPDX-FileContributor: Michael Meinel SPDX-FileContributor: Oliver Bertuch -->hermes
Implementation of the HERMES workflow. For more extensive documentation, see the HERMES workflow documentation.
(For more information about the HERMES HMC project, see the HERMES project website.)
Installation
hermes
' primary use case is to use it in a continuous integration environment.
In case you still want to install on your machine, you can (for example) use pip
.
- Note: you must have Python 3.10 or newer installed.
- Note: please use the development installation method for now - releases coming to PyPI soon!
Development Snapshot
To install the most recent version that has not been released yet, please install from our sources on GitHub:
pip install git+https://github.com/hermes-hmc/hermes.git
Usage
The hermes
application provides the entry point for the HERMES workflow.
After installation, you can run it from your command line environment:
hermes --help
hermes harvest
You can also call the hermes
package as a Python module:
python -m hermes --help
python -m hermes harvest
Contributions, Extension and Development
We welcome external contributions! Please follow our contribution guidelines.
HERMES was designed with extensibility in mind. Our development guide contains in-depth information on how to get ready and start coding.
Acknowledgements
This project (ZT-I-PF-3-006) was funded by the Initiative and Networking Fund of the Helmholtz Association in the framework of the Helmholtz Metadata Collaboration's 2020 project call.
License and Citation
Please see LICENSE.md
for legal information.
We provide a CITATION.cff
containing all metadata for citation, which is also easy to
use via the widget on the right-hand side.