Skip to content

Commit

Permalink
fixing headers, adding Contributors Guide to the index file
Browse files Browse the repository at this point in the history
  • Loading branch information
lisagoodrich committed Oct 23, 2023
1 parent fdc6486 commit 280bf57
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 24 deletions.
5 changes: 2 additions & 3 deletions docs/Contributors_Guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

===================
###################
Contributor's Guide
===================
###################

.. toctree::
:titlesonly:
Expand Down
23 changes: 12 additions & 11 deletions docs/Contributors_Guide/testing.rst
Original file line number Diff line number Diff line change
@@ -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**

Expand Down Expand Up @@ -45,8 +46,8 @@ stored in the
`git store <https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage>`_ .
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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
20 changes: 10 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
===========================
###########################
METviewer version |version|
===========================
###########################

Developed by the `Developmental Testbed Center <https://dtcenter.org/>`_, 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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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<citations>`.
Expand All @@ -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`




0 comments on commit 280bf57

Please sign in to comment.