Skip to content

Commit

Permalink
add formatting documentation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Jo Basevi committed Nov 29, 2023
1 parent 151c88d commit 8508f46
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Experiment names and metadata
The *laboratory* contains the following subdirectories:

* ``work``, which is where the model is run. This contains a temporary directory
for each experiment which is removed after a successful run.
for each experiment which is removed after a successful run.

* ``archive``, which contains the output of completed runs for each
experiment.
experiment.

An experiment name is used identify the experiment inside the ``work`` and
``archive`` sub-directories. This is stored in a metadata file,
Expand All @@ -43,7 +43,7 @@ is set in ``metadata.yaml`` when:
* Using payu to create and checkout a new git branch in the *control directory*

* Or, it is set automatically when setting up an experiment run if there is
not a pre-existing metadata file.
not a pre-existing metadata file.

The experiment name historically would default to the name of the *control
directory* or the configured ``experiment`` value (see :ref:`config`). This is
Expand All @@ -54,13 +54,13 @@ For example, given a control directory named ``my_expt`` and a UUID of
``9fAsTc4sNYsH2ZBQGYK9TG``, the experiment name would be:

* ``my_expt-perturb-9fAsT`` - if running an experiment on a branch named
``perturb``.
``perturb``.

* ``my_expt-9fAsT`` - if the control directory was not a git repository or
running experiments from the ``main`` or ``master`` branch.
running experiments from the ``main`` or ``master`` branch.

* or ``my_expt`` - if running an older experiment that has a pre-existing
archive.
archive.

Using a git repository for the experiment
-----------------------------------------
Expand Down

0 comments on commit 8508f46

Please sign in to comment.