Skip to content
@softwarepub

Automated Software Metadata Publication

README.md

Welcome

The softwarepub organization on GitHub is home to the "HERMES" and "Software CaRD" projects.

HElmholtz Rich MEtadata Software Publications (HERMES)

HERMES is a language-independent set of tools and practices to help you implement "continuous software publishing", creating publications from your software automatically.

Why this is great

A software publication is about creating a publication about the entity the software represents. The software becomes a citable entity, referable in yours and others publications. Furthermore, publishing software promotes

  • Sustainability -- Foster reuse by visibility, ensure availability, and acquire more funding
  • Reproducibility -- Document how "I used release/commit xyz for process abc"
  • Academic Credit -- Especially if your software is not primary subject of publications, created using it
  • FAIR for Research Software -- FAIR4RS principles

How HERMES improves Software Publishing

Software publication state of the art works by bridging GitHub with Zenodo and providing several meatadata you wll be able to automatically create a publcation on Zenodo. This "pull based workflow" is limited by certain factors: code must be accessible, less control over extracted metadata, dependent on single service (Zenodo).

HERMES turns this process upside-down by integrating software publication into your CI/CD pipelines where you define the events, the targets and the scope for your software publication.

How it works

The workflow is described in detail in the hermes repository.

You can find a tutorial how to setup HERMES for your project in our guides.

Is there an example or demo?

An example configuration can be viewed in the showcase repository.

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. Development now continues as a joined community effort.

Software Curation and Reporting Dashboard (Software CaRD)

In the HERMES workflow humans shall be kept in the loop: Metadata curation, publication approval and evaluation processes require human interaction and should be supported by graphical user interfaces.

We create "Software CaRD", an open source application that presents software publication metadata for curation. Preprocessed metadata from automated pipelines are made accessible in a structured graphical view, with highlighted issues and conflicts. Software CaRD also assesses metadata for compliance with configurable policies, and lets users track and visualize relevant metadata for evaluation and reporting.

We are just getting started with this project! (2024-07-01) Stay tuned for more!

Popular repositories Loading

  1. hermes hermes Public

    Implementation of the HERMES workflow

    Python 21 6

  2. project.software-metadata.pub project.software-metadata.pub Public

    The HERMES project repository, mostly used to capture meta elements at project level and do project management.

    Python 11 2

  3. concept-paper concept-paper Public

    Source for the HERMES concept paper

    TeX 1

  4. showcase showcase Public

    Example of using the HERMES Workflow

    Python 1

  5. ci-templates ci-templates Public

    Continuous integration templates for automatic software publication with HERMES

    1 1

  6. github-action github-action Public

    Docker image and Github Action for hermes

    Dockerfile

Repositories

Showing 10 of 10 repositories
  • hermes Public

    Implementation of the HERMES workflow

    softwarepub/hermes’s past year of commit activity
    Python 21 6 90 (3 issues need help) 2 Updated Nov 22, 2024
  • ci-templates Public

    Continuous integration templates for automatic software publication with HERMES

    softwarepub/ci-templates’s past year of commit activity
    1 1 2 0 Updated Nov 11, 2024
  • hermes-plugin-git Public

    Integration of Git into hermes

    softwarepub/hermes-plugin-git’s past year of commit activity
    Python 0 0 0 0 Updated Aug 9, 2024
  • hermes-plugin-python Public

    Hermes-Plugins to deal with Python projects (e.g., harvest from pyproject.toml)

    softwarepub/hermes-plugin-python’s past year of commit activity
    Python 0 0 1 1 Updated Aug 2, 2024
  • .github Public

    GitHub Landing Page

    softwarepub/.github’s past year of commit activity
    0 CC0-1.0 0 0 0 Updated Jul 26, 2024
  • showcase Public

    Example of using the HERMES Workflow

    softwarepub/showcase’s past year of commit activity
    Python 1 CC0-1.0 0 0 0 Updated Mar 6, 2024
  • project.software-metadata.pub Public

    The HERMES project repository, mostly used to capture meta elements at project level and do project management.

    softwarepub/project.software-metadata.pub’s past year of commit activity
    Python 11 2 13 (1 issue needs help) 0 Updated Nov 30, 2023
  • schema.software-metadata.pub Public
    softwarepub/schema.software-metadata.pub’s past year of commit activity
    0 0 0 0 Updated Nov 15, 2023
  • github-action Public

    Docker image and Github Action for hermes

    softwarepub/github-action’s past year of commit activity
    Dockerfile 0 MIT 0 1 0 Updated Jun 23, 2023
  • concept-paper Public

    Source for the HERMES concept paper

    softwarepub/concept-paper’s past year of commit activity
    TeX 1 0 15 0 Updated Jan 21, 2022

Top languages

Loading…

Most used topics

Loading…