From 8508f4645c8b62cc23c08897355a479ba403e972 Mon Sep 17 00:00:00 2001 From: Jo Basevi Date: Wed, 29 Nov 2023 20:32:08 +1100 Subject: [PATCH] add formatting documentation fix --- docs/source/usage.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index aeb94ac4..743bddc2 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -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, @@ -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 @@ -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 -----------------------------------------