diff --git a/README.md b/README.md index 24ffc97a..fe918e9b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Efficiently design and manage flexible workflows with AiiDA, featuring an intera ## Installation ```console - pip install aiida-workgraph aiida-workgraph-web-ui + pip install aiida-workgraph ``` To install the latest version from source, first clone the repository and then install using `pip`: @@ -63,9 +63,14 @@ load_profile() wg.submit(inputs = {"add1": {"x": 2, "y": 3}, "multiply1": {"y": 4}}, wait=True) print("Result of multiply1 is", wg.tasks["multiply1"].outputs[0].value) ``` - -Start the web app, open a terminal and run: +## Web ui +To use the web ui, first install the web ui package: +```console +pip install aiida-workgraph-web-ui +``` +Then, start the web app with the following command: ```console + workgraph web start ``` diff --git a/docs/gallery/autogen/quick_start.py b/docs/gallery/autogen/quick_start.py index b693d9b4..ad41ad1f 100644 --- a/docs/gallery/autogen/quick_start.py +++ b/docs/gallery/autogen/quick_start.py @@ -436,7 +436,13 @@ def add_multiply(x, y, z): # ~~~~~~~~~~~~~~~~~~~~ # # WorkGraph also provides a web GUI, where you can view and manage the -# workgraph. Open a terminal, and run: +# workgraph. To use the web ui, first install the web ui package: +# +# :: +# +# pip install aiida-workgraph-web-ui +# +# Open a terminal, and run: # # :: # diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 224ffe48..e4a404f3 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -26,6 +26,8 @@ The recommended method of installation is to use the Python package manager |pip .. code-block:: console $ pip install aiida-workgraph + $ # install web ui package if you want to use the web ui + $ pip install aiida-workgraph-web-ui This will install the latest stable version that was released to PyPI. diff --git a/src/aiida_workgraph/__init__.py b/src/aiida_workgraph/__init__.py index 8331aa4e..943b7210 100644 --- a/src/aiida_workgraph/__init__.py +++ b/src/aiida_workgraph/__init__.py @@ -2,6 +2,6 @@ from .task import Task from .decorator import task, build_task -__version__ = "0.4.6" +__version__ = "0.4.7" __all__ = ["WorkGraph", "Task", "task", "build_task"]