Hermes 📯 is a package to handle the communication between workflows and CG.
The name Hermes comes from greek mythology, he was considered to be the messenger between the humans and the gods, feel free to interpret that as you like:). Hermes was moving swiftly between the worlds aided by his winged sandals.
pip install cg-hermes
Install poetry
git clone https://github.com/Clinical-Genomics/cg-hermes
poetry install
Please check out our guide for contributing to Hermes.
- See DEPLOYMENT.md
Each workflow specifies its output, or result files, in some way. CG wants to have this input in a certain way to know how to fetch files from housekeeper etc. Hermes is used to convert the deliverables specification from the workflow to the CG format so that CG safely can store the information without parsing different files in different ways.
Also, this is the place where workflow developers can communicate around tags, what to deliver etc without understanding how CG works.
I think it would be a good idea to have Hermes starting the workflows as well as it is the workflow developers who know this best, following the reasoning above.