Metadata-Version: 2.4
Name: aiida-workgraph-web-ui
Version: 0.1.3
Summary: Design flexible node-based workflow for AiiDA calculation.
Keywords: aiida,workflows
Author-email: Xing Wang <xingwang1991@gmail.com>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Development Status :: 1 - Planning
Classifier: Framework :: AiiDA
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
License-File: LICENSE
Requires-Dist: numpy~=1.21
Requires-Dist: scipy
Requires-Dist: aiida-core>=2.3
Requires-Dist: aiida_workgraph
Requires-Dist: cloudpickle
Requires-Dist: fastapi
Requires-Dist: uvicorn
Requires-Dist: pydantic_settings
Requires-Dist: sphinx_rtd_theme ; extra == "docs"
Requires-Dist: sphinx~=7.2 ; extra == "docs"
Requires-Dist: sphinx-copybutton~=0.5.0 ; extra == "docs"
Requires-Dist: sphinx-design~=0.5.0 ; extra == "docs"
Requires-Dist: sphinx-notfound-page~=1.0 ; extra == "docs"
Requires-Dist: sphinxext-rediraffe~=0.2.4 ; extra == "docs"
Requires-Dist: sphinx-intl~=2.1.0 ; extra == "docs"
Requires-Dist: sphinx-gallery ; extra == "docs"
Requires-Dist: myst-nb~=1.0.0 ; extra == "docs"
Requires-Dist: nbsphinx ; extra == "docs"
Requires-Dist: pre-commit~=2.2 ; extra == "pre-commit"
Requires-Dist: pylint~=2.17.4 ; extra == "pre-commit"
Requires-Dist: pgtest~=1.3 ; extra == "tests"
Requires-Dist: pytest~=7.0 ; extra == "tests"
Requires-Dist: pytest-cov~=2.7,<2.11 ; extra == "tests"
Requires-Dist: playwright ; extra == "tests"
Requires-Dist: httpx ; extra == "tests"
Project-URL: Documentation, https://aiida-workgraph-web-ui.readthedocs.io
Project-URL: Source, https://github.com/aiidateam/aiida-workgraph-web-ui
Provides-Extra: docs
Provides-Extra: pre-commit
Provides-Extra: tests

# Welcome to AiiDA WorkGraph Web UI!
[![PyPI version](https://badge.fury.io/py/aiida-workgraph-web-ui.svg)](https://badge.fury.io/py/aiida-workgraph-web-ui)
[![Docs status](https://readthedocs.org/projects/aiida-workgraph-web-ui/badge)](http://aiida-workgraph-web-ui.readthedocs.io/)
[![Unit test](https://github.com/aiidateam/aiida-workgraph-web-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/aiidateam/aiida-workgraph-web-ui/actions/workflows/ci.yml)


Web UI to visualize and manage the AiiDA WorkGraph.

## Frontend
Use `rete-kit` to create the frontend, using `react`

```console
npm i -g rete-kit
rete-kit frontend
```
### Run
```console
npm start
```

### Build
Build frontend application so that it generates static files (HTML, CSS, JavaScript, etc.).
```console
npm run build
```
This typically creates a build directory with all the static files needed to deploy the frontend.

### Include Frontend Build in the Package
Now, ensure these static files are included in the Python package. The [tool.setuptools.package_data] in the pyproject.toml should be set to include these files.

```toml
[tool.setuptools.package_data]
your_package_name = ["path/to/frontend/build/*"]
```

## Backend
Use `FastAPI`

The documentation page is `http://localhost:8000/docs`.

