Skip to content

Commit a4db7b2

Browse files
committed
Deploying to gh-pages from @ cd022f5 🚀
1 parent fd1729f commit a4db7b2

File tree

10 files changed

+73
-49
lines changed

10 files changed

+73
-49
lines changed

README.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -403,25 +403,28 @@ <h3>Simple Example<a class="headerlink" href="#simple-example" title="Link to th
403403
</pre></div>
404404
</div>
405405
<p>These two Python functions are combined in the following example workflow:</p>
406-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tmp_dict</span> <span class="o">=</span> <span class="n">get_prod_and_div</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
407-
<span class="n">result</span> <span class="o">=</span> <span class="n">get_sum</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">tmp_dict</span><span class="p">[</span><span class="s2">&quot;prod&quot;</span><span class="p">],</span> <span class="n">y</span><span class="o">=</span><span class="n">tmp_dict</span><span class="p">[</span><span class="s2">&quot;div&quot;</span><span class="p">])</span>
406+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">combined_workflow</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
407+
<span class="n">tmp_dict</span> <span class="o">=</span> <span class="n">get_prod_and_div</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="n">y</span><span class="p">)</span>
408+
<span class="k">return</span> <span class="n">get_sum</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">tmp_dict</span><span class="p">[</span><span class="s2">&quot;prod&quot;</span><span class="p">],</span> <span class="n">y</span><span class="o">=</span><span class="n">tmp_dict</span><span class="p">[</span><span class="s2">&quot;div&quot;</span><span class="p">])</span>
408409
</pre></div>
409410
</div>
410411
<p>For the workflow representation of these Python functions the Python functions are stored in the <a class="reference download internal" download="" href="_downloads/d4b6ab1210e71ac0cfa700589f3eda0c/workflow.py"><span class="xref download myst">example_workflows/arithmetic/workflow.py</span></a>
411412
Python module. The connection of the Python functions are stored in the <a class="reference download internal" download="" href="_downloads/b85b54c725e4538522e7eabb629474c5/workflow.json"><span class="xref download myst">example_workflows/arithmetic/workflow.json</span></a>
412413
JSON file:</p>
413414
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
414415
<span class="s2">&quot;nodes&quot;</span><span class="p">:</span> <span class="p">[</span>
415-
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;function&quot;</span><span class="p">:</span> <span class="s2">&quot;simple_workflow.get_prod_and_div&quot;</span><span class="p">},</span>
416-
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;function&quot;</span><span class="p">:</span> <span class="s2">&quot;simple_workflow.get_sum&quot;</span><span class="p">},</span>
417-
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span>
418-
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span>
416+
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;function&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="s2">&quot;workflow.get_prod_and_div&quot;</span><span class="p">},</span>
417+
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;function&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="s2">&quot;workflow.get_sum&quot;</span><span class="p">},</span>
418+
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;input&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;x&quot;</span><span class="p">},</span>
419+
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;input&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">},</span>
420+
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;output&quot;</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;result&quot;</span><span class="p">}</span>
419421
<span class="p">],</span>
420422
<span class="s2">&quot;edges&quot;</span><span class="p">:</span> <span class="p">[</span>
421423
<span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;targetPort&quot;</span><span class="p">:</span> <span class="s2">&quot;x&quot;</span><span class="p">,</span> <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">},</span>
422424
<span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;targetPort&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">,</span> <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">},</span>
423425
<span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;targetPort&quot;</span><span class="p">:</span> <span class="s2">&quot;x&quot;</span><span class="p">,</span> <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="s2">&quot;prod&quot;</span><span class="p">},</span>
424-
<span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;targetPort&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">,</span> <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="s2">&quot;div&quot;</span><span class="p">}</span>
426+
<span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;targetPort&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">,</span> <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="s2">&quot;div&quot;</span><span class="p">},</span>
427+
<span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s2">&quot;targetPort&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">}</span>
425428
<span class="p">]</span>
426429
<span class="p">}</span>
427430
</pre></div>

_downloads/074c18a527b229dcf1aceecb3ceb2862/workflow.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@
3131
{"id": 28, "type": "input", "value": "strain_4", "name": "working_directory_5"},
3232
{"id": 29, "type": "function", "value": "python_workflow_definition.shared.get_dict"},
3333
{"id": 30, "type": "function", "value": "python_workflow_definition.shared.get_list"},
34-
{"id": 31, "type": "function", "value": "python_workflow_definition.shared.get_list"}
34+
{"id": 31, "type": "function", "value": "python_workflow_definition.shared.get_list"},
35+
{"id": 32, "type": "output", "name": "result"}
3536
],
3637
"edges": [
3738
{"target": 0, "targetPort": "element", "source": 9, "sourcePort": null},
@@ -92,6 +93,7 @@
9293
{"target": 31, "targetPort": "2", "source": 5, "sourcePort": "energy"},
9394
{"target": 31, "targetPort": "3", "source": 6, "sourcePort": "energy"},
9495
{"target": 31, "targetPort": "4", "source": 7, "sourcePort": "energy"},
95-
{"target": 8, "targetPort": "energy_lst", "source": 31, "sourcePort": null}
96+
{"target": 8, "targetPort": "energy_lst", "source": 31, "sourcePort": null},
97+
{"target": 32, "targetPort": null, "source": 8, "sourcePort": null}
9698
]
9799
}

_downloads/4fce43a14fb0221048f87bf1c5f7507a/workflow.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
{"id": 3, "type": "function", "value": "workflow.plot_over_line"},
77
{"id": 4, "type": "function", "value": "workflow.substitute_macros"},
88
{"id": 5, "type": "function", "value": "workflow.compile_paper"},
9-
{"id": 6, "type": "input", "value": 2.0, "name": "domain_size"}
9+
{"id": 6, "type": "input", "value": 2.0, "name": "domain_size"},
10+
{"id": 7, "type": "output", "name": "result"}
1011
],
1112
"edges": [
1213
{"target": 0, "targetPort": "domain_size", "source": 6, "sourcePort": null},
@@ -19,6 +20,7 @@
1920
{"target": 4, "targetPort": "ndofs", "source": 2, "sourcePort": "numdofs"},
2021
{"target": 4, "targetPort": "domain_size", "source": 6, "sourcePort": null},
2122
{"target": 5, "targetPort": "macros_tex", "source": 4, "sourcePort": null},
22-
{"target": 5, "targetPort": "plot_file", "source": 3, "sourcePort": null}
23+
{"target": 5, "targetPort": "plot_file", "source": 3, "sourcePort": null},
24+
{"target": 7, "targetPort": null, "source": 5, "sourcePort": null}
2325
]
2426
}

_downloads/b85b54c725e4538522e7eabb629474c5/workflow.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
{"id": 0, "type": "function", "value": "workflow.get_prod_and_div"},
44
{"id": 1, "type": "function", "value": "workflow.get_sum"},
55
{"id": 2, "type": "input", "value": 1, "name": "x"},
6-
{"id": 3, "type": "input", "value": 2, "name": "y"}
6+
{"id": 3, "type": "input", "value": 2, "name": "y"},
7+
{"id": 4, "type": "output", "name": "result"}
78
],
89
"edges": [
910
{"target": 0, "targetPort": "x", "source": 2, "sourcePort": null},
1011
{"target": 0, "targetPort": "y", "source": 3, "sourcePort": null},
1112
{"target": 1, "targetPort": "x", "source": 0, "sourcePort": "prod"},
12-
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"}
13+
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"},
14+
{"target": 4, "targetPort": null, "source": 1, "sourcePort": null}
1315
]
1416
}

_sources/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,28 @@ def get_prod_and_div(x: float, y: float) -> dict:
3434
```
3535
These two Python functions are combined in the following example workflow:
3636
```python
37-
tmp_dict = get_prod_and_div(x=1, y=2)
38-
result = get_sum(x=tmp_dict["prod"], y=tmp_dict["div"])
37+
def combined_workflow(x=1, y=2):
38+
tmp_dict = get_prod_and_div(x=x, y=y)
39+
return get_sum(x=tmp_dict["prod"], y=tmp_dict["div"])
3940
```
4041
For the workflow representation of these Python functions the Python functions are stored in the [example_workflows/arithmetic/workflow.py](example_workflows/arithmetic/workflow.py)
4142
Python module. The connection of the Python functions are stored in the [example_workflows/arithmetic/workflow.json](example_workflows/arithmetic/workflow.json)
4243
JSON file:
4344
```
4445
{
4546
"nodes": [
46-
{"id": 0, "function": "simple_workflow.get_prod_and_div"},
47-
{"id": 1, "function": "simple_workflow.get_sum"},
48-
{"id": 2, "value": 1},
49-
{"id": 3, "value": 2}
47+
{"id": 0, "type": "function", "value": "workflow.get_prod_and_div"},
48+
{"id": 1, "type": "function", "value": "workflow.get_sum"},
49+
{"id": 2, "type": "input", "value": 1, "name": "x"},
50+
{"id": 3, "type": "input", "value": 2, "name": "y"},
51+
{"id": 4, "type": "output", "name": "result"}
5052
],
5153
"edges": [
5254
{"target": 0, "targetPort": "x", "source": 2, "sourcePort": null},
5355
{"target": 0, "targetPort": "y", "source": 3, "sourcePort": null},
5456
{"target": 1, "targetPort": "x", "source": 0, "sourcePort": "prod"},
55-
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"}
57+
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"},
58+
{"target": 4, "targetPort": null, "source": 1, "sourcePort": null}
5659
]
5760
}
5861
```

_sources/arithmetic.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,28 @@ def get_prod_and_div(x: float, y: float) -> dict:
99
```
1010
These two Python functions are combined in the following example workflow:
1111
```python
12-
tmp_dict = get_prod_and_div(x=1, y=2)
13-
result = get_sum(x=tmp_dict["prod"], y=tmp_dict["div"])
12+
def combined_workflow(x=1, y=2):
13+
tmp_dict = get_prod_and_div(x=x, y=y)
14+
return get_sum(x=tmp_dict["prod"], y=tmp_dict["div"])
1415
```
1516
For the workflow representation of these Python functions the Python functions are stored in the [workflow.py](example_workflows/arithmetic/workflow.py)
1617
Python module. The connection of the Python functions are stored in the [workflow.json](example_workflows/arithmetic/workflow.json)
1718
JSON file:
1819
```
1920
{
2021
"nodes": [
21-
{"id": 0, "function": "workflow.get_prod_and_div"},
22-
{"id": 1, "function": "workflow.get_sum"},
23-
{"id": 2, "value": 1},
24-
{"id": 3, "value": 2}
22+
{"id": 0, "type": "function", "value": "workflow.get_prod_and_div"},
23+
{"id": 1, "type": "function", "value": "workflow.get_sum"},
24+
{"id": 2, "type": "input", "value": 1, "name": "x"},
25+
{"id": 3, "type": "input", "value": 2, "name": "y"},
26+
{"id": 4, "type": "output", "name": "result"}
2527
],
2628
"edges": [
2729
{"target": 0, "targetPort": "x", "source": 2, "sourcePort": null},
2830
{"target": 0, "targetPort": "y", "source": 3, "sourcePort": null},
2931
{"target": 1, "targetPort": "x", "source": 0, "sourcePort": "prod"},
30-
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"}
32+
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"},
33+
{"target": 4, "targetPort": null, "source": 1, "sourcePort": null}
3134
]
3235
}
3336
```

_sources/documentation/arithmetic.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,28 @@ def get_prod_and_div(x: float, y: float) -> dict:
99
```
1010
These two Python functions are combined in the following example workflow:
1111
```python
12-
tmp_dict = get_prod_and_div(x=1, y=2)
13-
result = get_sum(x=tmp_dict["prod"], y=tmp_dict["div"])
12+
def combined_workflow(x=1, y=2):
13+
tmp_dict = get_prod_and_div(x=x, y=y)
14+
return get_sum(x=tmp_dict["prod"], y=tmp_dict["div"])
1415
```
1516
For the workflow representation of these Python functions the Python functions are stored in the [workflow.py](example_workflows/arithmetic/workflow.py)
1617
Python module. The connection of the Python functions are stored in the [workflow.json](example_workflows/arithmetic/workflow.json)
1718
JSON file:
1819
```
1920
{
2021
"nodes": [
21-
{"id": 0, "function": "workflow.get_prod_and_div"},
22-
{"id": 1, "function": "workflow.get_sum"},
23-
{"id": 2, "value": 1},
24-
{"id": 3, "value": 2}
22+
{"id": 0, "type": "function", "value": "workflow.get_prod_and_div"},
23+
{"id": 1, "type": "function", "value": "workflow.get_sum"},
24+
{"id": 2, "type": "input", "value": 1, "name": "x"},
25+
{"id": 3, "type": "input", "value": 2, "name": "y"},
26+
{"id": 4, "type": "output", "name": "result"}
2527
],
2628
"edges": [
2729
{"target": 0, "targetPort": "x", "source": 2, "sourcePort": null},
2830
{"target": 0, "targetPort": "y", "source": 3, "sourcePort": null},
2931
{"target": 1, "targetPort": "x", "source": 0, "sourcePort": "prod"},
30-
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"}
32+
{"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"},
33+
{"target": 4, "targetPort": null, "source": 1, "sourcePort": null}
3134
]
3235
}
3336
```

0 commit comments

Comments
 (0)