This is a work in progress. Expect disruptive changes.
Implementation of the HERMES workflow.
For more information about the HERMES project, see the HERMES project website.
Python sources are in the
pytest tests are in the
Architectural Design Records (ADR) are in
API documentation is generated into
All other documentation lives in
This project uses
a development branch (
develop) to merge developments into, this is the default branch
actual development is done on “feature” branches (this includes non-feature work such as bug fixing)
mainbranch which only includes releases
haggis application provides the entry point for the HERMES workflow.
After installation, you can run it from your command line environment:
haggis --help haggis harvest
You can also call the
hermes package as Python module:
python -m hermes --help python -m hermes
Tests are implemented using pytest.
You can generate coverage report using the
Both tools are specified as development dependencies in the
To run tests with an extensive HTML report, run:
poetry run pytest test --cov=hermes --cov-branch --cov-report=html --cov-report=term
This project comes with extensive documentation that can be built using Sphinx. This also includes automatic API documentation. To build the documentation in your poetry environment, run the following commands from the project root:
poetry install --with docs poetry run task docs-build
sphinx-autobuild to enable a self-updating preview service:
poetry install --with docs poetry run task docs-live
This is an open repository to collect feedback on the HERMES workflow.
We see our project as part of a global and inter-disciplinary effort to improve the state of the art in research software engineering, maintenance and scholarly communications around research software. We therefore appreciate any feedback you may have on the HERMES project itself and any of its outputs.
How to give feedback
This project documentation is licensed under a Creative Commons CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.
Our logo / key visual / icon is licensed under Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)