Skip to content

Subworkflows: Structured Representation

The JSON structured representation of subworkflows, together with an example, is contained below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
    "$id": "workflow/subworkflow",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Subworkflow",
    "type": "object",
    "allOf": [
        {
            "$ref": "base_flow.json"
        }
    ],
    "properties": {
        "units": {
            "description": "Contains the Units of the subworkflow",
            "type": "array",
            "items": {
                "$ref": "./subworkflow/unit.json"
            }
        },
        "model": {
            "description": "Model used inside the subworkflow",
            "$ref": "../model.json"
        },
        "application": {
            "description": "information about the simulation engine/application.",
            "$ref": "../software/application.json"
        },
        "isDraft": {
            "description": "Defines whether to store the results/properties extracted in this unit to properties collection",
            "type": "boolean",
            "default": false
        }
    },
    "required": [
        "model",
        "application"
    ]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
    "_id": "LCthJ6E2QabYCZqf4",
    "application": {
        "...": "include(../software/application.json)"
    },
    "model": {
        "...": "include(../model.json)"
    },
    "name": "Band Structure",
    "properties": [
        "band_structure"
    ],
    "units": [
        {
            "...": "include(unit/execution.json)"
        }
    ]
}