-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dc0f625
commit 721fef4
Showing
1 changed file
with
25 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,16 +18,25 @@ SPDX-FileContributor: Michael Meinel | |
This is a work in progress. Expect disruptive changes. | ||
``` | ||
|
||
Research software must be formally published to satisfy FAIR principles and unlock academic credit. Publication | ||
repositories enable this and provide PIDs for software versions, but only through tedious, mostly manual process. | ||
|
||
The HERMES workflow enables automated publication of rich research software metadata and artifacts to publication | ||
repositories using open source tooling. | ||
|
||
We follow a *push based* model and run in continuous integration (CI) infrastructures integrated in common code platforms | ||
such as GitHub or GitLab to avoid going out of service and overcome limitations of pull-based web services. | ||
|
||
Rich descriptive metadata is the key element to useful software publications. We harvest existing metadata from source | ||
Research software must be formally published to satisfy the | ||
[*FAIR Principles for Research Software*](https://doi.org/10.15497/RDA00068), | ||
improve software sustainability and | ||
enable software citation. | ||
Publication repositories make software publication possible | ||
and provide PIDs for software versions. | ||
But software publication is often a tedious, manual process. | ||
|
||
HERMES workflows automate the publication of research software with rich research metadata | ||
using an open source tool, the `hermes` Python package. | ||
|
||
HERMES follows a *push-based* model and runs in | ||
continuous integration (CI) systems. | ||
This way, it helps overcome limitations of platform-centric | ||
pull-based services and grants its users full control over the | ||
publication process and the metadata compiled for the publication. | ||
|
||
Rich descriptive metadata is the key element to useful software publications. | ||
We harvest existing metadata from source | ||
code repos and connected platforms, then process, collate and present them for curation, thus preparing software for | ||
automatic submission to publication repositories. | ||
|
||
|
@@ -65,25 +74,16 @@ Project Website <https://project.software-metadata.pub> | |
Concept Paper <https://arxiv.org/abs/2201.09015> | ||
``` | ||
|
||
## Feedback | ||
## Get in touch! | ||
|
||
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. | ||
HERMES is part of a global and interdisciplinary effort to improve the state of the art in | ||
research software engineering, maintenance and scholarly communications around research software. We | ||
appreciate any feedback you may have. | ||
|
||
**How to give feedback** | ||
|
||
Either [create an issue](https://github.com/hermes-hmc/workflow/issues/new/choose) in our project repository or | ||
[send us an email](mailto:[email protected]?subject=HERMES%20WOrkflow%20Reachout). | ||
|
||
## Acknowledgements | ||
|
||
This project (ZT-I-PF-3-006) was funded by the *Initiative and Networking Fund* | ||
of the [Helmholtz Association](https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking) | ||
in the framework of the [Helmholtz Metadata Collaboration](https://helmholtz-metadaten.de)'s | ||
[2020 project call](https://helmholtz-metadaten.de/en/projects/hmc-projects-2020). | ||
Either [create an issue](https://github.com/softwarepub/hermes/issues/new/choose) in our project repository or | ||
[send us an email](mailto:[email protected]?subject=HERMES%20Workflows). | ||
|
||
```{include} ../../LICENSE.md | ||
``` | ||
|