Skip to content

Commit

Permalink
add metadata text
Browse files Browse the repository at this point in the history
  • Loading branch information
schaarj committed Dec 7, 2023
1 parent 9d54a94 commit 84da693
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
17 changes: 17 additions & 0 deletions docs/pages/detailed_instructions/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>", "Author Two <[email protected]>"] |
| 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. <br> e.g. 'pyiron':'BSD-3' |
| publications | Optional | a list of publications |
| logo | Optional | path to the logo of the workflow within the repository|
1 change: 0 additions & 1 deletion docs/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ nav_order: 1

# How do I upload to the Workflow Store?

[toc]

## Introduction

Expand Down

0 comments on commit 84da693

Please sign in to comment.