Skip to content

Commit

Permalink
Merge branch 'sphinx-documentation' of https://github.com/NCAR/DART i…
Browse files Browse the repository at this point in the history
…nto sphinx-documentation
  • Loading branch information
johnsonbk committed Mar 29, 2021
2 parents 8d6d6d9 + 9ef6b97 commit 2393c1b
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 61 deletions.
17 changes: 17 additions & 0 deletions assimilation_code/modules/utilities/utilities_mod.rst
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,23 @@ References

- none

Error codes and conditions
--------------------------

+-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Routine | Message | Comment |
+=======================+==================================================+======================================================================================================================================================================================================================================================================================================================================+
| get_unit | No available units | Unable to open enough IO channels |
+-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| check_nml_error | while reading namelist _____ | Fatal error reading namelist. This could be caused by having an entry in the namelist input file that is not in the namelist, by having illegal values for namelist variables, or by a variety of other compiler dependent problems. |
+-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| find_namelist_in_file | Namelist entry &____ must exist in namelist_nml. | There must be an entry for the required namelist, for instance &filter_nml, in the input.nml namelist file. Even if no values are to be changed from the default, an entry like &filter_nml followed by a line containing only / is required. |
+-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| find_namelist_in_file | Namelist input file: input.nml must exist | The namelist input file (usually input.nml) must exist. |
+-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| check_namelist_read | INVALID NAMELIST ENTRY: ___ in namelist ____ | While reading the namelist, either a bad entry was found or an end of file was encountered. The most confusing case is when a namelist is being read successfully but is not appropriately terminated with a /. The line printed out by the error message will be the start of the next namelist in the input.nml file in this case. |
+-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Private components
------------------

Expand Down
4 changes: 2 additions & 2 deletions guide/dart-quality-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ A list of all the DART QC values can be found in the QC table.
obs_val and an *istatus = 0*. If the forward operator code returns different
istatus values for different error types, you can set
*&filter_nml::output_forward_op_errors = .true.* and rerun *filter* to see
exactly what error istatus codes are being set. See `the filter
webpage <../../assimilation_code/programs/filter/filter.html>`__ for more
exactly what error istatus codes are being set. See
:doc:`../assimilation_code/modules/assimilation/filter_mod` for more
information on how to use the ‘output_forward_op_errors’ option. Negative
istatus values are reserved for the system, *istatus = 0* is success, and any
positive value indicates a failed forward operator. The code is free to use
Expand Down
2 changes: 1 addition & 1 deletion models/NCOMMAS/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Overview
ncommas netCDF restart files into a set of DART files that have a consistent timestamp. If you simply convert each
ncommas file to a DART file using ``ncommas_to_dart``, each DART file will have a 'valid time' that reflects the
ncommas time of that state - instead of an ensemble of states reflecting one single time. The
`restart_file_utility <../../../utilities/restart_file_utility.f90>`__ can be used to overwrite the timestep in the
:doc:`restart_file_tool <../../assimilation_code/programs/restart_file_tool/restart_file_tool>` can be used to overwrite the timestep in the
header of each DART initial conditions file. The namelist for this program must look something like:
::
Expand Down

0 comments on commit 2393c1b

Please sign in to comment.