diff --git a/docs/Contributors_Guide/conda_env.rst b/docs/Contributors_Guide/conda_env.rst index 8a33023ef..8395c38fc 100644 --- a/docs/Contributors_Guide/conda_env.rst +++ b/docs/Contributors_Guide/conda_env.rst @@ -1,10 +1,11 @@ .. _conda_env: +************************************** Instructions for the Conda Environment -====================================== +************************************** -Overview: Replicating the Python 3.6.3 environment for running METplus -_______________________________________________________________________ +Overview: Replicating the Python 3.6.3 environment for Running METplus +======================================================================= If the host (i.e. the computer on which the METplus and MET tools are running) doesn't already have all the necessary packages installed, it is @@ -19,8 +20,8 @@ METplus source code: *METplus/environment.yml* -Pre-condition- installing the conda package manager if it doesn't exist -_______________________________________________________________________ +Pre-condition- Installing the Conda Package Manager If It Doesn't Exist +======================================================================= **These instructions only need to be followed once.** @@ -72,7 +73,7 @@ _______________________________________________________________________ Creating the METplus conda env -______________________________ +============================== **These instructions only need to be implemented once.** @@ -127,8 +128,8 @@ to end the application. conda deactivate -Activating and deactivating the METplus conda env -_________________________________________________ +Activating and Deactivating the METplus conda env +================================================= Once the user has followed the instructions under the "Creating the METplus conda env", follow these instructions to start running METplus : @@ -163,8 +164,8 @@ conda env", follow these instructions to start running METplus : -Optional: Checking for missing packages and mismatched version -______________________________________________________________ +Optional: Checking for Missing Packages and Mismatched Version +============================================================== To check for missing and mismatched packages run the **check_python.py** script in the METplus directory: @@ -192,7 +193,7 @@ The results are sent to stdout (screen) and three files are created: Link Conda Directory to Data Disk (RAL Linux Machines) -______________________________________________________ +====================================================== By default, Conda environments are stored in a directory called ".conda" that is found in the user's home directory, i.e. /home/user/.conda (Note that the dot at the beginning of the directory name is a hidden directory that does not always show up in a directory listing). Conda environments can take up a lot of disk space which can quickly fill up the /home disk. It is recommended that you create a directory on a data disk that has more disk space and create a symbolic link from the .conda directory so the environments will be stored on the data disk. Keep in mind that deleting the directory on the data disk will delete all of your conda environments and they cannot be easily recovered. diff --git a/docs/Contributors_Guide/create_wrapper.rst b/docs/Contributors_Guide/create_wrapper.rst index f5280e3a1..287ffa0ea 100644 --- a/docs/Contributors_Guide/create_wrapper.rst +++ b/docs/Contributors_Guide/create_wrapper.rst @@ -1,11 +1,12 @@ +*************************** How to Create a New Wrapper -=========================== +*************************** Naming ------- +====== File Name -^^^^^^^^^ +--------- Create the new wrapper in the *metplus/wrappers* directory and name it to reflect the wrapper's function, e.g.: new_tool_wrapper.py is @@ -13,14 +14,14 @@ a wrapper around an application named "new_tool." Copy the **example_wrapper.py** to start the process. Class Name -^^^^^^^^^^ +---------- The name of the class should match the wrapper's function without underscores and with the first letter of each word capitalized followed by "Wrapper." For example, the new_tool wrapper would be named **NewToolWrapper**. Add Entry to LOWER_TO_WRAPPER_NAME Dictionary ---------------------------------------------- +============================================= In *metplus/util/constants.py*, add entries to the LOWER_TO_WRAPPER_NAME dictionary so that the wrapper can be found in the PROCESS_LIST even if @@ -57,12 +58,12 @@ More than one entry is rarely needed, but they will not hurt anything as long as they do not cause any conflicts. Wrapper Components ------------------- +================== Open the wrapper file for editing the new class. Naming -^^^^^^ +------ Rename the class to match the wrapper's class from the above sections. Most wrappers should be a subclass of the RuntimeFreqWrapper:: @@ -80,7 +81,7 @@ To create EnsembleStat wrapper from GridStat, replace **GridStat** with **EnsembleStat**. Parent Class -^^^^^^^^^^^^ +------------ If the new tool falls under one of the existing tool categories, then make the tool a subclass of one of the existing classes. @@ -91,7 +92,7 @@ See :ref:`bc_class_hierarchy` for more information on existing classes to determine which class to use as the parent class. Class Variables for Runtime Frequency -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------------------- **RUNTIME_FREQ_DEFAULT** and **RUNTIME_FREQ_SUPPORTED** should be set for all wrappers that inherit from **RuntimeFreqWrapper**. @@ -99,7 +100,7 @@ wrappers that inherit from **RuntimeFreqWrapper**. See :ref:`bc_class_vars` for more information. Init Function -^^^^^^^^^^^^^ +------------- Modify the init function to initialize NewTool from its base class to set the self.app_name variable to the name of the application. @@ -114,7 +115,7 @@ See the Basic Components :ref:`bc_init_function` section for more information:: super().__init__(config, instance=instance) Read Configuration Variables -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------------------- The create_c_dict function is called during the initialization step of each wrapper. It is where values from the self.config object are read. @@ -132,13 +133,13 @@ The function should also always return the c_dict variable:: return c_dict File Input/Output -""""""""""""""""" +^^^^^^^^^^^^^^^^^ METplus configuration variables that end with _DIR and _TEMPLATE are used to define the criteria to search for input files. Allow Multiple Files -"""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^ If the application can take more than one file as input for a given category (i.e. FCST, OBS, ENS, etc.) then ALLOW_MULTIPLE_FILES must be set to True:: @@ -151,7 +152,7 @@ If it is set to False and a list of files are found for an input then the wrapper will produce an error and not build the command. Run Functions -^^^^^^^^^^^^^ +------------- * The **run_at_time_once** function or some the functions that it calls will need to be overridden in the wrapper. @@ -240,7 +241,7 @@ Refer to the :ref:`basic_components_of_wrappers` section of the Contributor's Guide for more information on what should be added. Documentation -------------- +============= * Add a section for the new wrapper in the 'Python Wrappers' section of the User's Guide. This includes a list of all configuration variables specific diff --git a/docs/Contributors_Guide/deprecation.rst b/docs/Contributors_Guide/deprecation.rst index 1703d7a2c..ec42976d7 100644 --- a/docs/Contributors_Guide/deprecation.rst +++ b/docs/Contributors_Guide/deprecation.rst @@ -1,12 +1,14 @@ +********************************** Deprecating an Old Config Variable -================================== +********************************** If a config variable changes names, an alert is needed to let the user know that they need to update the config files if they are using a deprecated variable. Example -------- +======= + :: [exe] @@ -25,7 +27,8 @@ read and the user will have no way to know that they are setting the wrong variable and it is using WGRIB2 = wgrib2. check_for_deprecated_config() ------------------------------ +============================= + In **metplus/util/constants.py** there is a dictionary called DEPRECATED_DICT that specifies the old config name as the key. The value is a dictionary of info that is used to help users update their diff --git a/docs/Contributors_Guide/documentation.rst b/docs/Contributors_Guide/documentation.rst index c383a8617..ce9bc8857 100644 --- a/docs/Contributors_Guide/documentation.rst +++ b/docs/Contributors_Guide/documentation.rst @@ -1,21 +1,22 @@ +************* Documentation -============= +************* Viewing METplus documentation -_____________________________ +============================= The METplus documentation (beginning with version 3.0) is available `online `_. Doxygen Source Code Documentation -_________________________________ +================================= The source code documentation is coming soon. Documentation Overview -______________________ +====================== The majority of the documentation is created using the Sphinx documentation generator tool, which was originally created for Python documentation. @@ -37,7 +38,7 @@ Contributor's Guide. Description of Documentation Directories -________________________________________ +======================================== Core documentation is divided into four sections: User's Guide, Contributor's Guide, Release Guide, and Verification Datasets Guide all of which reside @@ -61,7 +62,7 @@ section for more information on documenting a new use case. Adding New Documentation -________________________ +======================== To determine where to add new documentation: @@ -81,7 +82,7 @@ To determine where to add new documentation: User's Guide: -~~~~~~~~~~~~~ +------------- * To add/modify any content that affects METplus users. * Modify any of the affected sections from the @@ -94,7 +95,7 @@ User's Guide: * **wrappers.rst** (METplus wrappers) Contributor's Guide: -~~~~~~~~~~~~~~~~~~~~ +-------------------- * To add/modify any content that affects METplus contributors. * Modify any of the affected sections from the @@ -118,7 +119,7 @@ Contributor's Guide: wrapper code) Release Guide: -~~~~~~~~~~~~~~ +-------------- * To add/modify the instructions for creating software releases for any METplus component, including official, bugfix, and development @@ -154,7 +155,7 @@ Release Guide: Verification Datasets Guide: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- * To add/modify any relevant datasets in an attempt to create a centralized catalog of verification datasets to provide the model @@ -165,7 +166,7 @@ Verification Datasets Guide: .. _read-the-docs: Read the Docs METplus Documentation -___________________________________ +=================================== The METplus components use `Read the Docs `_ to build and display the documentation. Read the Docs simplifies the @@ -217,7 +218,7 @@ Documentation for each METplus component can be found at the links below: Building Sphinx Documentation Manually -______________________________________ +====================================== Documentation does not have to be built manually as it is automatically generated by Read The Docs. See the @@ -259,7 +260,7 @@ will direct to the home page of the documentation. Click on the links to navigate to the desired information. Relevant Documentation for Contributors -_______________________________________ +======================================= The Doxygen tool is employed to create documentation from the source code. This documentation is useful in generating details about the METplus wrapper diff --git a/docs/Contributors_Guide/github_workflow.rst b/docs/Contributors_Guide/github_workflow.rst index 4b623a69c..ab0be1b3b 100644 --- a/docs/Contributors_Guide/github_workflow.rst +++ b/docs/Contributors_Guide/github_workflow.rst @@ -1,10 +1,11 @@ .. _github-workflow: +*************** GitHub Workflow -=============== +*************** -How METplus releases are created --------------------------------- +How METplus Releases are Created +================================ The branching model employed by the METplus GitHub repository is similar to that described in @@ -24,8 +25,8 @@ which includes data tarballs for use in running use cases. .. _wo-development-project: -GitHub Projects to manage development -------------------------------------- +GitHub Projects to Manage Development +===================================== Software development for official METplus releases is organized into development cycles. While the length a development cycle can vary widely, they are nominally 6 weeks long. @@ -171,8 +172,8 @@ are required to perform the following steps. .. _wo-support-project: -GitHub Projects to manage support ---------------------------------- +GitHub Projects to Manage Support +================================= Support for coordinated METplus releases is managed using a *single* GitHub project for all components. Bugfix issues and the corresponding pull request fixes are added @@ -297,7 +298,7 @@ required to perform the following steps. - Click the **Link a project** button and find/select this newly created support project. Sequence of Events - Contributing Code --------------------------------------- +====================================== *Prerequisite:* @@ -308,7 +309,7 @@ to the GitHub Documentation on Workflow Overview -~~~~~~~~~~~~~~~~~ +----------------- Contributors will follow these instructions for new development. Detailed instructions for each item can be found below or by clicking the link. @@ -378,7 +379,7 @@ Find or Create a GitHub Issue .. _wo-fork-repo: -Fork the dtcenter/METplus repository +Fork the dtcenter/METplus Repository ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * **If the contributor has write access to the dtcenter/METplus repository, @@ -409,7 +410,7 @@ Fork the dtcenter/METplus repository .. _wo-clone-repo: -Clone the repository locally +Clone the Repository Locally ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Change directories to a working directory. From the command line, @@ -432,7 +433,7 @@ Clone the repository locally .. _wo-set-upstream: -Set upstream remote +Set Upstream Remote ^^^^^^^^^^^^^^^^^^^ * **If working from the dtcenter/METplus repository, skip this step.** @@ -464,7 +465,7 @@ Set upstream remote .. _wo-feature-branch: -Create a feature branch +Create a Feature Branch ^^^^^^^^^^^^^^^^^^^^^^^ * Generate a feature branch from the *develop* branch for new development @@ -534,7 +535,7 @@ Create a feature branch .. _wo-make-changes: -Make changes to code in the feature branch +Make Changes to Code in the Feature Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Users should make changes to their feature branch and commit changes to their @@ -589,7 +590,7 @@ local repository. .. _wo-commit-changes: -Commit changes to feature branch +Commit Changes to Feature Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * View all files that have changed since the last commit: @@ -647,7 +648,7 @@ Commit changes to feature branch .. _wo-push-changes: -Push the feature branch to GitHub +Push the Feature Branch to GitHub ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Pushing changes up to GitHub periodically is recommended to avoid losing @@ -664,7 +665,7 @@ progress by relying on the local copy of the changes. .. _pull-request-browser: -Open a pull request +Open a Pull Request ^^^^^^^^^^^^^^^^^^^ * To request to have the changes be incorporated into the remote repository @@ -745,8 +746,8 @@ Open a pull request everything meets acceptance criteria) and merge the code into the remote repository's develop branch. -Approve a pull request using a browser -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Approve a Pull Request Using a Browser +-------------------------------------- Submitting a pull request allows a user to propose changes, request a review of the contributions and have the proposed changes merged into a @@ -761,7 +762,7 @@ sub-tasks to be complete, then it may be best to wait to create a pull request until the other sub-tasks are also complete. -Reviewing a pull request +Reviewing a Pull Request ^^^^^^^^^^^^^^^^^^^^^^^^ 1. Click on the “Pull requests” tab in the GitHub repository and @@ -838,7 +839,7 @@ Reviewing a pull request been made, approve the request. -Merging pull requests +Merging Pull Requests ^^^^^^^^^^^^^^^^^^^^^ Once the pull request has been approved it is ready to be merged. **As permissions allow, the requestor is responsible for merging the pull request @@ -860,7 +861,7 @@ If the requestor wishes to delete the “compare” branch, the “Delete branch button should be selected and the corresponding GitHub issue should be closed. -Clean up after a successfully merged pull request +Clean Up After a Successfully Merged Pull Request ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * After an authorized METplus developer has accepted the changes and merged @@ -904,17 +905,3 @@ Clean up after a successfully merged pull request replacing appropriately. Under the 'Branch' pulldown menu, the feature branch name should no longer be seen as an option. - - - - - - - - - - - - - - diff --git a/docs/Contributors_Guide/index.rst b/docs/Contributors_Guide/index.rst index 4dd87bb41..2dabc2a16 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 f0e10804d..f40f37ec4 100644 --- a/docs/Contributors_Guide/testing.rst +++ b/docs/Contributors_Guide/testing.rst @@ -1,5 +1,6 @@ +******* Testing -======= +******* Test scripts are found in the GitHub repository in the internal/tests directory. @@ -7,7 +8,7 @@ directory. .. _cg-unit-tests: Unit Tests ----------- +========== Unit tests are run with pytest. They are found in the *internal/tests/pytests* directory under the *wrappers* @@ -15,7 +16,7 @@ and *util* directories. Each tool has its own subdirectory containing its test files. Pytest Requirements -^^^^^^^^^^^^^^^^^^^ +------------------- The following Python packages are required to run the tests. @@ -27,7 +28,7 @@ The following Python packages are required to run the tests. * **pdf2image** (optional): Only used if running diff utility tests Running -^^^^^^^ +------- To run the unit tests, set the environment variable **METPLUS_TEST_OUTPUT_BASE** to a path where the user running has write @@ -43,7 +44,7 @@ To view verbose test output, add the **-vv** argument:: pytest internal/tests/pytests -vv Code Coverage -^^^^^^^^^^^^^ +------------- If the *pytest-cov* package is installed, the code coverage report can be generated from the tests by running:: @@ -54,7 +55,7 @@ In addition to the pass/fail report, the code coverage information will be displayed including line numbers that are not covered by any test. Subsetting Tests by Directory -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------- A subset of the unit tests can be run by adjusting the path. Be sure to include the *--cov-append* argument so the results of the run @@ -65,7 +66,7 @@ To run only the GridStat unit tests:: Subsetting Tests by Marker -^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------- Pytest allows contributors to use markers on test functions. Markers are used to set various features/attributes to test functions so that users can easily @@ -126,10 +127,10 @@ Multiple marker groups can be run by using the *or* keyword:: pytest internal/tests/pytests -m " or " Writing Unit Tests -^^^^^^^^^^^^^^^^^^ +------------------ metplus_config fixture -"""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^^ Many unit tests utilize a pytest fixture named **metplus_config**. This is defined in the **conftest.py** file in internal/tests/pytests. diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst index 27e567c75..c4260f3d8 100644 --- a/docs/Release_Guide/coordinated.rst +++ b/docs/Release_Guide/coordinated.rst @@ -1,6 +1,5 @@ -******************* Coordinated Release -******************* +=================== .. |projectRepo| replace:: Coordinated diff --git a/docs/Release_Guide/index.rst b/docs/Release_Guide/index.rst index bde0abc8d..37fb437c1 100644 --- a/docs/Release_Guide/index.rst +++ b/docs/Release_Guide/index.rst @@ -1,6 +1,6 @@ -============= +############# Release Guide -============= +############# This METplus Release Guide provides detailed instructions for METplus developers for creating software releases for the METplus component @@ -11,11 +11,12 @@ repositories. .. _releaseTypes: +************* Release Types -============= +************* Coordinated Release -------------------- +=================== A METplus coordinated release is a group of official or bugfix releases for each of the METplus components that have been developed and tested in parallel. @@ -27,7 +28,7 @@ coordinated release announcement is updated to link to the most recent bugfix version. Official Release ----------------- +================ An official release is a stable release of a METplus component and typically matches the release candidate, which has passed all tests. It is the version of the @@ -35,17 +36,17 @@ code that has been tested as thoroughly as possible and is reliable enough to be used in production. Bugfix Release --------------- +============== A bugfix release for a METplus component introduces no new features, but fixes bugs in previous official releases and targets the most critical bugs affecting users. Development Release -------------------- +=================== Beta -^^^^ +---- Beta releases are a pre-release of a METplus software component to give a larger group of users the opportunity to test the recently incorporated new @@ -55,7 +56,7 @@ possible configurations of hardware and software that exist and installation of beta releases allow for testing of potential conflicts. Release Candidate (rc) -^^^^^^^^^^^^^^^^^^^^^^ +---------------------- A release candidate is a version of a METplus software component that is nearly ready for official release but may still have a few bugs. At this stage, all @@ -65,8 +66,9 @@ new source code will be added to this release. There may still be source code changes to fix bugs, changes to documentation, and changes to test cases or utilities. +********************** Release Support Policy -====================== +********************** The METplus developers officially provide bug fix support for the latest official release and for the developmental releases as described above. This @@ -80,8 +82,9 @@ software team and the respective funding institutions. For further inquiries or to report any bugs, please contact our dedicated support team in the `METplus GitHub Discussions Forum `_. +******************** Instructions Summary -==================== +******************** Instructions are provided for the following types of software releases: @@ -97,7 +100,7 @@ The instructions that are common to all components are documented only once and in the release steps for all components. However some instructions are specific to individual repositories and documented separately. -Release instructions are described in the following chapters. +Release instructions are described in the following sections. .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/met.rst b/docs/Release_Guide/met.rst index 9bc68a6a8..3e7657d6c 100644 --- a/docs/Release_Guide/met.rst +++ b/docs/Release_Guide/met.rst @@ -1,6 +1,5 @@ -*********** MET Release -*********** +=========== .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/met_bugfix.rst b/docs/Release_Guide/met_bugfix.rst index 7dcaa0b30..6861bc8b7 100644 --- a/docs/Release_Guide/met_bugfix.rst +++ b/docs/Release_Guide/met_bugfix.rst @@ -1,5 +1,5 @@ MET Bugfix Release -================== +------------------ .. |projectRepo| replace:: MET diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst index 2613dbbd5..df04a8b90 100644 --- a/docs/Release_Guide/met_development.rst +++ b/docs/Release_Guide/met_development.rst @@ -1,5 +1,5 @@ MET Development Release -======================= +----------------------- .. |projectRepo| replace:: MET diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst index 21242298a..0a4549cdf 100644 --- a/docs/Release_Guide/met_official.rst +++ b/docs/Release_Guide/met_official.rst @@ -1,5 +1,5 @@ MET Official Release -==================== +-------------------- .. |projectRepo| replace:: MET diff --git a/docs/Release_Guide/metcalcpy.rst b/docs/Release_Guide/metcalcpy.rst index ea6ec5b92..6794fa2b2 100644 --- a/docs/Release_Guide/metcalcpy.rst +++ b/docs/Release_Guide/metcalcpy.rst @@ -1,6 +1,5 @@ -***************** METcalcpy Release -***************** +================= .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/metcalcpy_bugfix.rst b/docs/Release_Guide/metcalcpy_bugfix.rst index 0d34c9942..b224fdb20 100644 --- a/docs/Release_Guide/metcalcpy_bugfix.rst +++ b/docs/Release_Guide/metcalcpy_bugfix.rst @@ -1,6 +1,5 @@ -========================== - METcalcpy Bugfix Release -========================== +METcalcpy Bugfix Release +------------------------ .. |projectRepo| replace:: METcalcpy diff --git a/docs/Release_Guide/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst index 4d631047d..bf9aaa635 100644 --- a/docs/Release_Guide/metcalcpy_development.rst +++ b/docs/Release_Guide/metcalcpy_development.rst @@ -1,5 +1,5 @@ METcalcpy Development Release -============================= +----------------------------- .. |projectRepo| replace:: METcalcpy diff --git a/docs/Release_Guide/metcalcpy_official.rst b/docs/Release_Guide/metcalcpy_official.rst index f5b5ef3d4..7a554eebc 100644 --- a/docs/Release_Guide/metcalcpy_official.rst +++ b/docs/Release_Guide/metcalcpy_official.rst @@ -1,5 +1,5 @@ METcalcpy Official Release -========================== +-------------------------- .. |projectRepo| replace:: METcalcpy diff --git a/docs/Release_Guide/metdataio.rst b/docs/Release_Guide/metdataio.rst index b74b47091..419bcafc8 100644 --- a/docs/Release_Guide/metdataio.rst +++ b/docs/Release_Guide/metdataio.rst @@ -1,6 +1,5 @@ -***************** METdataio Release -***************** +================= .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/metdataio_bugfix.rst b/docs/Release_Guide/metdataio_bugfix.rst index af60a91cb..096e9c260 100644 --- a/docs/Release_Guide/metdataio_bugfix.rst +++ b/docs/Release_Guide/metdataio_bugfix.rst @@ -1,5 +1,5 @@ METdataio Bugfix Release -======================== +------------------------ .. |projectRepo| replace:: METdataio .. |projectName| replace:: |projectRepo| diff --git a/docs/Release_Guide/metdataio_development.rst b/docs/Release_Guide/metdataio_development.rst index 8789d1c36..e7f3b4a18 100644 --- a/docs/Release_Guide/metdataio_development.rst +++ b/docs/Release_Guide/metdataio_development.rst @@ -1,5 +1,5 @@ METdataio Development Release -============================= +----------------------------- .. |projectRepo| replace:: METdataio .. |projectName| replace:: |projectRepo| diff --git a/docs/Release_Guide/metdataio_official.rst b/docs/Release_Guide/metdataio_official.rst index d0b54155f..a3e16ee72 100644 --- a/docs/Release_Guide/metdataio_official.rst +++ b/docs/Release_Guide/metdataio_official.rst @@ -1,5 +1,5 @@ METdataio Official Release -========================== +-------------------------- .. |projectRepo| replace:: METdataio .. |projectName| replace:: |projectRepo| diff --git a/docs/Release_Guide/metexpress.rst b/docs/Release_Guide/metexpress.rst index 158db343c..35b24c5c9 100644 --- a/docs/Release_Guide/metexpress.rst +++ b/docs/Release_Guide/metexpress.rst @@ -1,6 +1,5 @@ -****************** METexpress Release -****************** +================== .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/metexpress_development.rst b/docs/Release_Guide/metexpress_development.rst index 31b1d972a..60e7179ba 100644 --- a/docs/Release_Guide/metexpress_development.rst +++ b/docs/Release_Guide/metexpress_development.rst @@ -1,5 +1,5 @@ METexpress Development Release -============================== +------------------------------ .. |projectRepo| replace:: METexpress diff --git a/docs/Release_Guide/metexpress_official.rst b/docs/Release_Guide/metexpress_official.rst index 2b09f50d6..256c143a6 100644 --- a/docs/Release_Guide/metexpress_official.rst +++ b/docs/Release_Guide/metexpress_official.rst @@ -1,5 +1,5 @@ METexpress Official Release -=========================== +--------------------------- .. |projectRepo| replace:: METexpress diff --git a/docs/Release_Guide/metplotpy.rst b/docs/Release_Guide/metplotpy.rst index 9e6d89ba1..d2509ef4b 100644 --- a/docs/Release_Guide/metplotpy.rst +++ b/docs/Release_Guide/metplotpy.rst @@ -1,6 +1,5 @@ -***************** METplotpy Release -***************** +================= .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/metplotpy_bugfix.rst b/docs/Release_Guide/metplotpy_bugfix.rst index 25611b260..ec177ee9b 100644 --- a/docs/Release_Guide/metplotpy_bugfix.rst +++ b/docs/Release_Guide/metplotpy_bugfix.rst @@ -1,5 +1,5 @@ METplotpy Bugfix Release -======================== +------------------------ .. |projectRepo| replace:: METplotpy diff --git a/docs/Release_Guide/metplotpy_development.rst b/docs/Release_Guide/metplotpy_development.rst index a08ac7e6a..50ad0368c 100644 --- a/docs/Release_Guide/metplotpy_development.rst +++ b/docs/Release_Guide/metplotpy_development.rst @@ -1,5 +1,5 @@ METplotpy Development Release -============================= +----------------------------- .. |projectRepo| replace:: METplotpy diff --git a/docs/Release_Guide/metplotpy_official.rst b/docs/Release_Guide/metplotpy_official.rst index 2f6a68f1f..f16a82c75 100644 --- a/docs/Release_Guide/metplotpy_official.rst +++ b/docs/Release_Guide/metplotpy_official.rst @@ -1,5 +1,5 @@ METplotpy Official Release -========================== +-------------------------- .. |projectRepo| replace:: METplotpy diff --git a/docs/Release_Guide/metplus.rst b/docs/Release_Guide/metplus.rst index 070b004c8..1ca308313 100644 --- a/docs/Release_Guide/metplus.rst +++ b/docs/Release_Guide/metplus.rst @@ -1,6 +1,5 @@ -*************** METplus Release -*************** +=============== .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/metplus_bugfix.rst b/docs/Release_Guide/metplus_bugfix.rst index d2184bbf2..f4635dae4 100644 --- a/docs/Release_Guide/metplus_bugfix.rst +++ b/docs/Release_Guide/metplus_bugfix.rst @@ -1,5 +1,5 @@ METplus Bugfix Release -====================== +---------------------- .. |projectRepo| replace:: METplus diff --git a/docs/Release_Guide/metplus_development.rst b/docs/Release_Guide/metplus_development.rst index b6d568e5b..7754a7759 100644 --- a/docs/Release_Guide/metplus_development.rst +++ b/docs/Release_Guide/metplus_development.rst @@ -1,5 +1,5 @@ METplus Development Release -=========================== +--------------------------- .. |projectRepo| replace:: METplus diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst index a81edf37f..4b996155e 100644 --- a/docs/Release_Guide/metplus_official.rst +++ b/docs/Release_Guide/metplus_official.rst @@ -1,5 +1,5 @@ METplus Official Release -======================== +------------------------ .. |projectRepo| replace:: METplus diff --git a/docs/Release_Guide/metviewer.rst b/docs/Release_Guide/metviewer.rst index e8ce2be60..63b91b78d 100644 --- a/docs/Release_Guide/metviewer.rst +++ b/docs/Release_Guide/metviewer.rst @@ -1,6 +1,5 @@ -***************** METviewer Release -***************** +================= .. toctree:: :titlesonly: diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst index 24bd900f1..e8f5a35c1 100644 --- a/docs/Release_Guide/metviewer_bugfix.rst +++ b/docs/Release_Guide/metviewer_bugfix.rst @@ -1,5 +1,5 @@ METviewer Bugfix Release -======================== +------------------------ .. |projectRepo| replace:: METviewer diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 239b92899..b1af85e12 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -1,5 +1,5 @@ METviewer Development Release -============================= +----------------------------- .. |projectRepo| replace:: METviewer diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index 624195d6d..15a2e385d 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -1,5 +1,5 @@ METviewer Official Release -========================== +-------------------------- .. |projectRepo| replace:: METviewer diff --git a/docs/Release_Guide/recreate_release.rst b/docs/Release_Guide/recreate_release.rst index 0b3d847ac..520a1f733 100644 --- a/docs/Release_Guide/recreate_release.rst +++ b/docs/Release_Guide/recreate_release.rst @@ -1,5 +1,5 @@ Recreate an Existing Release ----------------------------- +============================ To recreate an existing development, bugfix, or official release: diff --git a/docs/Release_Guide/release_steps/checkout_develop_branch.rst b/docs/Release_Guide/release_steps/checkout_develop_branch.rst index ffad2b126..1f46eb042 100644 --- a/docs/Release_Guide/release_steps/checkout_develop_branch.rst +++ b/docs/Release_Guide/release_steps/checkout_develop_branch.rst @@ -1,5 +1,5 @@ Checkout the Develop Branch ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Checkout the develop branch: diff --git a/docs/Release_Guide/release_steps/checkout_main_branch.rst b/docs/Release_Guide/release_steps/checkout_main_branch.rst index 19b692a21..4b53593fe 100644 --- a/docs/Release_Guide/release_steps/checkout_main_branch.rst +++ b/docs/Release_Guide/release_steps/checkout_main_branch.rst @@ -1,5 +1,5 @@ Checkout the Main Branch ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Checkout the main branch for the X.Y release. If you are creating the |projectRepo|-X.Y.Z bugfix release, checkout main_vX.Y. diff --git a/docs/Release_Guide/release_steps/clone_project_repository.rst b/docs/Release_Guide/release_steps/clone_project_repository.rst index 7ab668a42..1003da4f5 100644 --- a/docs/Release_Guide/release_steps/clone_project_repository.rst +++ b/docs/Release_Guide/release_steps/clone_project_repository.rst @@ -1,5 +1,5 @@ Clone the Project Repository ----------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Create and work in a new directory to ensure a fresh environment: diff --git a/docs/Release_Guide/release_steps/common/update_dtc_website.rst b/docs/Release_Guide/release_steps/common/update_dtc_website.rst index ca7da0871..240474c16 100644 --- a/docs/Release_Guide/release_steps/common/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/common/update_dtc_website.rst @@ -1,5 +1,5 @@ Update DTC Website ------------------- +^^^^^^^^^^^^^^^^^^ METplus software releases are announced on the `DTC website `_. Add or update information about software releases on the website. diff --git a/docs/Release_Guide/release_steps/create_release_branch.rst b/docs/Release_Guide/release_steps/create_release_branch.rst index b220d69bc..737420a9c 100644 --- a/docs/Release_Guide/release_steps/create_release_branch.rst +++ b/docs/Release_Guide/release_steps/create_release_branch.rst @@ -1,5 +1,5 @@ Create Release Branch ---------------------- +^^^^^^^^^^^^^^^^^^^^^ * Create a branch from the develop branch for the new official release and push it to GitHub. diff --git a/docs/Release_Guide/release_steps/create_release_feature_branch.rst b/docs/Release_Guide/release_steps/create_release_feature_branch.rst index 72931767f..5d44877dc 100644 --- a/docs/Release_Guide/release_steps/create_release_feature_branch.rst +++ b/docs/Release_Guide/release_steps/create_release_feature_branch.rst @@ -1,5 +1,5 @@ Create Release Feature Branch ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Create a feature branch in which to update the version number and add release notes being sure to include the GitHub issue number for the new release. diff --git a/docs/Release_Guide/release_steps/create_release_on_github.rst b/docs/Release_Guide/release_steps/create_release_on_github.rst index 4d4723729..c9818ed65 100644 --- a/docs/Release_Guide/release_steps/create_release_on_github.rst +++ b/docs/Release_Guide/release_steps/create_release_on_github.rst @@ -1,5 +1,5 @@ Create Release on GitHub ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ * Go to Releases on GitHub and click 'Draft a new release' diff --git a/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst b/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst index 53a68993d..91dcb15ea 100644 --- a/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst +++ b/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst @@ -1,5 +1,5 @@ Finalize Release on GitHub --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Return to GitHub to finalize the details of this release. diff --git a/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst b/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst index 44499c7f4..ca9c123eb 100644 --- a/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst +++ b/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst @@ -1,5 +1,5 @@ Finalize Release on GitHub --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Return to GitHub to finalize the details of this release. diff --git a/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst b/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst index f9264d225..e3d4018ff 100644 --- a/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst +++ b/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst @@ -1,5 +1,5 @@ Finalize Release on GitHub --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Return to GitHub to finalize the details of this release. diff --git a/docs/Release_Guide/release_steps/merge_release_issue.rst b/docs/Release_Guide/release_steps/merge_release_issue.rst index da554f4da..6b9ec261b 100644 --- a/docs/Release_Guide/release_steps/merge_release_issue.rst +++ b/docs/Release_Guide/release_steps/merge_release_issue.rst @@ -1,5 +1,5 @@ Merge Release Issue -------------------- +^^^^^^^^^^^^^^^^^^^ * After updating the release-specific content on a release feature branch, submit a pull request to merge those changes back into the source branch. diff --git a/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst b/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst index c4018922d..5f4f7000c 100644 --- a/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst +++ b/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst @@ -1,5 +1,5 @@ Create Release Reference Branch -------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Create a branch from the develop branch for the reference branch for the new official release and push it to GitHub. The branch name should match @@ -13,7 +13,7 @@ Create Release Reference Branch git checkout -b main_vX.Y-ref Push Reference Branch to GitHub -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""" :: @@ -25,7 +25,7 @@ data. These data will be used to verify that any bugfixes applied to the main_vX.Y branch does not break any of existing logic. Monitor GitHub Actions Workflow -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""" Navigate to https://github.com/dtcenter/MET/actions and verify that a *Testing* workflow was triggered on the *main_vX.Y-ref* branch. diff --git a/docs/Release_Guide/release_steps/met/update_version_bugfix.rst b/docs/Release_Guide/release_steps/met/update_version_bugfix.rst index 05184f526..c432ce340 100644 --- a/docs/Release_Guide/release_steps/met/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/met/update_version_bugfix.rst @@ -1,5 +1,5 @@ Update Version Number ---------------------- +^^^^^^^^^^^^^^^^^^^^^ * Update the version in the code and documentation: diff --git a/docs/Release_Guide/release_steps/met/update_version_development.rst b/docs/Release_Guide/release_steps/met/update_version_development.rst index 70db799c4..82fc66e79 100644 --- a/docs/Release_Guide/release_steps/met/update_version_development.rst +++ b/docs/Release_Guide/release_steps/met/update_version_development.rst @@ -1,5 +1,5 @@ Update Version Number ---------------------- +^^^^^^^^^^^^^^^^^^^^^ * Prior to creating the first development release (e.g. beta1) for a new version, the official release version number should have already been updated. diff --git a/docs/Release_Guide/release_steps/met/update_version_official.rst b/docs/Release_Guide/release_steps/met/update_version_official.rst index bd0efe94f..cd9f86fc1 100644 --- a/docs/Release_Guide/release_steps/met/update_version_official.rst +++ b/docs/Release_Guide/release_steps/met/update_version_official.rst @@ -1,6 +1,7 @@ -Update Version Number ---------------------- .. _update_version_official: + +Update Version Number +^^^^^^^^^^^^^^^^^^^^^ * Update the version in the code and documentation: diff --git a/docs/Release_Guide/release_steps/met/update_web_server_data.rst b/docs/Release_Guide/release_steps/met/update_web_server_data.rst index 05274dbcd..7552a6642 100644 --- a/docs/Release_Guide/release_steps/met/update_web_server_data.rst +++ b/docs/Release_Guide/release_steps/met/update_web_server_data.rst @@ -1,8 +1,8 @@ Update DTC Web Server Data --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Create Directory for This Release -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""""" On the DTC web server where the sample input data for unit tests is hosted, create a new directory for this official major/minor release. diff --git a/docs/Release_Guide/release_steps/met/update_zenodo.rst b/docs/Release_Guide/release_steps/met/update_zenodo.rst index fdf7735c9..138aea830 100644 --- a/docs/Release_Guide/release_steps/met/update_zenodo.rst +++ b/docs/Release_Guide/release_steps/met/update_zenodo.rst @@ -1,5 +1,5 @@ Update Zenodo -------------- +^^^^^^^^^^^^^ In the `MET GitHub repository `_ scroll down to the README file and check the diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version.rst index 22e0ddc4a..2f14f2278 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst index e069da58c..d4ebf5eb7 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Update the version number for the bugfix release: diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst index 0d315b4fe..2f2796b5c 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst index 48f393083..99318b7cd 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst @@ -1,5 +1,5 @@ Update Version on Develop Branch --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Change METcalcpy/docs/version __version__ value to the next release after this one with -dev added to the end. Releases will loosely following these names, but are subject to diff --git a/docs/Release_Guide/release_steps/metdataio/update_version.rst b/docs/Release_Guide/release_steps/metdataio/update_version.rst index 55ab9b89d..2f14f2278 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: @@ -9,4 +9,4 @@ Remove **-dev** from the version number: * Remove **-dev** from the version number so that it matches the release you are creating. -* Commit changes and push to GitHub. \ No newline at end of file +* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst index 8b3c78f6c..86120b037 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst @@ -1,8 +1,8 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Update the version number for the bugfix release: * For |projectRepo|, the file containing the version number is located at docs/version. * If the current release is listed as X.Y.Z (major.minor.micro), the bugfix version should be X.Y.Z+1 - (i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1) \ No newline at end of file + (i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1) diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_official.rst b/docs/Release_Guide/release_steps/metdataio/update_version_official.rst index 45c1e9e9d..442b4cbf6 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_official.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst index 0822719c0..11632a789 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst @@ -1,5 +1,5 @@ Update Version on Develop Branch --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Change |projectRepo|/docs/version value to the next release after this one with -dev added to the end. Releases will loosely follow these names, but are subject to @@ -17,4 +17,4 @@ change: | X.Y.Z-rc1 | X.Y.Z-dev | +-------------------+-----------------------+ | X.Y.Z | (X+1).0.0-beta1-dev | -+-------------------+-----------------------+ \ No newline at end of file ++-------------------+-----------------------+ diff --git a/docs/Release_Guide/release_steps/metexpress/announce_release.rst b/docs/Release_Guide/release_steps/metexpress/announce_release.rst index 570cd0949..5307df36e 100644 --- a/docs/Release_Guide/release_steps/metexpress/announce_release.rst +++ b/docs/Release_Guide/release_steps/metexpress/announce_release.rst @@ -1,5 +1,5 @@ Announce Release -------------------- +^^^^^^^^^^^^^^^^ * Add a link for the latest production containers on https://dtcenter.org/community-code/metexpress/download. * Select both METplus and METexpress in the multi-selector box. diff --git a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst index 4f6fabb19..b621bd591 100644 --- a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst @@ -1,5 +1,5 @@ Checkout the Development Branch ----------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Checkout the development branch: diff --git a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst index 8e4a314e0..33549a8b2 100644 --- a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst +++ b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst @@ -1,5 +1,5 @@ Checkout the Development Branch ----------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Checkout the development branch: diff --git a/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst b/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst index b27a8cd7f..aab8e4a43 100644 --- a/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst @@ -1,5 +1,5 @@ Checkout the Main Branch --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Checkout the main branch of the METexpress repo. diff --git a/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst b/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst index c00d23999..becf56747 100644 --- a/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst +++ b/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst @@ -1,5 +1,5 @@ Clone the Project Repository ------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Create and work in a new directory to ensure a fresh environment: diff --git a/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst b/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst index 2a1cf13ee..6fac5f7b4 100644 --- a/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst @@ -1,5 +1,5 @@ Create Development Feature Branch ------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Create a feature branch in which to perform any required development work. diff --git a/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst b/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst index df8ddf6d8..17010885b 100644 --- a/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst +++ b/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst @@ -1,5 +1,5 @@ Deploy AWS apps -------------------- +^^^^^^^^^^^^^^^ * On metexpress.nws.noaa.gov (VPN and permissions required), go to the container_deployment directory. diff --git a/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst b/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst index ecb64e5aa..cacd1260b 100644 --- a/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst +++ b/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst @@ -1,5 +1,5 @@ Deploy Beta Apps ------------------ +^^^^^^^^^^^^^^^^ * After the apps build, which usually takes about 20 minutes, they should be installed on the dedicated beta server (mats-docker-int) for third party testing. diff --git a/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst b/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst index dbc4cf849..d6f71f109 100644 --- a/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst +++ b/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst @@ -1,5 +1,5 @@ Deploy Production Apps ------------------------ +^^^^^^^^^^^^^^^^^^^^^^ * If the beta tester approves the apps, deploy them to the production server (mats-docker). diff --git a/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst b/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst index 2b5dca8f7..bdfe7fc4f 100644 --- a/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst +++ b/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst @@ -1,5 +1,5 @@ Finalize Release on GitHub ----------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Return to GitHub to finalize the details of this release. diff --git a/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst b/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst index c6bad193d..f94228f83 100644 --- a/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst +++ b/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst @@ -1,5 +1,5 @@ Merge Development Changes to Main Branch ------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * ONLY PROCEED TO THIS STEP IF ALL OF THE AUTOMATED TESTS PASS FOR THE LATEST NIGHTLY DEVELOPMENT BUILD AT mats-docker-dev.gsd.esrl.noaa.gov (VPN required). diff --git a/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst b/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst index 74b7d9f08..7f1b765d1 100644 --- a/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst @@ -1,4 +1,4 @@ Merge Feature Branch ----------------------- +^^^^^^^^^^^^^^^^^^^^ * After making the desired code changes on a feature branch, submit a pull request to merge those changes back into the development branch. diff --git a/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst b/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst index 71544dc0d..e8e2b875c 100644 --- a/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst +++ b/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst @@ -1,5 +1,5 @@ Pull Changes, Create Release Branch, And Merge To Development ---------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * On your system, pull any build-related code changes. diff --git a/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst b/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst index 11b2c83d6..5fa31c1ca 100644 --- a/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst +++ b/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst @@ -1,5 +1,5 @@ Tag App Version and Build ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ * METexpress apps are versioned as major.minor.patch. To trigger the build of a specific version, you will need to tag the current main branch in all the repositories with the version number. diff --git a/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst b/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst index 8584573a9..210b41f4b 100644 --- a/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst +++ b/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst @@ -1,5 +1,5 @@ Update Release Notes ----------------------- +^^^^^^^^^^^^^^^^^^^^ You can refer to the GitHub Issues page to see what has changed for this release. Open the following URLs in a browser: diff --git a/docs/Release_Guide/release_steps/metplotpy/update_readme.rst b/docs/Release_Guide/release_steps/metplotpy/update_readme.rst deleted file mode 100644 index 30481b63e..000000000 --- a/docs/Release_Guide/release_steps/metplotpy/update_readme.rst +++ /dev/null @@ -1,6 +0,0 @@ -Update README -------------- -- Change 'METplotpy_develop' to replace develop with the release branch name, - i.e. 'METplotpy_main_v1.0' -- Change 'branch=develop' to replace develop with the release branch name, - i.e. 'branch=main_v4.0' diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version.rst b/docs/Release_Guide/release_steps/metplotpy/update_version.rst index 536a9bba1..4fe3d30a5 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Create the version number diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst index e9a570437..69d259dbc 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Update the version number for the bugfix release: diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst index 0d315b4fe..2f2796b5c 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst index ff744d7bb..1c382af05 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst @@ -1,5 +1,5 @@ Update Version on Develop Branch --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Change METplotpy/docs/version __version__ value to the next release after this one with -dev added to the end. Releases will loosely following these names, but are subject to diff --git a/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst b/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst index db2a4db7e..c52a3fc71 100644 --- a/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst +++ b/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst @@ -1,5 +1,5 @@ Create Release Reference Branch -------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * For METplus, the corresponding MET release must be created before starting this step. Specifically, a DockerHub tag on dtcenter/met that is named @@ -20,7 +20,7 @@ Create Release Reference Branch git checkout -b main_vX.Y-ref Update the version number -^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""" Update the content that should go into the release version but remain unchanged in the develop branch. @@ -39,7 +39,7 @@ Remove **-dev** from the version number: Commit these changes. Push Reference Branch to GitHub -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""" :: @@ -51,7 +51,7 @@ data. These data will be used to verify that any bugfixes applied to the main_vX.Y branch does not break any of existing logic. Monitor GitHub Actions Workflow -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""" Navigate to https://github.com/dtcenter/METplus/actions and verify that a *Testing* workflow was triggered on the *main_vX.Y-ref* branch. @@ -64,7 +64,7 @@ Navigate to https://github.com/dtcenter/METplus/actions and verify that a of these volumes start with *output-*. Create main branch and push to GitHub -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""""""""" * After the truth data volumes have been generated, create the main_vX.Y branch off of the -ref branch. diff --git a/docs/Release_Guide/release_steps/metplus/update_manage_externals.rst b/docs/Release_Guide/release_steps/metplus/update_manage_externals.rst index 850a55ae2..adc564a51 100644 --- a/docs/Release_Guide/release_steps/metplus/update_manage_externals.rst +++ b/docs/Release_Guide/release_steps/metplus/update_manage_externals.rst @@ -1,5 +1,5 @@ Update the version numbers in the manage externals files --------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ There are a few .cfg files used by Manage Externals that should include the correct tag or branch that corresponds to the @@ -38,7 +38,7 @@ For the METplus **5.0**.0 release: When in doubt, check the components' repository or ask another developer. Update build_components/Externals_stable.cfg -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +"""""""""""""""""""""""""""""""""""""""""""" Ensure the *tag* for each component is correct. It should match the format **vX.Y.Z** where X.Y.Z is the version of that component. @@ -46,14 +46,14 @@ For example, MET should be **v11.0.0** for METplus 5.0.0. Update .github/parm/Externals_metdataio_stable.cfg -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +"""""""""""""""""""""""""""""""""""""""""""""""""" Ensure the *branch* value is correct. It should match the format **main_vX.Y** where X.Y is the version of that component. For example, METdataio should be **main_v2.0** for METplus 5.0.0. Update .github/parm/Externals_metplotcalcpy_stable.cfg -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +"""""""""""""""""""""""""""""""""""""""""""""""""""""" Ensure the *branch* for each component is correct. It should match the format **main_vX.Y** where X.Y is the version of that component. diff --git a/docs/Release_Guide/release_steps/metplus/update_release_date.rst b/docs/Release_Guide/release_steps/metplus/update_release_date.rst index 0154d383f..b04c5b677 100644 --- a/docs/Release_Guide/release_steps/metplus/update_release_date.rst +++ b/docs/Release_Guide/release_steps/metplus/update_release_date.rst @@ -1,5 +1,5 @@ Update Release Date -------------------- +^^^^^^^^^^^^^^^^^^^ * The release date is stored in *metplus/RELEASE_DATE* in YYYYMMDD format. * Change the value stored in this file to match the current date. diff --git a/docs/Release_Guide/release_steps/metplus/update_version.rst b/docs/Release_Guide/release_steps/metplus/update_version.rst index 419e487b6..c62860d3f 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: diff --git a/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst index 4b76d9d71..105ae74d8 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Update the version number for the bugfix release: diff --git a/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst index cbad49ae5..a34a1dc01 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst @@ -1,5 +1,5 @@ Update Version on Develop Branch --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Switch to the develop branch and change metplus/VERSION value to the next release after this one with -dev added to the end. diff --git a/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst b/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst index c606b9232..8f7d664bf 100644 --- a/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst +++ b/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst @@ -1,8 +1,8 @@ Update DTC Web Server Data --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Create Directory for Next Release -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""""""""""""""" On the DTC web server where the sample input data for use cases is hosted, run the setup_next_release_data.py script for the next upcoming release diff --git a/docs/Release_Guide/release_steps/metviewer/update_version.rst b/docs/Release_Guide/release_steps/metviewer/update_version.rst index f55a9408d..a184af6f3 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Create the version number diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst index e10fa8adb..7c1b59ec5 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Update the version number for the bugfix release: diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst index 35a584da5..cfc694bfb 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -1,5 +1,5 @@ Update Version Number for Release ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Remove **-dev** from the version number: diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst index 5488628e1..8171373ec 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst @@ -1,5 +1,5 @@ Update Version on Develop Branch --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Change METviewer/docs/version __version__ value to the next release after this one with -dev added to the end. Releases will loosely following these names, but are subject to diff --git a/docs/Release_Guide/release_steps/open_release_issue.rst b/docs/Release_Guide/release_steps/open_release_issue.rst index 46cdc15d8..35042da08 100644 --- a/docs/Release_Guide/release_steps/open_release_issue.rst +++ b/docs/Release_Guide/release_steps/open_release_issue.rst @@ -1,5 +1,5 @@ Open Release Issue ------------------- +^^^^^^^^^^^^^^^^^^ * Define a new issue in the |projectRepo| repository to create the new release. diff --git a/docs/Release_Guide/release_steps/push_release_branch.rst b/docs/Release_Guide/release_steps/push_release_branch.rst index afacac78c..589670b33 100644 --- a/docs/Release_Guide/release_steps/push_release_branch.rst +++ b/docs/Release_Guide/release_steps/push_release_branch.rst @@ -1,5 +1,5 @@ Push Release Branch to GitHub ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Push the release branch to GitHub:: diff --git a/docs/Release_Guide/release_steps/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/release_acceptance_testing.rst index a5cad0182..d46e10c64 100644 --- a/docs/Release_Guide/release_steps/release_acceptance_testing.rst +++ b/docs/Release_Guide/release_steps/release_acceptance_testing.rst @@ -1,5 +1,5 @@ Release Acceptance Testing --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ A single `Release Acceptance Testing `_ diff --git a/docs/Release_Guide/release_steps/rotate_authorship.rst b/docs/Release_Guide/release_steps/rotate_authorship.rst index 69bebee81..bd7d57016 100644 --- a/docs/Release_Guide/release_steps/rotate_authorship.rst +++ b/docs/Release_Guide/release_steps/rotate_authorship.rst @@ -1,5 +1,5 @@ Rotate Authorship ------------------ +^^^^^^^^^^^^^^^^^ The METplus team rotates the list of authors in the citation instructions for each official release: diff --git a/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst b/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst index ef9700638..bf60ed0ea 100644 --- a/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst +++ b/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst @@ -1,5 +1,5 @@ Set up Reminder to Delete Beta/RC Tags and Releases ---------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Help keep the GitHub repositories and DockerHub clean by removing beta/rc tags and releases. diff --git a/docs/Release_Guide/release_steps/update_docs_official.rst b/docs/Release_Guide/release_steps/update_docs_official.rst index cd4a69858..9250763b1 100644 --- a/docs/Release_Guide/release_steps/update_docs_official.rst +++ b/docs/Release_Guide/release_steps/update_docs_official.rst @@ -1,5 +1,5 @@ Update the Documentation on the Web ------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Because Read the Docs is configured to automate the building of new "main" branches in the METplus components' repositories, nothing needs to be done diff --git a/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst b/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst index 7fe434dea..bbdebb768 100644 --- a/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst +++ b/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst @@ -1,5 +1,5 @@ Update Release Notes --------------------- +^^^^^^^^^^^^^^^^^^^^ You can refer to the GitHub Project board to see what has changed for this release. Open the following URL in a browser: diff --git a/docs/Release_Guide/release_steps/update_release_notes_development.rst b/docs/Release_Guide/release_steps/update_release_notes_development.rst index 72c2d1ce2..1baf3ef0f 100644 --- a/docs/Release_Guide/release_steps/update_release_notes_development.rst +++ b/docs/Release_Guide/release_steps/update_release_notes_development.rst @@ -1,5 +1,5 @@ Update Release Notes --------------------- +^^^^^^^^^^^^^^^^^^^^ You can refer to the GitHub Project board to see what has changed for this release. Open the following URL in a browser: diff --git a/docs/Release_Guide/release_steps/update_release_notes_official.rst b/docs/Release_Guide/release_steps/update_release_notes_official.rst index d9e39e954..d7509609a 100644 --- a/docs/Release_Guide/release_steps/update_release_notes_official.rst +++ b/docs/Release_Guide/release_steps/update_release_notes_official.rst @@ -1,5 +1,5 @@ Update Release Notes --------------------- +^^^^^^^^^^^^^^^^^^^^ You can refer to the GitHub Project board to see what has changed for this release. Open the following URL in a browser: diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst index bb28f258b..4a8bf6c5a 100644 --- a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -1,5 +1,5 @@ Update Upgrade Instructions ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Occasionally, changes will be made to software that will require users to make changes to their configuration files in order to use the latest release. For diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst index 8b83178d2..1941032aa 100644 --- a/docs/Users_Guide/glossary.rst +++ b/docs/Users_Guide/glossary.rst @@ -3391,7 +3391,7 @@ METplus Configuration Glossary POINT_STAT_GRID Specify the grid to use with the MET point_stat tool. - .. note:: please use :term:`POINT_STAT_MASK_GRID` + .. warning:: **DEPRECATED:** please use :term:`POINT_STAT_MASK_GRID` | *Used by:* PointStat @@ -3418,12 +3418,12 @@ METplus Configuration Glossary POINT_STAT_POLY Specify a polygon to use with the MET PointStat tool. - .. note:: please use :term:`POINT_STAT_MASK_POLY` + .. warning:: **DEPRECATED:** Please use :term:`POINT_STAT_MASK_POLY` | *Used by:* PointStat PB2NC_POLY - .. note:: please use :term:`PB2NC_MASK_POLY` + .. warning:: **DEPRECATED:** Please use :term:`PB2NC_MASK_POLY` | *Used by:* PB2NC diff --git a/docs/Users_Guide/installation.rst b/docs/Users_Guide/installation.rst index acee4efd1..3910bdca9 100644 --- a/docs/Users_Guide/installation.rst +++ b/docs/Users_Guide/installation.rst @@ -9,7 +9,7 @@ Introduction This chapter describes how to download and set up METplus Wrappers. -Supported architectures +Supported Architectures ======================= METplus Wrappers was developed on Debian Linux and is supported on this @@ -22,7 +22,7 @@ including those at NCAR, NOAA, and other community machines. Pre-built METplus images on DockerHub are also provided. See :ref:`metplus-docker` for information on running METplus using Docker. -Programming/scripting languages +Programming/Scripting Languages =============================== METplus Wrappers is written in Python. It is intended to be a tool @@ -110,14 +110,14 @@ Cartopy, one of the dependencies of CyclonePlotter, attempts to download shapefi .. _getcode: -Getting the METplus Wrappers source code +Getting the METplus Wrappers Source Code ======================================== The METplus Wrappers source code is available for download from the public GitHub repository. The source code can be retrieved either through a web browser or the command line. -Get the source code via Web Browser +Get the Source Code via Web Browser ----------------------------------- - Create a directory where the METplus Wrappers will be installed @@ -156,7 +156,7 @@ Tar File:: - Uncompress the source code (on Linux/Unix\ *: gunzip* for zip file or *tar xvfz* for the tar.gz file) -Get the source code via Command Line +Get the Source Code via Command Line ------------------------------------ - Open a shell terminal @@ -173,7 +173,7 @@ HTTPS:: .. _obtain_sample_input_data: -Obtain sample input data +Obtain Sample Input Data ======================== The use cases provided with the METplus release have sample input data @@ -201,7 +201,7 @@ the example use cases, which illustrate how the wrappers work. have already been obtained with a previous release. -METplus Wrappers directory structure +METplus Wrappers Directory Structure ==================================== The METplus Wrappers source code contains the following directory structure:: @@ -255,7 +255,7 @@ External Components .. _external-components-gfdl-tracker: -GFDL Tracker (optional) +GFDL Tracker (Optional) ----------------------- - The standalone Geophysical Fluid Dynamics Laboratory (GFDL) vortex tracker @@ -277,7 +277,7 @@ GFDL Tracker (optional) - Instructions on how to configure and use the GFDL tracker are found here https://dtcenter.org/sites/default/files/community-code/gfdl/standalone_tracker_UG_v3.9a.pdf -Disable UserScript wrapper (optional) +Disable UserScript Wrapper (Optional) ===================================== The UserScript wrapper allows any shell command or script to be run as part @@ -294,7 +294,7 @@ Please note that use cases provided with the METplus repository that utilize the UserScript wrapper will fail if attempted to run after it has been disabled. -Add ush directory to shell path (optional) +Add ush Directory to Shell Path (Optional) ========================================== To call the run_metplus.py script from any directory, add the ush directory diff --git a/docs/Users_Guide/statistics_list.rst b/docs/Users_Guide/statistics_list.rst index 537c3063f..076466e97 100644 --- a/docs/Users_Guide/statistics_list.rst +++ b/docs/Users_Guide/statistics_list.rst @@ -15,7 +15,7 @@ Statistics Database Statistics List A-B -___________________ +------------------- .. role:: raw-html(raw) :format: html @@ -137,7 +137,7 @@ ___________________ - PSTD Statistics List C-E -___________________ +------------------- .. role:: raw-html(raw) :format: html @@ -307,7 +307,7 @@ ___________________ SSVAR Statistics List F -_________________ +----------------- .. list-table:: Statistics List F :widths: auto @@ -528,8 +528,8 @@ _________________ NBRCTC Statistics List G-M -___________________ - +------------------- + .. role:: raw-html(raw) :format: html @@ -734,7 +734,7 @@ ___________________ - VCNT Statistics List N-O -___________________ +------------------- .. role:: raw-html(raw) :format: html @@ -909,7 +909,7 @@ ___________________ Statistics List P-R -___________________ +------------------- .. role:: raw-html(raw) @@ -1130,7 +1130,7 @@ ___________________ Statistics List S-T -___________________ +------------------- .. role:: raw-html(raw) @@ -1246,7 +1246,7 @@ ___________________ Statistics List U-Z -___________________ +------------------- .. role:: raw-html(raw) :format: html @@ -1433,7 +1433,7 @@ Diagnostics Database METplus Line Type - currently unlimited (approx 33 characters) Diagnostics List A-B -____________________ +-------------------- .. role:: raw-html(raw) :format: html @@ -1514,7 +1514,7 @@ ____________________ - MODE obj Diagnostics List C-E -____________________ +-------------------- .. role:: raw-html(raw) :format: html @@ -1680,7 +1680,7 @@ ____________________ - MTD 3D obj Diagnostics List F -__________________ +------------------ .. role:: raw-html(raw) :format: html @@ -1936,7 +1936,7 @@ __________________ Diagnostics List G-L -____________________ +-------------------- .. role:: raw-html(raw) :format: html @@ -2078,7 +2078,7 @@ ____________________ Diagnostics List M-O -____________________ +-------------------- .. role:: raw-html(raw) :format: html @@ -2253,7 +2253,7 @@ ____________________ Diagnostics List P-Z -____________________ +-------------------- .. role:: raw-html(raw) :format: html diff --git a/docs/Verification_Datasets/datasets.rst b/docs/Verification_Datasets/datasets.rst index 9b202b18f..45b78ec5f 100644 --- a/docs/Verification_Datasets/datasets.rst +++ b/docs/Verification_Datasets/datasets.rst @@ -1,5 +1,6 @@ -Datasets -======== +******** +Datasets +******** .. toctree:: :titlesonly: diff --git a/docs/Verification_Datasets/datasets/aeronet.rst b/docs/Verification_Datasets/datasets/aeronet.rst index 08e9f10ce..60a626abd 100644 --- a/docs/Verification_Datasets/datasets/aeronet.rst +++ b/docs/Verification_Datasets/datasets/aeronet.rst @@ -1,7 +1,7 @@ .. _vx-data-aeronet: AERONET -------- +======= Description AErosol RObotic NETwork (AERONET) - This is data from a group of ground-based remote sensing aerosol networks, providing globally distributed observations of aerosol optical depth (AOD) and related fields. This application focuses on AOD, specifically. diff --git a/docs/Verification_Datasets/datasets/gdas_ice.rst b/docs/Verification_Datasets/datasets/gdas_ice.rst index 3a8d19e7d..388b2ec42 100644 --- a/docs/Verification_Datasets/datasets/gdas_ice.rst +++ b/docs/Verification_Datasets/datasets/gdas_ice.rst @@ -1,7 +1,7 @@ .. _vx-data-gdas-ice: GDAS: Ice ---------- +========= Description "The Global Data Assimilation System (GDAS) is the system used by the National Center for Environmental Prediction (NCEP) Global Forecast System (GFS) model to place observations into a gridded model space for the purpose of starting, or initializing, weather forecasts with observed data." from NOAA NCEI @@ -13,10 +13,10 @@ Sample image :width: 600 Recommended use -"Place observations into a gridded model space for the purpose of starting, or initializing, weather forecasts with observed data” from NOAA NCEI + "Place observations into a gridded model space for the purpose of starting, or initializing, weather forecasts with observed data” from NOAA NCEI File format -* Grib2 + * Grib2 Location of data NCDC/NCEI: https://www.ncdc.noaa.gov/data-access/model-data/model-datasets/global-data-assimilation-system-gdas diff --git a/docs/Verification_Datasets/datasets/gdas_prepbufr.rst b/docs/Verification_Datasets/datasets/gdas_prepbufr.rst index 4c2848de9..0fa11c195 100644 --- a/docs/Verification_Datasets/datasets/gdas_prepbufr.rst +++ b/docs/Verification_Datasets/datasets/gdas_prepbufr.rst @@ -1,7 +1,7 @@ .. _vx-data-gdas-prepbufr: GDAS Prepbufr Data ------------------- +================== Description Global Data Assimilation System (GDAS) prepbufr files contain a variety of upper-air and surface weather observations from around the globe, including radiosonde, profiler and US radar derived winds, land and marine surface reports, aircraft reports, and more. diff --git a/docs/Verification_Datasets/datasets/goes_level_1b.rst b/docs/Verification_Datasets/datasets/goes_level_1b.rst index fda714672..fa46d0b7e 100644 --- a/docs/Verification_Datasets/datasets/goes_level_1b.rst +++ b/docs/Verification_Datasets/datasets/goes_level_1b.rst @@ -1,7 +1,7 @@ .. _vx-data-goes-level-1b.rst: GOES ABI L1b Radiances ----------------------- +====================== Description Geostationary Operational Environmental Satellite (GOES-16/17) Advanced Baseline Imagers (ABIs) Data - Level 1b Radiances diff --git a/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst b/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst index c461f77d0..d6fecac9c 100644 --- a/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst +++ b/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst @@ -1,7 +1,7 @@ .. _vx-data-goes-level-2-aerosol.rst: GOES ABI L2 Aerosol -------------------- +=================== Description Geostationary Operational Environmental Satellite (GOES-16/17) Advanced Baseline Imagers (ABIs) Data - Level 2 Aerosol Products diff --git a/docs/Verification_Datasets/datasets/gpm_imerg.rst b/docs/Verification_Datasets/datasets/gpm_imerg.rst index d625a5b1e..b1a34a143 100644 --- a/docs/Verification_Datasets/datasets/gpm_imerg.rst +++ b/docs/Verification_Datasets/datasets/gpm_imerg.rst @@ -1,7 +1,7 @@ .. _vx-data-gpm-imerg: GPM IMERG ---------- +========= Description Global Precipitation Measurement (GPM) Integrated Multi-satellitE Retrievals for GPM (IMERG) diff --git a/docs/Verification_Datasets/datasets/ims_ice.rst b/docs/Verification_Datasets/datasets/ims_ice.rst index a2e10f35e..e58f5c167 100644 --- a/docs/Verification_Datasets/datasets/ims_ice.rst +++ b/docs/Verification_Datasets/datasets/ims_ice.rst @@ -1,7 +1,7 @@ .. _vx-data-ims-ice: IMS ---- +=== Description IMS stands for the Interactive Multisensor Snow and Ice Mapping System. diff --git a/docs/Verification_Datasets/datasets/madis.rst b/docs/Verification_Datasets/datasets/madis.rst index dcd42a0cd..0d477a93f 100644 --- a/docs/Verification_Datasets/datasets/madis.rst +++ b/docs/Verification_Datasets/datasets/madis.rst @@ -1,7 +1,7 @@ .. _vx-data-madis: MADIS Data ----------- +========== Description Meteorological Assimilation Data Ingest System (MADIS) consists of NOAA and non-NOAA data providers and provides observational data in a common format, with quality checks. This information is focused on METAR data. diff --git a/docs/Verification_Datasets/datasets/metar_isu.rst b/docs/Verification_Datasets/datasets/metar_isu.rst index 1c2703ac1..571820311 100644 --- a/docs/Verification_Datasets/datasets/metar_isu.rst +++ b/docs/Verification_Datasets/datasets/metar_isu.rst @@ -1,7 +1,7 @@ .. _vx-data-metar-isu: METAR Data ----------- +========== Description Meteorological Aviation Routine Weather Report (METAR) is a format for observational weather data, which typically comes from airports or permanent observing stations around the world. diff --git a/docs/Verification_Datasets/datasets/mping.rst b/docs/Verification_Datasets/datasets/mping.rst index 6d3b2e24c..70d5064c4 100644 --- a/docs/Verification_Datasets/datasets/mping.rst +++ b/docs/Verification_Datasets/datasets/mping.rst @@ -1,7 +1,7 @@ .. _vx-data-mping: mPING ------ +===== Description Meteorological Phenomena Identification Near the Ground (mPING) is a crowd-sourced weather observing network developed through partnership between the National Severe Storms Laboratory, The University of Oklahoma, and the Cooperative Institute for Mesoscale Meteorological Studies. diff --git a/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst b/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst index 49b852b5d..922987499 100644 --- a/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst +++ b/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst @@ -1,7 +1,7 @@ .. _vx-data-mrms-composite-reflectivity: MRMS Composite Reflectivity ---------------------------- +=========================== Description Multi-radar/multi-sensor (MRMS) composite reflectivity diff --git a/docs/Verification_Datasets/datasets/nexrad_level_2.rst b/docs/Verification_Datasets/datasets/nexrad_level_2.rst index e02e14ae3..4f68e2d21 100644 --- a/docs/Verification_Datasets/datasets/nexrad_level_2.rst +++ b/docs/Verification_Datasets/datasets/nexrad_level_2.rst @@ -1,7 +1,7 @@ .. _vx-data-nexrad-level-2: NEXRAD Level 2 --------------- +============== Description Next-Generation Radar (NEXRAD) Level 2, gridded radial diff --git a/docs/Verification_Datasets/datasets/nexrad_level_3.rst b/docs/Verification_Datasets/datasets/nexrad_level_3.rst index 5212783e6..57fd35dbc 100644 --- a/docs/Verification_Datasets/datasets/nexrad_level_3.rst +++ b/docs/Verification_Datasets/datasets/nexrad_level_3.rst @@ -1,7 +1,7 @@ .. _vx-data-nexrad-level-3: NEXRAD Level 3 --------------- +============== Description Next-Generation Radar (NEXRAD) Level 3, gridded radial diff --git a/docs/Verification_Datasets/datasets/opera_eumetnet.rst b/docs/Verification_Datasets/datasets/opera_eumetnet.rst index 7353e9912..844a765a8 100644 --- a/docs/Verification_Datasets/datasets/opera_eumetnet.rst +++ b/docs/Verification_Datasets/datasets/opera_eumetnet.rst @@ -2,7 +2,7 @@ OPERA EUMETNET --------------- +============== Description Operational Program for Exchange of Weather Radar Information (OPERA) European National Meteorological Services (EUMETNET) diff --git a/docs/Verification_Datasets/datasets/template.rst b/docs/Verification_Datasets/datasets/template.rst index 2c6a13021..172a3e6e8 100644 --- a/docs/Verification_Datasets/datasets/template.rst +++ b/docs/Verification_Datasets/datasets/template.rst @@ -5,7 +5,7 @@ Define a vx-data name above and add it to the alphabetical list in datasets.rst. *Insert Dataset Name Here* --------------------------- +========================== Description *Insert description here* diff --git a/docs/Verification_Datasets/datasets/viirs.rst b/docs/Verification_Datasets/datasets/viirs.rst index 20f61c156..8cd04945d 100644 --- a/docs/Verification_Datasets/datasets/viirs.rst +++ b/docs/Verification_Datasets/datasets/viirs.rst @@ -1,7 +1,7 @@ .. _vx-data-viirs: VIIRS ------ +===== Description Visible Infrared Imaging Radiometer Suite (VIIRS) diff --git a/docs/Verification_Datasets/index.rst b/docs/Verification_Datasets/index.rst index 2eaea2abd..88298a113 100644 --- a/docs/Verification_Datasets/index.rst +++ b/docs/Verification_Datasets/index.rst @@ -1,7 +1,6 @@ - -=========================== +########################### Verification Datasets Guide -=========================== +########################### .. toctree:: :titlesonly: diff --git a/docs/Verification_Datasets/overview.rst b/docs/Verification_Datasets/overview.rst index b6bb9068d..e536b7ca8 100644 --- a/docs/Verification_Datasets/overview.rst +++ b/docs/Verification_Datasets/overview.rst @@ -1,5 +1,6 @@ -Overview -======== +******** +Overview +******** One of biggest challenges in verification is identifying appropriate and available datasets. While countless observations and analyses exist for both standard (e.g., temperature, pressure, wind, and precipitation) and non-state (e.g., aerosol optical depth, composite reflectivity, and turbulence) variables, it is often difficult to identify, procure, and apply the necessary datasets needed for a robust model evaluation. To address the need for a centralized catalogue of verification datasets, the DTC has assembled an initial version of the Verification Datasets Guide to provide the model verification community with relevant “truth” datasets, including data from satellite platforms (geostationary and polar orbiting), gridded analyses (global and regional), station or point-based datasets (global and regional), and radar networks. diff --git a/docs/Verification_Datasets/quicksearch.rst b/docs/Verification_Datasets/quicksearch.rst index b19956629..bb2d16277 100644 --- a/docs/Verification_Datasets/quicksearch.rst +++ b/docs/Verification_Datasets/quicksearch.rst @@ -1,21 +1,25 @@ .. _quicksearch: +************************* Quick Search for Datasets -========================= +************************* Dataset Types -------------- +============= + | `Point Data <../search.html?q=DataTypePoint&check_keywords=yes&area=default>`_ | `Gridded Data <../search.html?q=DataTypeGridded&check_keywords=yes&area=default>`_ -Dataset Levels --------------- +Dataset Levels +============== + | `Surface Data <../search.html?q=DataLevelSurface&check_keywords=yes&area=default>`_ | `Upper-Air Data <../search.html?q=DataLevelUpperAir&check_keywords=yes&area=default>`_ | `Satellite Data <../search.html?q=DataLevelSatellite&check_keywords=yes&area=default>`_ -Dataset Providers ------------------ +Dataset Providers +================= + | `EUMETNET <../search.html?q=DataProviderEUMETNET&check_keywords=yes&area=default>`_ | `ISU <../search.html?q=DataProviderISU&check_keywords=yes&area=default>`_ | `NOAA <../search.html?q=DataProviderNOAA&check_keywords=yes&area=default>`_ @@ -25,7 +29,8 @@ Dataset Providers | `NSIDC <../search.html?q=DataProviderNSIDC&check_keywords=yes&area=default>`_ Dataset Applications --------------------- +==================== + | `Climate <../search.html?q=DataApplicationClimate&check_keywords=yes&area=default>`_ | `Ensemble <../search.html?q=DataApplicationEnsemble&check_keywords=yes&area=default>`_ | `Marine and Cryosphere <../search.html?q=DataApplicationMarineAndCryo&check_keywords=yes&area=default>`_ diff --git a/docs/index.rst b/docs/index.rst index 65fd718cf..00b89ef73 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -127,12 +127,17 @@ To cite this documentation in publications, please refer to the METplus User's G .. toctree:: :hidden: - :caption: METplus Wrappers Guides + :caption: FOR USERS Users_Guide/index + Verification_Datasets/index + +.. toctree:: + :hidden: + :caption: FOR CONTRIBUTORS + Contributors_Guide/index Release_Guide/index - Verification_Datasets/index Index