diff --git a/source/sette.rst b/source/sette.rst index e20b3561b571940405ae032b0e3a68174af8a407..ca14f358791613c59c60c8f7412fe83b0dd3202f 100644 --- a/source/sette.rst +++ b/source/sette.rst @@ -454,21 +454,23 @@ a basic report is presented to the user which lists the various successes or fai The report shows the result of restartability and reproducibility tests on the whole range of test -configurations. Passing these tests is a necessary and mandatory requirement for any official release +configurations. Passing the default set of tests is a necessary and mandatory requirement for any official release of NEMO. Note these tests are not sufficient to guarantee restartability and reproducibility in all user-defined configrations and anyone running configurations, which are not close variants of the reference or test configurations, should conduct their own tests. -``SETTE`` will also carry out tests on the PSyclone code transformation (if enabled) and tests with -alternative physics options that are defined for some configurations. The range of tests carried out -can be varied via the ``-x`` command-line option to ``sette.sh``. The default behaviour is equivalent to +``SETTE`` will also carry out tests with alternative physics options that are defined for some configurations, +and optionally tests on PSyclone-based code transformations. The range of tests carried out +can be varied via the ``-x`` command-line option to ``sette.sh``. The default set of tests is equivalent to .. code-block:: bash - sette.sh -x "COMPILE RESTART REPRO CORRUPT PHYOPTS TRANSFORM" + sette.sh -x "COMPILE RESTART REPRO CORRUPT PHYOPTS" -This report ends by comparing the latest results against a reference set (as defined in -``param.cfg``). Only ``ORCA2_ICE_PISCES`` had been run on the alternative branch and the +and optionally the SETTE test option ``TRANSFORM`` can be included in the argument to enable the testing of +PSyclone-based code transformations (this includes a comparison of model results and runtimes between model +runs based on untransformed and transformed code). This report ends by comparing the latest results against +a reference set (as defined in ``param.cfg``). Only ``ORCA2_ICE_PISCES`` had been run on the alternative branch and the missing comparisons have been omitted here. In this case the comparison is between branches that were known to introduce numerical differences. This is confined by the comparsion but the report is most useful when numerical results are not expected to change @@ -548,13 +550,12 @@ are equivalent. As a point of interest, it is good practise to list tests in dec order of their expected execution time. This will enable compilation time to overlap run-time as much as possible and should minimise time to completion -The default operation is to perform all ``RESTART``, ``REPRO`` and agrif-processed, -``CORRUPT`` checks. The checks performed can be limited to a sub-set of these by supplying -arguments to the ``-x`` option. The combination of ``-n`` and ``-x`` is particularly -useful when working to solve a specific issue with a single configuration. There is also -a ``PHYOPTS`` check which is not currently used but has been implemented, as a -demonstration, to run the ``OVERFLOW`` and ``LOCK_EXCHANGE`` test cases with a selection -of different physical schemes. Any other string supplied as an argument to the ``-x`` +The default operation is to perform all ``RESTART``, ``REPRO``, AGRIF-processing +``CORRUPT``, and ``PHYOPTS`` (optional physical schemes) checks. The checks performed can be +limited to a sub-set of these by supplying arguments to the ``-x`` option. The combination of +``-n`` and ``-x`` is particularly useful when working to solve a specific issue with a single +configuration. The optional ``TRANSFORM`` test enables the testing of PSyclone-based source-code +transformations. Any other string supplied as an argument to the ``-x`` option will force a compilation only. This is useful for quickly checking for compile-time errors. Although any non-recognised string will trigger this, it is good practise to be explicit, i.e.: