Skip to content

Commit

Permalink
#2690 Minor documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
hiker committed Oct 9, 2024
1 parent 8aca4b9 commit 497beeb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/user_guide/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,7 @@ will create the same warnings):
Notice that now a warning is created for both kernels: ``init`` and ``update``.

Support for checking arbitrary Fortran code is tracked as issue #2741.


Example 6: PSy-layer Code Creation using PSyIR
Expand Down
13 changes: 13 additions & 0 deletions doc/user_guide/psy_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,19 @@ a few warnings raised by the value range checker)::
PSYVERIFY__time_evolution__perturbation_data=0.0:4000
PSYVERIFY__perturbation_data=0.0:4000
.. warning:: Note that while the field variable is called `perturbation`, PSyclone will
append `_data` when the LFRic domain is used, so the name becomes
`perturbation_data`. You have to use
this name in LFRic in order to trigger the value range check. To verify
that the tests are done as expected, set the environment variable
`PSYDATA_VERBOSE` to 1, which will print which data is taken from the
environment variables:

.. code-block:: bash
PSyData: checking 'time_evolution' region 'invoke_initialise_perturbation' : 0.0000000000000000 <= perturbation_data <= 4000.0000000000000
If values outside the specified range are found, appropriate warnings are printed,
but the program is not aborted::

Expand Down

0 comments on commit 497beeb

Please sign in to comment.