Skip to content

Commit

Permalink
docs: added some notes about better usage of omicron-process
Browse files Browse the repository at this point in the history
  • Loading branch information
duncanmmacleod committed Mar 22, 2017
1 parent 3aab39c commit 922f210
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/workflow/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,25 @@ where ``<config-file>`` is the name of your configuration file, and ``<group>``
To generate the workflow but *not* submit the DAG, add the ``--no-submit``
option on the command line.

.. note::

By default, `omicron-process` won't output very much to the screen, so it
can be useful to supply ``--verbose --verbose`` (i.e. ``--verbose`` twice)
to get the ``DEBUG`` logging statements. This will provide a running
progress report for the workflow, which can be very informative.

.. warning::

`omicron-process` will complain loudly if it can't find ``omicron.exe``
on the path somewhere. You can either specify ``--executable`` manually
on the command line, or **if you are working on the LIGO Data Grid** you
can source the virgosoft ``environment.sh`` script to set the paths
appropriately:

.. code-block:: bash
source /home/detchar/opt/virgosoft/environment.sh
-----------------------
Details of the workflow
-----------------------
Expand Down

0 comments on commit 922f210

Please sign in to comment.