nfdi4ingscientificworkflowrequirements

This is a repository to discuss, collect and store the requirements for scientific workflow systems

https://github.com/bamresearch/nfdi4ingscientificworkflowrequirements

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

This is a repository to discuss, collect and store the requirements for scientific workflow systems

Basic Info
  • Host: GitHub
  • Owner: BAMresearch
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 5.92 MB
Statistics
  • Stars: 13
  • Watchers: 4
  • Forks: 8
  • Open Issues: 4
  • Releases: 1
Created almost 5 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

DOI

Introduction - tools for scientific workflows

Software-driven scientific workflows are often characterized by a complex interplay of various pieces of software executed in a particular order. The output of a computational step may serve as input to a subsequent computation, which requires them to be processed sequentially with a proper mapping of outputs to inputs. Other computations are independent of each other and can be executed in parallel. Thus, one of the main tasks of a workflow tool is a proper and efficient scheduling of the individual processing steps.

Each processing step, just as the workflow itself, typically processes some input and produces output data. Apart from changing the input data to operate on, processing steps can usually be configured by a set of parameters to change their behavior. Moreover, the behavior of a processing step is determined by its source code and/or executable binaries/packages that are called within it. Beyond this, the computation environment not only has a significant influence on its behavior, but is also crucial in order for the processing step to work at all. The environment includes the versions of the interpreters or compilers, as well as all third-party libraries and packages that contribute to the computations carried out in a processing step.

In order for research workflows to comply with the FAIR principles, they should be:

  • published
  • documented
  • annotated with metadata
  • reproducible
  • reusable

Because of the dependency on their environment, reproducibility and reusability is not trivial to achieve for scientific workflows. The results presented in a scientific paper, for instance, are produced with a very specific environment, and in order to guarantee reproducibility, this environment has to be reinstantiated possibly many years later.

In this documentation we want to elaborate, together with the scientific community, a vision on how scientific workflows should be created/packaged/published in order to be as FAIR as possible. We want to evaluate if existing workflow tools provide reusable solutions and identify the capabilities that are missing to reach our goal: reproducible research workflows, by anyone, anywhere and anytime.

Go to the documentation.

How to contribute

We greatly appreciate and encourage contributions by any users or developers of workflow tools. A list of preselected tools can be found in the documentation. If you would like to add an implementation of the exemplary workflow for a tool (not limited to the given list), or if you suggest changes to one of the existing implementations, please raise an issue and/or submit a pull request. We also encourage to start a new discussion for general comments, questions and ideas you would like to share.

Links

The project is used in other examples to define workflow examples, e.g. using a General workflow definition

Acknowledgements

The authors would like to thank the Federal Government and the Heads of Government of the Länder, as well as the Joint Science Conference (GWK), for their funding and support within the framework of the NFDI4Ing consortium. Funded by the German Research Foundation (DFG) - project number 442146713.

Owner

  • Name: Bundesanstalt für Materialforschung und -prüfung
  • Login: BAMresearch
  • Kind: organization
  • Email: oss@bam.de
  • Location: Berlin/Germany

German Federal scientific research institute for materials testing and research

Citation (CITATION.cff)

# Visit https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonaffiliation
# for more information on Citation File Format and optional metadata.

cff-version: 1.2.0
title: "NFDI4Ing Scientific Workflow Requirements"
abstract: "This is a repository to discuss, collect and store the requirements for scientific workflow systems."
date-released: 2023-04-01
doi: 10.5281/zenodo.7790634
url: "https://github.com/BAMresearch/NFDI4IngScientificWorkflowRequirements"
version: 1.0.0
license: MIT
message: >-
  Please cite this work using the metadata from this
  file.
type: dataset
authors:
  - given-names: "Philipp"
    family-names: "Diercks"
    email: philipp.diercks@bam.de
    affiliation: >-
      Bundesanstalt für Materialforschung und
      -prüfung (BAM)
  - given-names: "Dennis"
    family-names: "Gläser"
    email: dennis.glaeser@iws.uni-stuttgart.de
    affiliation: >-
      University of Stuttgart
  - given-names: "Bernd"
    family-names: "Flemisch"
    email: bernd.flemisch@iws.uni-stuttgart.de
    affiliation: >-
      University of Stuttgart
  - given-names: "Jan"
    family-names: "Janssen"
    email: janssen@mpi-susmat.de
    affiliation: >-
      Max Planck Institute for Sustainable Materials
  - given-names: "Jörg F."
    family-names: "Unger"
    email: joerg.unger@bam.de
    affiliation: >-
      Bundesanstalt für Materialforschung und
      -prüfung (BAM)

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 51
  • Pull request event: 1
  • Fork event: 3
  • Create event: 2
Last Year
  • Issues event: 1
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 51
  • Pull request event: 1
  • Fork event: 3
  • Create event: 2

Dependencies

.github/workflows/main.yml actions
  • ./.github/actions/install-basic-deps * composite
  • PromyLOPh/guix-install-action v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • conda-incubator/setup-miniconda v2 composite
  • postgres 10 docker
  • rabbitmq 3.8.14 docker
  • xenonmiddleware/slurm 17 docker
.github/actions/install-basic-deps/action.yml actions
.github/workflows/cff.yml actions
  • actions/checkout v3 composite
  • dieghernan/cff-validator main composite