From 280bf57fa0d5a15bd436891150e8406a240952a3 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 23 Oct 2023 11:15:46 -0600 Subject: [PATCH] fixing headers, adding Contributors Guide to the index file --- docs/Contributors_Guide/index.rst | 5 ++--- docs/Contributors_Guide/testing.rst | 23 ++++++++++++----------- docs/index.rst | 20 ++++++++++---------- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/Contributors_Guide/index.rst b/docs/Contributors_Guide/index.rst index a1ddc46f..b08361e8 100644 --- a/docs/Contributors_Guide/index.rst +++ b/docs/Contributors_Guide/index.rst @@ -1,7 +1,6 @@ - -=================== +################### Contributor's Guide -=================== +################### .. toctree:: :titlesonly: diff --git a/docs/Contributors_Guide/testing.rst b/docs/Contributors_Guide/testing.rst index 78f7da56..6a64b28a 100644 --- a/docs/Contributors_Guide/testing.rst +++ b/docs/Contributors_Guide/testing.rst @@ -1,8 +1,9 @@ +************** Testing Module -============== +************** -Testing example - install and run on dakota -------------------------------------------- +Testing Example - Install and Run on dakota +=========================================== **Testing directory and branch information** @@ -45,8 +46,8 @@ stored in the `git store `_ . Also, **auto_test.sh** should be modified to send emails with testing results. -Testing - capture ------------------ +Testing - Capture +================= The testing module is used to execute the regression testing of a specified version of METviewer. The capture tool is invoked by using the mv_test.sh @@ -173,13 +174,13 @@ directory structure might look like this, for example... ... -Testing - verify ----------------- +Testing - Verify +================ The mv_compare.sh script accepts a branch and a tag that it uses to identify a test subdirectory and a second "expected" branch and tag that it uses to identify a comparison test directory. If tags are omitted the HEAD is used. The compare script looks for corresponding image files in the corresponding plots directories and does a binary comparison of the corresponding files. Differences will be reported as errors. -auto test ---------- +Auto Test +========= The auto_test.sh script defines the branch, optionally a tag, directories, and database credentials for a version under test and a comparison version. It performs the following steps. @@ -286,8 +287,8 @@ to pass, produced and expected files should be byte identical. NOTE: R scripts create visually similar results but bitwise different image files on different platforms. -Testing submodules ------------------- +Testing Submodules +================== **LoadDataTest** recreates and refills the mv_test database with MET output data and compares the number of rows in each table with the expected number. diff --git a/docs/index.rst b/docs/index.rst index f4333c92..c513547a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,14 @@ -=========================== +########################### METviewer version |version| -=========================== +########################### + Developed by the `Developmental Testbed Center `_, Boulder, CO .. image:: _static/METplus_banner_photo_web.png History -------- +======= + The Model Evaluation Tools (MET) were developed by the Developmental Testbed Center (DTC) and released in January 2008. The goal of the tools was to provide the community with a platform independent and extensible @@ -35,7 +37,8 @@ It is being actively developed by NCAR, ESRL, EMC and is open to community contributions. METplus Concept ---------------- +=============== + METplus is the overarching, or umbrella, repository and hence framework for the Unified Forecast System verification capability. It is intended to be extensible through adding additional capability developed by the community. @@ -74,7 +77,7 @@ that are developed and managed independently. Each component also may have additional "external" dependencies that need to be maintained independently. Acronyms --------- +======== * **MET** - Model Evaluation Tools * **DTC** - Developmental Testbed Center @@ -91,7 +94,7 @@ Acronyms * **GSD** - Global Systems Division Authors -------- +======= Many authors, listed below in alphabetical order, have contributed to the documentation of METplus. To cite this documentation in publications, please refer to the METviewer User's Guide :ref:`Citation Instructions`. @@ -112,12 +115,9 @@ To cite this documentation in publications, please refer to the METviewer User's :caption: METviewer Users_Guide/index + Contributors_Guide/index Index ===== * :ref:`genindex` - - - -