Deploying to gh-pages from @ 4eb1108 🚀

Author: jan-janssen

README.html

@@ -384,41 +384,32 @@ <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">
 <h3>Simple Example<a class="headerlink" href="#simple-example" title="Link to this heading">#</a></h3>
 <p>As a first example we define two Python functions which add multiple inputs:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">add_x_and_y</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
-    <span class="n">z</span> <span class="o">=</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>
-    <span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span>
-
-<span class="k">def</span><span class="w"> </span><span class="nf">add_x_and_y_and_z</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="p">):</span>
-    <span class="n">w</span> <span class="o">=</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span> <span class="o">+</span> <span class="n">z</span>
-    <span class="k">return</span> <span class="n">w</span>
+    <span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>
+    
+<span class="k">def</span><span class="w"> </span><span class="nf">get_prod_and_div</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">y</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
+    <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;prod&quot;</span><span class="p">:</span> <span class="n">x</span> <span class="o">*</span> <span class="n">y</span><span class="p">,</span> <span class="s2">&quot;div&quot;</span><span class="p">:</span> <span class="n">x</span> <span class="o">/</span> <span class="n">y</span><span class="p">}</span>
 </pre></div>
 </div>
 <p>These two Python functions are combined in the following example workflow:</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span> <span class="o">=</span> <span class="n">add_x_and_y</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>
-<span class="n">w</span> <span class="o">=</span> <span class="n">add_x_and_y_and_z</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> <span class="n">z</span><span class="o">=</span><span class="n">z</span><span class="p">)</span>
+<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>
+<span class="n">result</span> <span class="o">=</span> <span class="n">add_x_and_y</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>
 </pre></div>
 </div>
 <p>For the workflow representation of these Python functions the Python functions are stored in the <a class="reference download internal" download="" href="_downloads/2733b71b8b860a0550ebcfb326aabf3a/simple_workflow.py"><span class="xref download myst">simple_workflow.py</span></a>
 Python module. The connection of the Python functions are stored in the <a class="reference download internal" download="" href="_downloads/ccde96f4155d5d9b945f1f0b662ed925/workflow_simple.json"><span class="xref download myst">workflow_simple.json</span></a>
 JSON file:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
   <span class="s2">&quot;nodes&quot;</span><span class="p">:</span> <span class="p">[</span>
-    <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.add_x_and_y_and_z&quot;</span><span class="p">},</span>
+    <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>
     <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.add_x_and_y&quot;</span><span class="p">},</span>
-    <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;function&quot;</span><span class="p">:</span> <span class="s2">&quot;simple_workflow.add_x_and_y&quot;</span><span class="p">},</span>
-    <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;function&quot;</span><span class="p">:</span> <span class="s2">&quot;simple_workflow.add_x_and_y&quot;</span><span class="p">},</span>
-    <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;value&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span>
-    <span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">5</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="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>
+    <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>
   <span class="p">],</span>
   <span class="s2">&quot;edges&quot;</span><span class="p">:</span> <span class="p">[</span>
-    <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">1</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="s2">&quot;x&quot;</span><span class="p">},</span>
-    <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">4</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>
-    <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">5</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>
-    <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">2</span><span class="p">,</span> <span class="s2">&quot;sourcePort&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">},</span>
-    <span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">2</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">4</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>
-    <span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">2</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">5</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>
-    <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;z&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="s2">&quot;z&quot;</span><span class="p">},</span>
-    <span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">3</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">4</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>
-    <span class="p">{</span><span class="s2">&quot;target&quot;</span><span class="p">:</span> <span class="mi">3</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">5</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>
+    <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>
+    <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>
+    <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>
+    <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>
   <span class="p">]</span>
 <span class="p">}</span>
 </pre></div>

_downloads/2733b71b8b860a0550ebcfb326aabf3a/simple_workflow.py

@@ -1,8 +1,7 @@
-def add_x_and_y(x, y):
-    z = x + y
-    return {"x": x, "y": y, "z": z}
+def get_prod_and_div(x, y):
+    return {"prod": x * y, "div": x / y}
 
 
-def add_x_and_y_and_z(x, y, z):
-    w = x + y + z
+def add_x_and_y(x, y):
+    w = x + y
     return w

_downloads/ccde96f4155d5d9b945f1f0b662ed925/workflow_simple.json

@@ -1,15 +1,14 @@
 {
   "nodes": [
-    {"id": 0, "function": "simple_workflow.add_x_and_y"},
-    {"id": 1, "function": "simple_workflow.add_x_and_y_and_z"},
+    {"id": 0, "function": "simple_workflow.get_prod_and_div"},
+    {"id": 1, "function": "simple_workflow.add_x_and_y"},
     {"id": 2, "value": 1},
     {"id": 3, "value": 2}
   ],
   "edges": [
     {"target": 0, "targetPort": "x", "source": 2, "sourcePort": null},
     {"target": 0, "targetPort": "y", "source": 3, "sourcePort": null},
-    {"target": 1, "targetPort": "x", "source": 0, "sourcePort": "x"},
-    {"target": 1, "targetPort": "y", "source": 0, "sourcePort": "y"},
-    {"target": 1, "targetPort": "z", "source": 0, "sourcePort": "z"}
+    {"target": 1, "targetPort": "x", "source": 0, "sourcePort": "prod"},
+    {"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"}
   ]
 }

_sources/README.md

@@ -17,41 +17,32 @@ different workflow engines to enable interoperability.
 As a first example we define two Python functions which add multiple inputs: 
 ```python
 def add_x_and_y(x, y):
-    z = x + y
-    return x, y, z
-
-def add_x_and_y_and_z(x, y, z):
-    w = x + y + z
-    return w
+    return x + y
+    
+def get_prod_and_div(x: float, y: float) -> dict:
+    return {"prod": x * y, "div": x / y}
 ```
 These two Python functions are combined in the following example workflow:
 ```python
-x, y, z = add_x_and_y(x=1, y=2)
-w = add_x_and_y_and_z(x=x, y=y, z=z)
+tmp_dict = get_prod_and_div(x=1, y=2)
+result = add_x_and_y(x=tmp_dict["prod"], y=tmp_dict["div"])
 ```
 For the workflow representation of these Python functions the Python functions are stored in the [simple_workflow.py](simple_workflow.py)
 Python module. The connection of the Python functions are stored in the [workflow_simple.json](workflow_simple.json) 
 JSON file:
 ```
 {
   "nodes": [
-    {"id": 0, "function": "simple_workflow.add_x_and_y_and_z"},
+    {"id": 0, "function": "simple_workflow.get_prod_and_div"},
     {"id": 1, "function": "simple_workflow.add_x_and_y"},
-    {"id": 2, "function": "simple_workflow.add_x_and_y"},
-    {"id": 3, "function": "simple_workflow.add_x_and_y"},
-    {"id": 4, "value": 1},
-    {"id": 5, "value": 2}
+    {"id": 2, "value": 1},
+    {"id": 3, "value": 2}
   ],
   "edges": [
-    {"target": 0, "targetPort": "x", "source": 1, "sourcePort": "x"},
-    {"target": 1, "targetPort": "x", "source": 4, "sourcePort": null},
-    {"target": 1, "targetPort": "y", "source": 5, "sourcePort": null},
-    {"target": 0, "targetPort": "y", "source": 2, "sourcePort": "y"},
-    {"target": 2, "targetPort": "x", "source": 4, "sourcePort": null},
-    {"target": 2, "targetPort": "y", "source": 5, "sourcePort": null},
-    {"target": 0, "targetPort": "z", "source": 3, "sourcePort": "z"},
-    {"target": 3, "targetPort": "x", "source": 4, "sourcePort": null},
-    {"target": 3, "targetPort": "y", "source": 5, "sourcePort": null}
+    {"target": 0, "targetPort": "x", "source": 2, "sourcePort": null},
+    {"target": 0, "targetPort": "y", "source": 3, "sourcePort": null},
+    {"target": 1, "targetPort": "x", "source": 0, "sourcePort": "prod"},
+    {"target": 1, "targetPort": "y", "source": 0, "sourcePort": "div"}
   ]
 }
 ```