From 84da6931a3ce3ad0495a284a5a78db7ae1aae8c1 Mon Sep 17 00:00:00 2001 From: Joerg Schaarschmidt Date: Thu, 7 Dec 2023 16:10:37 +0100 Subject: [PATCH] add metadata text --- docs/pages/detailed_instructions/metadata.md | 17 +++++++++++++++++ docs/pages/index.md | 1 - 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/pages/detailed_instructions/metadata.md b/docs/pages/detailed_instructions/metadata.md index 1ffa548..931a497 100644 --- a/docs/pages/detailed_instructions/metadata.md +++ b/docs/pages/detailed_instructions/metadata.md @@ -4,3 +4,20 @@ layout: default nav_order: 1 parent: Detailed Instructions --- + +### Metadata +In order to register the workflow in the PMD workflow store, the file `meta.json` is required. The file includes the essential metadata. The keys and their possible values are listed in the following table: + +| Key | Requirement | Description| +|-----|------------|------------| +| title | Mandatory | the Label of the workflow | +| workflow_environment | Mandatory | pyiron or SimStack | +| description | Mandatory | the description of the workflow | +| authors | Mandatory | a list of authors' names and optional their email addresses e.g. ["Author One ", "Author Two "] | +| release | Mandatory | version information of the release | +| keywords | Mandatory | a list of keywords for the workflow (From a list of available keywords, making it possible to be queried via Ontology) | +| categories | Optional | a list of categories, e.g., atomistics, continuum, experimental| +| steps/codes | Optional | a list of steps/codes, e.g., LAMMPS, DAMASK, calculation of elastic modulus| +| licenses | Optional | a dictionary where the keys are the packages used in the workflow and the values are the corresponding license type.
e.g. 'pyiron':'BSD-3' | +| publications | Optional | a list of publications | +| logo | Optional | path to the logo of the workflow within the repository| \ No newline at end of file diff --git a/docs/pages/index.md b/docs/pages/index.md index e1558d2..ae519b5 100644 --- a/docs/pages/index.md +++ b/docs/pages/index.md @@ -7,7 +7,6 @@ nav_order: 1 # How do I upload to the Workflow Store? -[toc] ## Introduction