Metadata-Version: 2.4
Name: pyironflow
Version: 0.1.4
Summary: react xyflow for pyiron
Project-URL: Homepage, https://github.com/pyiron/pyironFlow
Project-URL: Documentation, https://github.com/pyiron/pyironFlow
Project-URL: Repository, https://github.com/pyiron/pyironFlow
Author-email: "Max-Planck-Institut für Nachhaltige Materialien GmbH - Computational Materials Design (CM) Department" <pyiron@mpie.de>
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.
License-File: LICENSE
Keywords: pyiron
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.15,>=3.11
Requires-Dist: anywidget==0.9.18
Requires-Dist: bagofholding<0.2.0,>=0.1.14
Requires-Dist: flowrep<0.7.0,>=0.6.7
Requires-Dist: ipykernel<7.5.0,>=7.3.0
Requires-Dist: ipython<9.17.0,>=9.16.1
Requires-Dist: ipytree==0.2.2
Requires-Dist: ipywidgets<8.2.0,>=8.1.8
Requires-Dist: pyiron-workflow<0.21.0,>=0.20.3
Requires-Dist: traitlets<5.15.0,>=5.14.3
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: watchfiles; extra == 'dev'
Description-Content-Type: text/markdown

# pyironFlow

[![Push-Pull](https://github.com/pyiron/pyironflow/actions/workflows/push-pull.yml/badge.svg)](https://github.com/pyiron/pyironflow/actions/workflows/push-pull.yml)
[![Coverage](https://codecov.io/gh/pyiron/pyironflow/graph/badge.svg)](https://codecov.io/gh/pyiron/pyironflow)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyiron/pyironFlow/HEAD?labpath=minimal_demo.ipynb)

The visual programming interface `pyironflow.PyironFlow` is a GUI skin based on [ReactFlow](https://reactflow.dev/) that works on top of `pyiron_workflow` with `flowrep` data formats. 

To get running, open up a Jupyter notebook and 

```python
import pyironflow

pf = pyironflow.PyironFlow()
pf.gui

```

Or pre-populate the GUI with a workflow you've already written:

```python
import flowrep as fr
import pyiron_workflow as pwf

import pyironflow

@fr.atomic
def hello(name: str = "world") -> str:
    return f"Hello, {name}"

wf = pwf.Workflow("hello_world")
wf.hi = pwf.node(hello)

pf = pyironflow.PyironFlow([wf])
pf.gui

```

![hello_world](_static/hello_world.png)

The [user guide](https://github.com/pyiron/pyironFlow/blob/main/docs/user_guide.md) outlines available capabilities.

## Installation

A package of `pyironflow` is available on PyPI and [conda-forge](https://anaconda.org/conda-forge/pyironflow). This can be installed using:
```
conda install -c conda-forge pyironflow   # recommended
pip install pyironflow                    # also available from PyPI
```

The `pyironflow` gui is intended to be used inside a Jupyter notebook, was additionally recommend installing [jupyterlab](https://anaconda.org/conda-forge/jupyterlab):
```
conda install -c conda-forge jupyterlab
```
