Skip to content

Commit f524f2c

Browse files
committed
update readme
1 parent 8afe32c commit f524f2c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,28 @@ initial structure is relaxed, afterward it is strained and the total energy is c
7777
| [aiida_qe.ipynb](aiida_qe.ipynb) | Define Workflow with aiida and execute it with jobflow and pyiron_base. |
7878
| [jobflow_qe.ipynb](jobflow_qe.ipynb) | Define Workflow with jobflow and execute it with aiida and pyiron_base. |
7979
| [pyiron_base_qe.ipynb](pyiron_base_qe.ipynb) | Define Workflow with pyiron_base and execute it with aiida and jobflow. |
80-
| [universal_workflow_qe.ipynb](universal_workflow_qe.ipynb) | Execute workflow defined in the Python Workflow Definition with aiida, executorlib, jobflow, pyiron_base and pure Python. |
80+
| [universal_workflow_qe.ipynb](universal_workflow_qe.ipynb) | Execute workflow defined in the Python Workflow Definition with aiida, executorlib, jobflow, pyiron_base and pure Python. |
81+
82+
### NFDI4Ing Scientific Workflow Requirements
83+
To demonstrate the compatibility of the Python Workflow Definition to file based workflows, the workflow benchmark developed as part of [NFDI4Ing](https://github.com/BAMresearch/NFDI4IngScientificWorkflowRequirements)
84+
is implemented for all three simulation codes based on a shared workflow definition.
85+
* [nfdi_ing_workflow.py](nfdi_ing_workflow.py) Python functions
86+
* [workflow_nfdi.json](workflow_nfdi.json) Workflow definition in the Python Workflow Definition.
87+
88+
Additional source files provided with the workflow benchmark:
89+
* [source/envs/preprocessing.yaml](source/envs/preprocessing.yaml) Conda environment for preprocessing
90+
* [source/envs/processing.yaml](source/envs/processing.yaml) Conda environment for processing
91+
* [source/envs/postprocessing.yaml](source/envs/postprocessing.yaml) Conda environment for postprocessing
92+
* [source/macros.tex.template](source/macros.tex.template) LaTeX module template
93+
* [source/paper.tex](source/paper.tex) LaTeX paper template
94+
* [source/poisson.py](source/poisson.py) Poisson Python script
95+
* [source/postprocessing.py](source/postprocessing.py) Postprocessing Python script
96+
* [source/prepare_paper_macros.py](source/prepare_paper_macros.py) LaTeX preprocessing Python script
97+
* [source/unit_square.geo](source/unit_square.geo) Input structure
98+
99+
| Example | Explanation |
100+
|----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
101+
| [aiida_nfdi.ipynb](aiida_nfdi.ipynb) | Define Workflow with aiida and execute it with jobflow and pyiron_base. |
102+
| [jobflow_nfdi.ipynb](jobflow_nfdi.ipynb) | Define Workflow with jobflow and execute it with aiida and pyiron_base. |
103+
| [pyiron_base_nfdi.ipynb](pyiron_base_nfdi.ipynb) | Define Workflow with pyiron_base and execute it with aiida and jobflow. |
104+
| [universal_workflow_nfdi.ipynb](universal_workflow_nfdi.ipynb) | Execute workflow defined in the Python Workflow Definition with aiida, executorlib, jobflow, pyiron_base and pure Python. |

0 commit comments

Comments
 (0)