updating headers and some titles with capitalizing

dtcenter · Oct 23, 2023 · f785521 · f785521
1 parent daeade2
commit f785521
Show file tree

Hide file tree

Showing 21 changed files with 129 additions and 99 deletions.
diff --git a/docs/Users_Guide/barplots.rst b/docs/Users_Guide/barplots.rst
@@ -1,8 +1,9 @@
+*********
 Bar Plots
-=========
+*********
 
 Description
------------
+===========
 
 A bar plot shows comparisons among discrete categories. One axis of the
 chart shows the specific categories being compared, while the other
@@ -22,7 +23,7 @@ Bar plots often represent counts or frequencies, however, bar plots can
 represent means, medians, standard deviations, or any other statistic.
 
 How-To
--------
+======
 
 Selection of options to produce the plot proceeds approximately
 counter-clockwise around the METviewer window. The steps to create a series
@@ -92,7 +93,7 @@ plot are:
 There are many other options for plots, but these are the basics.
 
 Example
---------
+=======
 
 The image below shows an example of the plot and set-up options for a
 series plot in METviewer. This example uses the database

diff --git a/docs/Users_Guide/batch.rst b/docs/Users_Guide/batch.rst
@@ -1,5 +1,6 @@
+*********************
 Batch Plotting Module
-=====================
+*********************
 
 The batch plotting system is used to generate a number of plots of data in
 the METviewer database. The usage statement:
@@ -439,10 +440,11 @@ starting at 1 for each fcst_var.
 |
 
 MODE Statistics
----------------
+===============
 
 Single Object Statistics
-~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------
+
 MODE statistics are broken up into two categories: single and pair
 statistics. Single statistics are suffixed with a three letter code which
 indicates the group of objects over which the statistic should be calculated
@@ -597,7 +599,7 @@ RATIO\_ with AREARAT\_ and OBJ with OBJA.
     - OBJFBIAS
 
 Pair Object Statistics
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
 
 MODE object pair statistics are specified using the following format:
 STATNAME_CC where STATNAME is one of the Object Pair Statistics in the

diff --git a/docs/Users_Guide/boxplot.rst b/docs/Users_Guide/boxplot.rst
@@ -1,8 +1,9 @@
+*********
 Box Plots
-=========
+*********
 
 Description
------------
+===========
 
 Box plots, or box and whisker plots, are a way to summarize a distribution
 of values using Tukey's 5-number summary
@@ -27,7 +28,7 @@ threshold. Here, each forecast and observation is binary, but the
 verification statistic is continuous. 
 
 How-To
----------
+======
 
 Selection of options to produce the plot proceeds approximately
 counter-clockwise around the METviewer window. The steps to create a
@@ -105,7 +106,7 @@ There are many other options for plots, but these are the basics.
 
 
 Example
---------
+=======
 
 The example below shows a boxplot of the RMSE for 2m temperature over
 the CONUS. Many of the standard METviewer plotting options are available

diff --git a/docs/Users_Guide/common.rst b/docs/Users_Guide/common.rst
@@ -1,5 +1,6 @@
+*********************
 Common XML Structures
-=====================
+*********************
 
 The database loading module and batch plotting module both use XML input files. Some XML structures can be used in either input file. These common structures are documented below.
 

diff --git a/docs/Users_Guide/contourplot.rst b/docs/Users_Guide/contourplot.rst
@@ -1,8 +1,9 @@
+*************
 Contour Plots
-=============
+*************
 
 Description
------------
+===========
 
 Contour plots are a very general plot type somewhat similar to a scatter
 plot. The axes are specified by the user, and any will do so long as the
@@ -13,7 +14,7 @@ examine the difference in statistics between two NWP models as a contour
 plot, as is shown in the example below. 
 
 How-To
--------
+======
 
 Selection of options to produce the plot proceeds approximately
 counter-clockwise around the METviewer window. The steps to create a contour
@@ -76,7 +77,7 @@ plot are:
 There are many other options for plots, but these are the basics.
 
 Example
---------
+=======
 
 The example is a contour plot of temperature mean error (bias) for one
 model at different pressure levels over a range of initialization times.

diff --git a/docs/Users_Guide/database_loading.rst b/docs/Users_Guide/database_loading.rst
@@ -1,5 +1,6 @@
+***********************
 Database Loading Module
-=======================
+***********************
 
 The database loading module is used to insert, update, and delete MET output
 data in the database. The tool is invoked using the mv_load.sh script. The
@@ -134,7 +135,7 @@ change it to
 
 
 Example
--------
+=======
 
 Here is a simple example:
 
@@ -203,7 +204,8 @@ specified by the <date_offset> named folder_dates.
         ...
 
 Troubleshooting
----------------
+===============
+
 .. _test:
 
 .. list-table:: 

diff --git a/docs/Users_Guide/database_scrubbing.rst b/docs/Users_Guide/database_scrubbing.rst
@@ -1,5 +1,6 @@
+*************************
 Database Scrubbing Module
-=========================
+*************************
 
 The database scrubbing utility is used to to delete data from METviewer
 databases that meets some user-specified selection criteria. The usage
@@ -58,7 +59,7 @@ performed (**FALSE**).
 |
 
 Examples
---------
+========
 
 **Example 1: Prune by describing the data (<fields>)**
 

diff --git a/docs/Users_Guide/eclvplots.rst b/docs/Users_Guide/eclvplots.rst
@@ -1,8 +1,9 @@
+******************************
 Economic Cost/Loss Value Plots
-==============================
+******************************
 
 Description
------------
+===========
 
 The Economic Cost Loss Value statistic is sometimes also called the
 Relative value score (:ref:`Richardson, 2000<Richardson>`;
@@ -23,11 +24,12 @@ The ECLV score can range from -:math:`\infty` to 1.
 Like ROC diagrams, it gives information that can be used in decision making.
 
 Line Type
----------
+=========
+
 ECLV requires the ECLV line type generated by either Point-Stat or Grid-Stat.
 
 How-To
-------
+======
 
 Selection of options to produce the ECLV plot proceeds approximately
 counter-clockwise around the METviewer window.
@@ -81,7 +83,7 @@ counter-clockwise around the METviewer window.
 
 
 Example
---------
+=======
 
 The figure below shows an ECLV plot. In this example, three different
 forecasting systems are used to predict precipitation at two different

diff --git a/docs/Users_Guide/etb_plot.rst b/docs/Users_Guide/etb_plot.rst
@@ -1,8 +1,9 @@
+********************************
 Equivalence Testing Bounds Plots
-================================
+********************************
 
 Description
------------
+===========
 
 A statistical hypothesis is an assertion about the distribution function for one or more random variables.
 Generally, two hypotheses are considered, a null hypothesis denoted by H0, and an alternative denoted by
@@ -32,7 +33,7 @@ In this case, H0 is accepted if the CI bounds fall completely between the tolera
 and H0 is rejected otherwise.
 
 How-To
--------
+======
 
 Selection of options to produce the plot proceeds approximately
 counter-clockwise around the METviewer window. The steps to create a
@@ -104,7 +105,7 @@ There are many other options for plots, but these are the basics.
 
 
 Example
---------
+=======
 
 The image below shows an example of the plot and set-up options for a
 series plot in METviewer. This example uses the database

diff --git a/docs/Users_Guide/index.rst b/docs/Users_Guide/index.rst
@@ -1,6 +1,6 @@
-============
+############
 User's Guide
-============
+############
 
 **Foreword: A note to METviewer users**
 

diff --git a/docs/Users_Guide/installation.rst b/docs/Users_Guide/installation.rst
@@ -1,17 +1,18 @@
 .. _install:
 
+****************************
 METviewer Installation Guide
-============================
+****************************
 
 Introduction
-------------
+============
 
 This chapter describes how to install METviewer. METviewer has been
 developed and tested on Linux operating systems. Support for additional
 platforms and compilers may be added in future releases. 
 
 Installing METviewer
---------------------
+====================
 
 METviewer relies on the following tools. These must be installed and tested
 prior to installing METviewer:
@@ -118,7 +119,7 @@ clone   `METdataio repository <https://github.com/dtcenter/METdataio>`_
      git clone https://github.com/dtcenter/METdataio.git
 
 Configure and build METviewer
-_____________________________
+-----------------------------
 
 #. Configure the batch and loading tools:
 
@@ -225,7 +226,8 @@ _____________________________
         ln -s /d3/projects/METViewer/src_dev/apps/verif/metviewer/sql/mv_mysql.sql mv_mysql.sql
 
 Making a Database Accessible in the METviewer Web Application
--------------------------------------------------------------
+=============================================================
+
 To make a new database accessible in the METviewer Web Application click
 on "Reload list of databases" button in the upper right corner of the
 main JSP page. The list of available databases should be updated and a

diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst
@@ -1,9 +1,9 @@
+*********************
 Overview of METviewer
-=====================
+*********************
 
-
-Purpose and organization of the User's Guide
---------------------------------------------
+Purpose and Organization of the User's Guide
+============================================
 
 The goal of this User's Guide is to provide basic information for users of
 the METviewer database and display system to enable users to create plots
@@ -13,7 +13,7 @@ The METviewer User's Guide is organized as follows.
 
 
 The Developmental Testbed Center (DTC)
---------------------------------------
+======================================
 
 METviewer has been developed, and will be maintained and enhanced, by the
 Developmental Testbed Center (`DTC <http://www.dtcenter.org/>`_ ). The main
@@ -34,8 +34,8 @@ modeling community for testing and evaluation of new model capabilities,
 applications in new environments, and so on.
 
 
-METviewer goals and design philosophy
--------------------------------------
+METviewer Goals and Design Philosophy
+=====================================
 
 The METviewer tool reads MET verification statistics output from a database
 and creates plots using the R statistical package. The tool includes a web
@@ -55,7 +55,7 @@ private sector, and operational modeling and prediction centers.
 
 
 METviewer Requirements
-----------------------
+======================
 
 METviewer requires installation of Java, Apache / Tomcat, MySQL, and R
 statistics.
@@ -70,7 +70,7 @@ statistics.
 .. _userspec:
 
 METviewer User Specifications
------------------------------
+=============================
 
 The top menu allows the user to select a database and type for the plot. 
 
@@ -121,7 +121,7 @@ trying to compare the skill of one or more predictions.
 
 
 METviewer Output
-----------------
+================
 
 METviewer output all appears in the tabbed boxes at the top right quadrant
 of the web browser. The plot will show by default, but the user can click any
@@ -160,7 +160,7 @@ recommended that the user click through at least the plot and xml windows
 and save this output.
 
 METviewer Plot Formatting Specifications
-----------------------------------------
+========================================
 
 METviewer plot formatting options appear in the tabbed boxes at the bottom
 right quadrant of the web browser. The “Titles & Labels” tab will show by
@@ -193,7 +193,7 @@ reset all options to the defaults.
 
 
 METviewer Series Formatting Specifications
-------------------------------------------
+==========================================
 
 At the bottom of the METviewer window is the series formatting box. It allows
 the user to control the minute details of each line on a plot, including
@@ -205,7 +205,7 @@ place (so subsequent plots are identical in format).
 
 
 METviewer History Menu
-----------------------
+======================
 
 Along the left of the METviewer GUI, hidden by default, is the history menu.
 To open this menu, click the arrow at the top left side right underneath
@@ -215,8 +215,8 @@ from this menu to recover plots they may have neglected to save. Clicking
 on the button showing loads the plot.
 
 
-Future development plans
-------------------------
+Future Development Plans
+========================
 
 METviewer is an evolving verification database and display software package.
 New capabilities are planned in controlled, successive version releases. Bug
@@ -226,8 +226,8 @@ releases of METviewer. Additionally, updates to accommodate new features of
 the MET software are often required. 
 
 
-Code support
-------------
+Code Support
+============
 
 METviewer support is provided through the
 `METplus GitHub Discussions Forum <https://github.com/dtcenter/METplus/discussions>`_.