Skip to content

Commit

Permalink
Per #2168, fix tc-diag doc formatting to get rid of warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnHalleyGotway committed Jun 6, 2023
1 parent edad8e5 commit fa3f462
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/Users_Guide/tc-diag.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following sections describe the usage statement, required arguments, and opt
tc_diag has required arguments and can accept several optional arguments.

Required arguments for tc_diag
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. The **-data file_1 ... file_n | data_file_list** options specify the gridded data files or an ASCII file containing a list of files to be used.

Expand All @@ -41,14 +41,14 @@ Required arguments for tc_diag
4. The **-out** argument is the NetCDF output file to be written.

Optional arguments for tc_diag
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

5. The **-log file** option directs output and errors to the specified log file. All messages will be written to that file as well as standard out and error. Thus, users can save the messages without having to redirect the output on the command line. The default behavior is no logfile.

6. The **-v level** option indicates the desired level of verbosity. The contents of "level" will override the default setting of 2. Setting the verbosity to 0 will make the tool run with no log messages, while increasing the verbosity above 1 will increase the amount of logging.

tc_diag configuration file
-------------------------
--------------------------

The default configuration file for the TC-Diag tool named **TCDiagConfig_default** can be found in the installed *share/met/config/* directory. It is encouraged for users to copy these default files before modifying their contents. The contents of the configuration file are described in the subsections below.

Expand Down Expand Up @@ -177,7 +177,7 @@ The **radial_velocity_field_name** and **radial_velocity_long_field_name** param


tc_diag output file
------------------
-------------------

The NetCDF output file contains the following dimensions:

Expand Down

0 comments on commit fa3f462

Please sign in to comment.