-
Notifications
You must be signed in to change notification settings - Fork 1
doc: migrate getting started from ewoks.esrf.fr #321
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I replaced the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,113 @@ | ||
| Getting started | ||
| =============== | ||
|
|
||
| Install *ewoks* | ||
| Install the Ewoks core libraries suite using ``pip``: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| pip install ewoks | ||
| pip install ewoks | ||
|
|
||
| Create a test workflow in JSON format (“acyclic1” is an test workflow that ships with ewoks) | ||
| This will include all core tools and example workflows. | ||
|
|
||
| Run an Example Workflow | ||
| ----------------------- | ||
|
|
||
| The ``ewoks`` package includes several demo workflows. To run the ``demo`` workflow from the command line: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| ewoks convert acyclic1 --test test.json | ||
| ewoks execute demo -p a=10 -p b=3 --test --outputs=all | ||
|
|
||
| - ``-p a=10 -p b=3``: Set input parameters | ||
| - ``--test``: Load the ``demo`` workflow from Ewoks test suite | ||
| - ``--outputs=all``: Print outputs of all workflow nodes | ||
|
|
||
| Inspect workflow parameters before executing the workflow | ||
| For full CLI options, run: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| ewoks show test.json | ||
| ewoks execute -h | ||
|
|
||
| Execute a workflow and print the output of all tasks | ||
| Or refer to the `Command-line reference <../reference/cli.html>`_. | ||
|
|
||
| .. code-block:: bash | ||
| Inspect Workflow Parameters | ||
| ---------------------------- | ||
|
|
||
| Before executing a workflow, you can inspect its parameters using: | ||
|
|
||
| ewoks execute test.json --outputs all | ||
| .. code-block:: bash | ||
|
|
||
| For a desktop GUI, install *ewoks* with the orange binding | ||
| ewoks show demo -p a=10 -p b=3 --test | ||
|
|
||
| Example output: | ||
|
|
||
| .. code-block:: text | ||
|
|
||
| Workflow: demo | ||
| Id: demo | ||
| Description: demo | ||
| ╒════════╤════════════════╤═══════════════════╤═══════╕ | ||
| │ Name │ Value │ Task identifier │ Id │ | ||
| ╞════════╪════════════════╪═══════════════════╪═══════╡ | ||
| │ list │ [0, 1, 2] │ SumList │ task0 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumList │ task0 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ b │ <MISSING_DATA> │ SumTask │ task1 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumTask │ task1 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ a │ 10 │ SumTask │ task2 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ b │ 3 │ SumTask │ task2 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumTask │ task2 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ b │ 3 │ SumTask │ task3 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumTask │ task3 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ b │ 4 │ SumTask │ task4 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumTask │ task4 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumTask │ task5 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ b │ 6 │ SumTask │ task6 │ | ||
| ├────────┼────────────────┼───────────────────┼───────┤ | ||
| │ delay │ 0 │ SumTask │ task6 │ | ||
| ╘════════╧════════════════╧═══════════════════╧═══════╛ | ||
|
|
||
| Convert Workflow Format | ||
| ----------------------- | ||
|
|
||
| To inspect or modify a workflow, convert it to a JSON file: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| pip install ewoks[orange] | ||
| ewoks convert demo demo.json --test | ||
|
|
||
| Open the test workflow in the GUI | ||
| Learn More | ||
| ========== | ||
|
|
||
| .. code-block:: bash | ||
| .. note:: | ||
|
|
||
| ewoks execute test.json --engine orange | ||
| **To go further** | ||
|
|
||
| For a web GUI, install *ewoksserver* with the frontend | ||
| - **Create workflows in Python** | ||
|
|
||
| .. code-block:: bash | ||
| See the `Hello World example <./hello_world.html>`_ | ||
|
|
||
| pip install ewoksserver[frontend] | ||
| - **Use graphical interfaces** | ||
|
|
||
| Start the *ewoks* web server, open the link in a web browser and load the `test.json` file | ||
| Explore the `GUI creation tools <../howtoguides/gui.html>`_ | ||
|
|
||
| .. code-block:: bash | ||
| - **Need specific guidance?** | ||
|
|
||
| Check the `How-to guides <../howtoguides.html>`_ | ||
|
|
||
| - **Learn Ewoks step-by-step** | ||
|
|
||
| The `Ewoks tutorial for developers <https://ewoksfordevs.readthedocs.io>`_ introduces all core concepts: workflows, tasks, and Ewoks tools. | ||
|
|
||
| ewoks-server | ||
|
woutdenolf marked this conversation as resolved.
|
||
| ℹ️ *This tutorial is regularly updated and used in ESRF training sessions.* | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reworked this slightly to include the text from https://ewoks.esrf.fr/en/latest/getting_started.html#what-is-ewoks