ewoksweb |version|
==================
.. toctree::
:hidden:
tutorials
howtoguides
explanations
*ewoksweb* is a frontend to create, visualize and execute `ewoks `_ workflows in the web.
ewoksweb has been developed by the `Software group `_ of the `European Synchrotron `_.
The documentation is inspired by the `diataxis `_ approach.
Install locally
---------------
Install the `ewoksserver `_ python package which
is a bundle that contains the ewoksserver and the frontend which is ewoksweb.
.. code:: bash
pip install ewoksserver[frontend]
Start the server and open the frontend in a web browser
.. code:: bash
ewoks-server
The web app will be available at ``localhost:8000``.
.. note::
``ewoks-server`` takes the port 8000 by default. If there are other applications running on this port (e.g. iTunes radio on Mac), another port can be chosen
.. code:: bash
ewoks-server --port 6660
Also by default, ``ewoks-server`` will save ewoks resources (workflows, tasks, icons) in the current folder. This can be changed through the ``--dir`` command line argument
.. code:: bash
ewoks-server --dir /path/to/ewoksserver/resources
Tutorials
---------
Follow the learning-oriented tutorials that will help accomplish a sequense of steps in order to:
.. toctree::
:maxdepth: 1
tutorials/create_your_first_workflow
tutorials/create_a_task
How-to guides
-------------
The how-to guides are descriptions targeting the following tasks:
.. toctree::
:maxdepth: 1
howtoguides/new_open_save
howtoguides/executing_a_workflow
howtoguides/monitoring_executed_workflows
Explanations
------------
General useful information regarding:
.. toctree::
:maxdepth: 1
explanations/editor_basics
explanations/embedded_nodes
explanations/link_validation
explanations/node_editing
explanations/link_editing
Binding documentation:
----------------------
* `ewokscore `_ : create workflows and implement tasks
* `ewoksorange `_ : create and execute workflows with a desktop GUI
* `ewoksppf `_ : execute cyclic workflows
* `ewoksdask `_ : parallelize workflow execution
* `ewoksjob `_: distribute workflow execution
* `ewoksserver `_: REST server to manage and execute workflows
* `ewoksweb `_: web frontend to create, visualize and execute workflows
* `ewoksutils `_ : developer utilities