Skip to content

Commit 4f9acaf

Browse files
authored
Enhance README with visual programming details
Expanded the README to include motivation and benefits of using visual programming environments with the Python Workflow Definition.
1 parent cf61a02 commit 4f9acaf

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,20 @@
33

44
![screenshot](arithmetic/screenshot.png)
55

6-
Load the [Python Workflow Definition](https://pythonworkflow.github.io) with the visual programming environment [pyironflow](https://github.com/pyiron/pyironflow).
6+
Load the [Python Workflow Definition](https://pythonworkflow.github.io) with the visual programming environment [pyironflow](https://github.com/pyiron/pyironflow):
77

88
```python
99
from pyironflow import PyironFlow
1010
from python_workflow_definition.pyiron_workflow import load_workflow_json
1111

1212
PyironFlow([load_workflow_json(file_name="workflow.json")]).gui
1313
```
14+
15+
The main motivation for supporting visual programming environments with the Python Workflow Definition is that they simplify the discussion of workflows.
16+
When we introduce a new workflow, we commonly illustrate it as data flow diagram. A visual programming environment allows you to:
17+
18+
- Browse through the workflow and zoom in on individual parts to analyze which data is transferred between the different steps.
19+
- Furthermore, a visual programming environment enables debugging the data flow, by allowing the user to execute individual steps, or the workflow up to a specific step and print the data at a given step.
20+
- Finally, for technically less inclined users a visual programming environment provides the ability to use workflow developed by experts. This accelerates the knowledge transfer between different user groups.
21+
22+
In conclusion the visual programming approach provides an alternative perspective to working with the Python Workflow Definition.

0 commit comments

Comments
 (0)