| Name | pyironflow JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | react xyflow for pyiron |
| upload_time | 2025-01-09 17:26:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | BSD 3-Clause License Copyright (c) 2018, Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
pyiron
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyironFlow
# Visual Programming Interface
The visual programmming interface `pyironflow` or `PyironFlow` is a gui skin based on [ReactFlow](https://reactflow.dev/) that currently works on top of `pyiron_workflow`. Theoretically, one could currently pack `pyiron_base` jobs into nodes for execution. The gui could also be extended to pack the workflow graph (extracted from the gui using `get_workflow()`) into a `pyiron_base` job for execution. An existing code-based workflow graph can be packed into the gui using `PyironFlow([wf])` where wf is the existing graph.
## Installation
`conda install -c conda-forge pyironflow`
Recommended to be used with JupyterLab: `conda install -c conda-forge jupyterlab`
## Example of a multiscale simulation
### Problem definition:
### Constructing the workflow:
### Execution:
### Viewing source code:
### Visualization of FEM meshes using PyVista:
### Atomistic sub-workflow:
### Continuum sub-workflow:
## Planned/desired/in-development features
- Dynamically add nodes from the notebook to the node library (currently being polished by Julius Mittler)
- Dynamically make macros from the gui using a box selection and add them to the node library (currently in development by Julius Mittler)
- Automatic positioning of nodes in a nice way on (re-)instantiation (current positioning is passable, but room for improvement exists)
- Caching based on a hash-based storage. Currently caching does not work at all in the gui since the workflow graph is reinstantiated everytime there's a change in the gui. This could be theoretically fixed by comparing the dictionary of the existing workflow to the new dictionary from the gui. But this would be a painstaking process and easily broken. A better way would be to work with a hash-based storage which would reload outputs when the inputs of a node have not changed. However this would have to be implemented in `pyiron_workflow` and not in the gui side of things.
- Edit the source code of nodes from within the gui. Maybe something that uses the [FileReader](https://stackoverflow.com/questions/51272255/how-to-use-filereader-in-react) api. Need to look into this further.
See the demo.ipynb jupyter notebook for brief discussion of the key ideas, the link to pyiron_workflows and a few toy application of the xyflow project.
[](https://mybinder.org/v2/gh/pyiron/pyironFlow/HEAD?labpath=pyironflow_demo.ipynb)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyironflow",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "pyiron",
"author": null,
"author_email": "\"Max-Planck-Institut f\u00fcr Eisenforschung GmbH - Computational Materials Design (CM) Department\" <pyiron@mpie.de>",
"download_url": "https://files.pythonhosted.org/packages/37/68/0b048e008a1c60f780647e89a4dce75b81b60df5f94b77907de1caf9b3c4/pyironflow-0.0.8.tar.gz",
"platform": null,
"description": "# pyironFlow\n\n# Visual Programming Interface\nThe visual programmming interface `pyironflow` or `PyironFlow` is a gui skin based on [ReactFlow](https://reactflow.dev/) that currently works on top of `pyiron_workflow`. Theoretically, one could currently pack `pyiron_base` jobs into nodes for execution. The gui could also be extended to pack the workflow graph (extracted from the gui using `get_workflow()`) into a `pyiron_base` job for execution. An existing code-based workflow graph can be packed into the gui using `PyironFlow([wf])` where wf is the existing graph.\n\n## Installation\n\n`conda install -c conda-forge pyironflow`\n\nRecommended to be used with JupyterLab: `conda install -c conda-forge jupyterlab`\n\n## Example of a multiscale simulation\n\n### Problem definition:\n\n\n### Constructing the workflow:\n\n\n### Execution:\n\n\n### Viewing source code:\n\n\n### Visualization of FEM meshes using PyVista:\n\n\n### Atomistic sub-workflow:\n\n\n### Continuum sub-workflow:\n\n\n## Planned/desired/in-development features\n\n- Dynamically add nodes from the notebook to the node library (currently being polished by Julius Mittler)\n- Dynamically make macros from the gui using a box selection and add them to the node library (currently in development by Julius Mittler)\n- Automatic positioning of nodes in a nice way on (re-)instantiation (current positioning is passable, but room for improvement exists)\n- Caching based on a hash-based storage. Currently caching does not work at all in the gui since the workflow graph is reinstantiated everytime there's a change in the gui. This could be theoretically fixed by comparing the dictionary of the existing workflow to the new dictionary from the gui. But this would be a painstaking process and easily broken. A better way would be to work with a hash-based storage which would reload outputs when the inputs of a node have not changed. However this would have to be implemented in `pyiron_workflow` and not in the gui side of things.\n- Edit the source code of nodes from within the gui. Maybe something that uses the [FileReader](https://stackoverflow.com/questions/51272255/how-to-use-filereader-in-react) api. Need to look into this further.\n\nSee the demo.ipynb jupyter notebook for brief discussion of the key ideas, the link to pyiron_workflows and a few toy application of the xyflow project.\n\n[](https://mybinder.org/v2/gh/pyiron/pyironFlow/HEAD?labpath=pyironflow_demo.ipynb)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2018, Max-Planck-Institut f\u00fcr Eisenforschung GmbH - Computational Materials Design (CM) Department All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "react xyflow for pyiron",
"version": "0.0.8",
"project_urls": {
"Documentation": "https://github.com/pyiron/pyironFlow",
"Homepage": "https://github.com/pyiron/pyironFlow",
"Repository": "https://github.com/pyiron/pyironFlow"
},
"split_keywords": [
"pyiron"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9df5b8fa18dd0883b866f30d919cc1c58a67f12b91d962d9a900eb945c1e738",
"md5": "5b16e2e10cc8027dc2a72e649d087b8a",
"sha256": "5d3129f7d77a3558b1aad271378a64442f6f3f9f65510281f596f2f194a1464c"
},
"downloads": -1,
"filename": "pyironflow-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b16e2e10cc8027dc2a72e649d087b8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 21110,
"upload_time": "2025-01-09T17:25:58",
"upload_time_iso_8601": "2025-01-09T17:25:58.760440Z",
"url": "https://files.pythonhosted.org/packages/a9/df/5b8fa18dd0883b866f30d919cc1c58a67f12b91d962d9a900eb945c1e738/pyironflow-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37680b048e008a1c60f780647e89a4dce75b81b60df5f94b77907de1caf9b3c4",
"md5": "4dd7b4243c9b6b7c5a1e54cfe308c227",
"sha256": "b6b46fd20a43023564cddc6da2f343e6e6eddd73adaabd53e8599882e798881c"
},
"downloads": -1,
"filename": "pyironflow-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "4dd7b4243c9b6b7c5a1e54cfe308c227",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 22803,
"upload_time": "2025-01-09T17:26:02",
"upload_time_iso_8601": "2025-01-09T17:26:02.229038Z",
"url": "https://files.pythonhosted.org/packages/37/68/0b048e008a1c60f780647e89a4dce75b81b60df5f94b77907de1caf9b3c4/pyironflow-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 17:26:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyiron",
"github_project": "pyironFlow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyironflow"
}
