Skip to content

Commit aef0dca

Browse files
author
Jorge Ejarque
committed
improve the README description
1 parent 02fbbbf commit aef0dca

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# workflow-registry
2-
Registry to store workflow descriptions
1+
#Workflow Registry
2+
3+
This is a repository to store the Workflow descriptions using the eFlows4HPC methodology. This description consist of at least the TOSCA description of the worklfow, the code of the their different steps and their required software per step.
4+
5+
6+
## Repository structure
7+
8+
Workflow descriptions have to be included inside this repository according to the following structure.
9+
10+
```
11+
workflow-registry
12+
|- workflow_1
13+
| |- tosca
14+
| | |- types.yml TOSCA description of the different components involved in the workflow
15+
| | ...
16+
| |- step_1
17+
| | |- spack.yml Sofware requirements as a Spack environment specification
18+
| | |- src PyCOMPSs code of the workflow step
19+
| | ...
20+
| |- software_2
21+
| ....
22+
|- workflow_2
23+
| ...
24+
25+
```
26+
27+
## Including new Workflows
28+
29+
To include new workflows in the repository, first create a new fork of the repository and include a new folder for the workflow with a subfolder for the TOSCA description and the different workflow steps. Finally, create a pull request with the new workflow description. This pull request will be reviewed and included in the repository.
30+

0 commit comments

Comments
 (0)