Skip to content

Commit

Permalink
fix rst formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ikondov authored Jun 7, 2024
1 parent d6abee8 commit 13f37ff
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs_rst/quickstart_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,30 @@ Two-minute installation, setup and quickstart
Install and setup
=================

Supposed you have a :doc:`virtual environment </virtualenv_tutorial>` with the `pip`` package installed. Then simply type:
Supposed you have a :doc:`virtual environment </virtualenv_tutorial>` with the `pip`` package installed. Then simply type::

pip install fireworks[mongomock]
mkdir -p ~/.fireworks
echo MONGOMOCK_SERVERSTORE_FILE: $HOME/.fireworks/mongomock.json > ~/.fireworks/FW_config.yaml
echo '{}' > ~/.fireworks/mongomock.json
lpad reset --password="$(date +%Y-%m-%d)"

See that the database contains no workflows:
See that the database contains no workflows::

lpad get_wflows

*Output*::

[]


Add and display a workflow
==========================

Add a script that prints the date as a single firework in a workflow:
Add a script that prints the date as a single firework in a workflow::

lpad add_scripts 'date' -n date_printer_firework -w date_printer_workflow

Let us display the workflow just added:
Let us display the workflow just added::

lpad get_wflows -d more

Expand All @@ -53,7 +52,7 @@ We have only one workflow with only one firework on the database.
Run a workflow
==============

Now we can run the firework in our workflow locally with this simple command:
Now we can run the firework in our workflow locally with this simple command::

rlaunch singleshot

Expand All @@ -73,4 +72,4 @@ This setup uses a JSON file on the local computer as a database instead of Mongo
and do local testing by using this setting.

If you want to complete the more advanced tutorials, such as the :doc:`queue tutorial </queue_tutorial>`, or use FireWorks productively on
a computing cluster, then you should consider :doc:`installing and setting up FireWorks </installation>` with a MongoDB server.
a computing cluster, then you should consider :doc:`installing and setting up FireWorks </installation>` with a MongoDB server.

0 comments on commit 13f37ff

Please sign in to comment.