diff --git a/docs/Contributors_Guide/add_use_case.rst b/docs/Contributors_Guide/add_use_case.rst index e75af2ef3..e7b9957a1 100644 --- a/docs/Contributors_Guide/add_use_case.rst +++ b/docs/Contributors_Guide/add_use_case.rst @@ -16,32 +16,45 @@ instructions to fill out the template. This branch will be the source of the pull request to merge the changes into the develop branch. +Types of Use Cases +------------------ + +* Use cases that involve a single MET tool/METplus wrapper will reside + in the *METplus/parm/use_cases/met_tool_wrapper* directory. + +* Use cases that involve multiple MET tools/METplus wrappers will reside + in the *METplus/parm/use_cases/model_applications* directory, under a + subdirectory that corresponds to a specific category. .. _use_case_categories: Use Case Categories ------------------- -New use cases will be put in the repository under +New MET tool wrapper use cases will be put in the repository under +parm/use_cases/met_tool_wrapper/ where +is the name of the MET tool being wrapped. + +New model applications use cases will be put in the repository under parm/use_cases/model_applications/ where is one of the following: -* medium_range -* s2s (Subseasonal to Seasonal) +* air_quality_and_comp +* climate +* coastal * convection_allowing_models -* data_assimilation -* space_weather -* marine * cryosphere -* coastal -* air_quality -* pbl -* land_surface +* data_assimilation * extremes -* climate +* land_surface +* marine_and_coastal +* medium_range +* miscellaneous +* pbl * precipitation +* s2s (Subseasonal to Seasonal) +* space_weather * tc_and_extra_tc (Tropcial Cyclone and Extra Tropical Cyclone) -* miscellaneous If you feel that the new use case does not fall into any of these categories or are unsure which category is the most appropriate, please contact MET Help @@ -53,8 +66,19 @@ Use Case Content Configure New Use Case ^^^^^^^^^^^^^^^^^^^^^^ -In the category sub-directory (parm/use_cases/model_applications/), -each use case should have the following: +If creating a new MET tool wrapper use case, in the MET tool name +sub-directory (parm/use_cases/met_tool_wrapper/), each +use case should have the following: + +* A METplus configuration file where the MET tool name follows PascalCase, + e.g. GridStat.conf or ASCII2NC.conf. + If the use case uses a Python embedding script, it should be + indicasted in the by adding "_python_embedding" to the MET tool name. + e.g. GridStat_python_embedding.conf + +If creating a new model applications use case, in the category sub-directory +(parm/use_cases/model_applications/), each use case should have the +following: * A METplus configuration file named \_fcst\_obs\_cilmo\\.conf where @@ -150,13 +174,15 @@ would look something like this:: The content of this file is rendered above the icons for the use cases in this category in the User's Guide > METplus Use Cases > -`Model Applications `_ +`Model Applications `_ page. Add Sphinx Documentation File """"""""""""""""""""""""""""" -In the corresponding documentation category directory +In the corresponding documentation MET tool name directory +(**docs**/use_cases/met_tool_wrapper/) for a met_tool_wrappers +use case OR category directory for a model_applications use case (**docs**/use_cases/model_applications/), add: * A Python Sphinx Documentation (.py) file with the same name as the METplus @@ -179,7 +205,7 @@ In the corresponding documentation category directory a list of possible keywords to use (Note: The link text for the keywords must match the actual keyword exactly or it will not show up in the search, i.e. **ASCII2NCToolUseCase** must match - https://dtcenter.github.io/METplus/search.html?q=**ASCII2NCToolUseCase** + https://metplus.readthedocs.io/en/latest/search.html?q=**ASCII2NCToolUseCase** * Add an image to use as the thumbnail (if desired). Images can be added to the docs/_static directory and should be named -.png @@ -197,9 +223,23 @@ In the corresponding documentation category directory avoid ending a line with this character to avoid generating warnings in the documentation. +Accessing the Documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Build the Documentation -^^^^^^^^^^^^^^^^^^^^^^^ +It is important to ensure that the new use case files is displayed and the +formatting looks correct. Prior to the release of METplus v4.0.0 contributors +were required to build the documentation manually. However, the METplus +components now use Read the Docs to build and display the documentation. For +more information on how to view the newly added use case, see the +:ref:`Read the Docs METplus Documenation `. Contributors can +still build the documentation manually if desired. See the +:ref:`Build the Documentation Manually ` section below for more +information. + +.. _manual-build: + +Build the Documentation Manually +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Build the documentation and ensure that the new use case file is displayed and the formatting looks correct. The Python packages sphinx, @@ -1113,4 +1153,3 @@ Remove the tarfile and environment file from the staging directory:: ls ${METPLUS_USER_ENV_FILE} rm ${METPLUS_USER_ENV_FILE} - diff --git a/docs/Contributors_Guide/documentation.rst b/docs/Contributors_Guide/documentation.rst index b6694b280..1562770ba 100644 --- a/docs/Contributors_Guide/documentation.rst +++ b/docs/Contributors_Guide/documentation.rst @@ -5,25 +5,20 @@ Viewing METplus documentation _____________________________ The METplus documentation (beginning with version 3.0) is available -`online `_. - - +`online `_. Doxygen Source Code Documentation _________________________________ -The source code documentation is found -`here `_. - +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. +generator tool, which was originally created for Python documentation. The documentation is created using `reStructuredText (rst) `_. @@ -44,28 +39,25 @@ Contributor's Guide. Description of Documentation Directories ________________________________________ -Core documentation is divided into two sections: the User's Guide and -Contributor's Guide, both of which reside under the *METplus/docs* -directory, with files ending in .rst. - +Core documentation is divided into four sections: User's Guide, Contributor's +Guide, Release Guide, and Verification Datasets Guide all of which reside +under the *METplus/docs* directory and contain files ending in .rst. Documentation for the use cases is found in the following directories: -* *METplus/parm/met_tools* +* *METplus/docs/use_cases/met_tool_wrapper* - * This directory contains documentation pertaining to use cases - that use one MET *tool/METplus* wrapper. + * This directory contains documentation pertaining to use cases that use + one MET *tool/METplus* wrapper. -* *METplus/parm/model_applications* +* *METplus/docs/use_cases/model_applications* - * This directory contains documentation pertaining to use cases - that are based on model data, and utilize more than one - MET tool/METplus wrapper. The corresponding METplus - configuration files to these use cases have the same name - as the .py files, with a .conf file extension. + * This directory contains documentation pertaining to use cases that are + based on model data, and utilize more than one MET tool/METplus + wrapper. -Documentation files end with a .py extension and these files generate the -clickable graphics in the gallery. +Please refer to the :ref:`Document New Use Case ` +section for more information on documenting a new use case. Adding New Documentation @@ -73,69 +65,20 @@ ________________________ To determine where to add new documentation: -* Use cases that involve a single MET tool/METplus wrapper will reside - in the *METplus/parm/use_cases/met_tool_wrapper* directory. - -* Use cases that involve multiple MET tools/METplus wrappers will reside - in the *METplus/parm/use_cases/model_applications* directory, under - a subdirectory that corresponds to a specific category. - * The User's Guide for any instructions or details that will enable a user to run/use the use case and/or new code. -* The Contributor's Guide for any instructions for instructions on - creating/constructing the new code. - - -Use cases that have only one MET tool/METplus wrapper: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* Create a new subdirectory, based on the name of the MET tool: - e.g. *METplus/parm/use_cases/met_tool_wrapper/ASCII2NC* +* The Contributor's Guide for instructions on creating/constructing new + code. -* Create a new Python file with the .py extension. - - * For a use case document in the *METplus/parm/use_cases/met_tools* - directory, follow this pattern: +* The Release Guide for instructions for creating software releases for any + METplus component, including official, bugfix, and development releases. - .py +* The Verification Datasets Guide for any 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. - Where the MET tool name follows PascalCase, e.g. GridStat.py or - ASCII2NC.py. This file is a hybrid RST and Python file. - -* Add a METplus configuration file for this use case, using the same - name as the .py file above, except replace the .py extension with - .conf. The contents of this file will be pulled into the .py file - that was created. - - -Use cases that use more than one MET tool/METplus wrapper: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* The model_applications directory contains subdirectories that - are based on the following categories: - - * climate - * convection_allowing_models - * cryosphere - * data_assimilation - * medium_range - * precipitation - * s2s (sub-seasonal to seasonal) - * space_weather - * tc_and_extra_tc - - * For documenting a use case that spans more than one MET tool/ - METplus wrapper, determine which category to place the - documentation. - - * If no category exists, create a new subdirectory with the - name of the new category. - - * Create a new Python (.py) file with a descriptive - name, following the convention: - - .py User's Guide: ~~~~~~~~~~~~~ @@ -157,25 +100,90 @@ Contributor's Guide: * Modify any of the affected sections from the *METplus/docs/Contributors_Guide* directory: - * add_use_case.rst (How to add new use cases.) - * basic_components.rst (The basic components of a METplus wrapper.) - * coding_standards.rst (The coding standards currently in use.) + * add_use_case.rst (How to add new use cases) + * basic_components.rst (The basic components of a METplus wrapper) + * coding_standards.rst (The coding standards currently in use) * conda_env.rst (How to set up the conda environment for - running METplus.) - * create_wrapper.rst (How to create a new METplus wrapper.) - * deprecation.rst (What to do to deprecate a variable.) - * documentation.rst (Describing the - documentation process and files.) + running METplus) + * continuous_integration.rst (How to set up a continuous integration + workflow) + * create_wrapper.rst (How to create a new METplus wrapper) + * deprecation.rst (What to do to deprecate a variable) + * documentation.rst (Describing the documentation process and files) * github_workflow.rst (A description of how releases are made, - how to to obtain source code from the GitHub repository.) + how to to obtain source code from the GitHub repository) * index.rst (The page that shows all the 'chapters/sections' - of the Contributor's Guide.) + of the Contributor's Guide) * testing.rst (A description of how to set up testing the - wrapper code.) + wrapper code) +Release Guide: +~~~~~~~~~~~~~~ -Building Sphinx Documentation -_____________________________ +Coming soon! + +Verification Datasets Guide: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Coming soon! + +.. _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 +documentation process by building, versioning, and hosting the documentation. + +Read the Docs supports multiple versions for each repository. For the METplus +compoents, the "latest" version will point to the latest official (stable) +release. The "develop" or "development" version will point to the most up to +date development code. There may also be other previous versions of the +software available in the version selector menu, which is accessible by +clicking in the bottom left corner of the the documentation pages. + +Automation rules allow project maintainers to automate actions on new branches +and tags on repositories. For the METplus components, documentation is +automatically built by Read the Docs when a new tag is created and when a +branch is created with the prefix: + + * feature (e.g. feature_836_rtd_doc) + + * bugfix (e.g. bugfix_1716_develop_perc_thresh) + +The documentation of these "versions" are automatically hidden, however, the +documentation can be accessed by directly modifying the URL. For example, to +view "feature_836_rtd_doc" for the METplus repository the URL would be: + + **https://metplus.readthedocs.io/en/feature_836_rtd_doc** + + (Note that this link is not valid as this branch does not currently exist, + however contributors can replace the "feature_836_rtd_doc" with the + appropriate branch name.) + +Read the Docs will automatically delete the documentation for a feature +branch and a bugfix branch when the branch is deleted. + +Documentation for each METplus component can be found at the links below: + +* `METplus `_ +* `MET `_ +* `METcalcpy `_ +* `METdatadb `_ +* `METexpress `_ +* `METplotpy `_ +* `METviewer `_ + + +Building Sphinx Documentation Manually +______________________________________ + +Documentation does not have to be built manually as it is automatically +generated by Read The Docs. See the +:ref:`Read the Docs section ` for further information. +However, contributors can still build the documentation manually if +desired. .. note:: @@ -193,12 +201,12 @@ enter the following: This script does the following: -* Builds the Sphinx documentation. -* Builds the doxygen documentation. -* Removes unwanted text from use case documentation. -* Copies doxygen files into _build/html for easy deployment. +* Builds the Sphinx documentation +* Builds the doxygen documentation +* Removes unwanted text from use case documentation +* Copies doxygen files into _build/html for easy deployment * Creates symbolic links under Users_Guide to the directories under - 'generated' to preserve old URL paths. + 'generated' to preserve old URL paths The html files that are created can be found in the *METplus/docs/_build/html* directory. The web browser can point to this directory by entering @@ -206,21 +214,16 @@ the following in the web browser's navigation bar: *file:////METplus/docs/_build/html/index.html* -Where is the full file path leading to the METplus -source code. This will direct to the home page of the -documentation. Click on the "User's Guide" -link (which opens the user documentation and the use cases) -or the "Contributor's Guide" link (which is relevant if the user intends to -contribute code and/or new use cases). - +Where is the full file path leading to the METplus source code. This +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 API -(Application Programming Interface). +This documentation is useful in generating details about the METplus wrapper +API (Application Programming Interface). This is a useful reference for contributors to peruse prior to creating new METplus wrappers. The Doxygen files located in the */path/to/METplus/docs/doxygen* directory diff --git a/docs/Release_Guide/met_bugfix.rst b/docs/Release_Guide/met_bugfix.rst index 7da9dd03e..16d2422a1 100644 --- a/docs/Release_Guide/met_bugfix.rst +++ b/docs/Release_Guide/met_bugfix.rst @@ -15,4 +15,3 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/met/attach_release_tarfile.rst .. include:: release_steps/met/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_bugfix.rst -.. include:: release_steps/met/update_docs.rst diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst index f93b0d212..091a362eb 100644 --- a/docs/Release_Guide/met_development.rst +++ b/docs/Release_Guide/met_development.rst @@ -15,4 +15,3 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/met/attach_release_tarfile.rst .. include:: release_steps/met/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst -.. include:: release_steps/met/update_docs.rst diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst index 97475fbb3..bbcfa7869 100644 --- a/docs/Release_Guide/met_official.rst +++ b/docs/Release_Guide/met_official.rst @@ -16,5 +16,5 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/met/attach_release_tarfile.rst .. include:: release_steps/met/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst -.. include:: release_steps/met/update_docs.rst +.. include:: release_steps/update_docs_official.rst diff --git a/docs/Release_Guide/metcalcpy_bugfix.rst b/docs/Release_Guide/metcalcpy_bugfix.rst index 2699d0f8f..cde89e58d 100644 --- a/docs/Release_Guide/metcalcpy_bugfix.rst +++ b/docs/Release_Guide/metcalcpy_bugfix.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/checkout_main_branch.rst .. include:: release_steps/metcalcpy/update_version_bugfix.rst .. include:: release_steps/update_release_notes_bugfix.rst -.. include:: release_steps/metcalcpy/update_docs_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metcalcpy/create_release_extra.rst diff --git a/docs/Release_Guide/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst index e61a243dc..68f9cf6e7 100644 --- a/docs/Release_Guide/metcalcpy_development.rst +++ b/docs/Release_Guide/metcalcpy_development.rst @@ -9,7 +9,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metcalcpy/update_version.rst -.. include:: release_steps/metcalcpy/update_docs_develop.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/update_release_notes_development.rst .. include:: release_steps/create_release_on_github.rst diff --git a/docs/Release_Guide/metcalcpy_official.rst b/docs/Release_Guide/metcalcpy_official.rst index 8a8892a67..1c6441081 100644 --- a/docs/Release_Guide/metcalcpy_official.rst +++ b/docs/Release_Guide/metcalcpy_official.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metcalcpy/update_version_official.rst .. include:: release_steps/update_release_notes_official.rst -.. include:: release_steps/metcalcpy/update_docs_tagged.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_branch.rst .. include:: release_steps/push_release_branch.rst @@ -18,4 +17,4 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/metcalcpy/create_release_extra.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metcalcpy/update_version_on_develop.rst - +.. include:: release_steps/update_docs_official.rst diff --git a/docs/Release_Guide/metplotpy_bugfix.rst b/docs/Release_Guide/metplotpy_bugfix.rst index 8f7ee0074..888a62f54 100644 --- a/docs/Release_Guide/metplotpy_bugfix.rst +++ b/docs/Release_Guide/metplotpy_bugfix.rst @@ -5,12 +5,10 @@ METplotpy Bugfix Release Create a new vX.Y.Z bugfix release from the main_vX.Y branch. -.. include:: release_steps/metcalcpy/update_docs_tagged.rst .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_main_branch.rst .. include:: release_steps/metplotpy/update_version_bugfix.rst .. include:: release_steps/update_release_notes_bugfix.rst -.. include:: release_steps/metplotpy/update_docs_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metplotpy/create_release_extra.rst diff --git a/docs/Release_Guide/metplotpy_development.rst b/docs/Release_Guide/metplotpy_development.rst index 3e058b920..8e149e9d6 100644 --- a/docs/Release_Guide/metplotpy_development.rst +++ b/docs/Release_Guide/metplotpy_development.rst @@ -9,7 +9,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metplotpy/update_version.rst -.. include:: release_steps/metplotpy/update_docs_develop.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/update_release_notes_development.rst .. include:: release_steps/create_release_on_github.rst diff --git a/docs/Release_Guide/metplotpy_official.rst b/docs/Release_Guide/metplotpy_official.rst index 54e5c7285..01974a27b 100644 --- a/docs/Release_Guide/metplotpy_official.rst +++ b/docs/Release_Guide/metplotpy_official.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metplotpy/update_version_official.rst .. include:: release_steps/update_release_notes_official.rst -.. include:: release_steps/metplotpy/update_docs_tagged.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_branch.rst .. include:: release_steps/push_release_branch.rst @@ -18,3 +17,4 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/metplotpy/create_release_extra.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metplotpy/update_version_official.rst +.. include:: release_steps/update_docs_official.rst diff --git a/docs/Release_Guide/metplus_bugfix.rst b/docs/Release_Guide/metplus_bugfix.rst index 1839898b4..fbda08217 100644 --- a/docs/Release_Guide/metplus_bugfix.rst +++ b/docs/Release_Guide/metplus_bugfix.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/checkout_main_branch.rst .. include:: release_steps/metplus/update_version_bugfix.rst .. include:: release_steps/update_release_notes_bugfix.rst -.. include:: release_steps/metplus/update_docs_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metplus/create_release_extra.rst diff --git a/docs/Release_Guide/metplus_development.rst b/docs/Release_Guide/metplus_development.rst index a783f8a10..dc0ee49bd 100644 --- a/docs/Release_Guide/metplus_development.rst +++ b/docs/Release_Guide/metplus_development.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metplus/update_version.rst .. include:: release_steps/update_release_notes_development.rst -.. include:: release_steps/metplus/update_docs_develop.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metplus/create_release_extra.rst diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst index 41f27bde4..c547c18fb 100644 --- a/docs/Release_Guide/metplus_official.rst +++ b/docs/Release_Guide/metplus_official.rst @@ -10,7 +10,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/checkout_develop_branch.rst .. include:: release_steps/metplus/update_version_official.rst .. include:: release_steps/update_release_notes_official.rst -.. include:: release_steps/metplus/update_docs_tagged.rst .. include:: release_steps/merge_release_issue.rst .. include:: release_steps/create_release_branch.rst .. include:: release_steps/metplus/update_readme.rst @@ -20,3 +19,4 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/metplus/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metplus/update_version_on_develop.rst +.. include:: release_steps/update_docs_official.rst diff --git a/docs/Release_Guide/release_steps/met/update_docs.rst b/docs/Release_Guide/release_steps/met/update_docs.rst deleted file mode 100644 index 57853ebc8..000000000 --- a/docs/Release_Guide/release_steps/met/update_docs.rst +++ /dev/null @@ -1,17 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Regenerate the User's Guide and push the release to the gh-pages branch. - -.. parsed-literal:: - - # Example for kiowa - git clone https://github.com/dtcenter/MET - cd MET/met/docs - git checkout vX.Y.Z - bash - conda deactivate - conda activate /home/met_test/.conda/envs/sphinx_env - make html - -* Store resulting html output files in the correct sub-directory on the gh-pages branch. diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_docs.rst b/docs/Release_Guide/release_steps/metcalcpy/update_docs.rst deleted file mode 100644 index d5eb54fcc..000000000 --- a/docs/Release_Guide/release_steps/metcalcpy/update_docs.rst +++ /dev/null @@ -1,4 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -- Coming soon...instructions to create documentation for the web diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_docs_bugfix.rst b/docs/Release_Guide/release_steps/metcalcpy/update_docs_bugfix.rst deleted file mode 100644 index f48f7a43d..000000000 --- a/docs/Release_Guide/release_steps/metcalcpy/update_docs_bugfix.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Build the documentation with the correct conda environment by entering the - docs directory and running: `make clean;make html` - -* In another directory, checkout the gh-pages branch of repository. -* Put all contents of docs/_build/html into the directory for the major/minor release, - i.e. vX.Y.Z -* Commit changes and push to GitHub. -* Verify that documentation is updated on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_docs_develop.rst b/docs/Release_Guide/release_steps/metcalcpy/update_docs_develop.rst deleted file mode 100644 index 82c9e572f..000000000 --- a/docs/Release_Guide/release_steps/metcalcpy/update_docs_develop.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running `make clean;make html` -* In another directory, checkout the gh-pages branch of repository. -* On the gh-pages branch, remove all contents of develop directory. -* Put all contents of docs/_build/html into the develop directory. -* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_docs_tagged.rst b/docs/Release_Guide/release_steps/metcalcpy/update_docs_tagged.rst deleted file mode 100644 index 178cb2686..000000000 --- a/docs/Release_Guide/release_steps/metcalcpy/update_docs_tagged.rst +++ /dev/null @@ -1,16 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running 'make clean;make html'. -* In another directory, checkout the gh-pages branch of repository. -* Create a new directory in the gh-pages branch for the release appending a - "v" to the front, i.e. vX.Y.Z -* Put all contents of docs/_build/html into the directory. -* Update versions.json to add the new directory name. -* Update symbolic link for 'latest' to point to new version. -* Commit changes and push to GitHub. -* Verify that documentation appears in the pull-down and latest points to the - new version on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metplotpy/update_docs.rst b/docs/Release_Guide/release_steps/metplotpy/update_docs.rst deleted file mode 100644 index e3f00ade4..000000000 --- a/docs/Release_Guide/release_steps/metplotpy/update_docs.rst +++ /dev/null @@ -1,17 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -- Regenerate the User's Guide and push the release to the gh-pages branch. -- For example, on kiowa: - -.. parsed-literal:: - - git clone https://github.com/dtcenter/METplotpy - cd METplotpy/metplotpy/docs - git checkout vX.Y.Z - bash - conda deactivate - conda activate /home/met_test/.conda/envs/sphinx_env - make html - -- Store resulting html output files in the correct sub-directory on the gh-pages branch. diff --git a/docs/Release_Guide/release_steps/metplotpy/update_docs_bugfix.rst b/docs/Release_Guide/release_steps/metplotpy/update_docs_bugfix.rst deleted file mode 100644 index f48f7a43d..000000000 --- a/docs/Release_Guide/release_steps/metplotpy/update_docs_bugfix.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Build the documentation with the correct conda environment by entering the - docs directory and running: `make clean;make html` - -* In another directory, checkout the gh-pages branch of repository. -* Put all contents of docs/_build/html into the directory for the major/minor release, - i.e. vX.Y.Z -* Commit changes and push to GitHub. -* Verify that documentation is updated on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metplotpy/update_docs_develop.rst b/docs/Release_Guide/release_steps/metplotpy/update_docs_develop.rst deleted file mode 100644 index 82c9e572f..000000000 --- a/docs/Release_Guide/release_steps/metplotpy/update_docs_develop.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running `make clean;make html` -* In another directory, checkout the gh-pages branch of repository. -* On the gh-pages branch, remove all contents of develop directory. -* Put all contents of docs/_build/html into the develop directory. -* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metplotpy/update_docs_tagged.rst b/docs/Release_Guide/release_steps/metplotpy/update_docs_tagged.rst deleted file mode 100644 index 31ac770ce..000000000 --- a/docs/Release_Guide/release_steps/metplotpy/update_docs_tagged.rst +++ /dev/null @@ -1,16 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running `make clean;make html` -* In another directory, checkout the gh-pages branch of repository. -* Create a new directory in the gh-pages branch for the release appending a - "v" to the front, i.e. vX.Y.Z -* Put all contents of docs/_build/html into the directory. -* Update versions.json to add the new directory name. -* Update symbolic link for 'latest' to point to new version. -* Commit changes and push to GitHub. -* Verify that documentation appears in the pull-down and latest points to the - new version on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metplus/update_docs_bugfix.rst b/docs/Release_Guide/release_steps/metplus/update_docs_bugfix.rst deleted file mode 100644 index 111a9815e..000000000 --- a/docs/Release_Guide/release_steps/metplus/update_docs_bugfix.rst +++ /dev/null @@ -1,12 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running ./build_docs.py -* In another directory, checkout the gh-pages branch of repository. -* Put all contents of docs/_build/html into the directory for the major/minor release, - i.e. vX.Y.Z -* Commit changes and push to GitHub. -* Verify that documentation is updated on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/metplus/update_docs_develop.rst b/docs/Release_Guide/release_steps/metplus/update_docs_develop.rst deleted file mode 100644 index 9d5dac04b..000000000 --- a/docs/Release_Guide/release_steps/metplus/update_docs_develop.rst +++ /dev/null @@ -1,11 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running ./build_docs.py -* In another directory, checkout the gh-pages branch of repository. -* On the gh-pages branch, remove all contents of develop directory. -* Put all contents of docs/_build/html into the develop directory. -* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metplus/update_docs_tagged.rst b/docs/Release_Guide/release_steps/metplus/update_docs_tagged.rst deleted file mode 100644 index 9a6dd2f98..000000000 --- a/docs/Release_Guide/release_steps/metplus/update_docs_tagged.rst +++ /dev/null @@ -1,16 +0,0 @@ -Update the Documentation on the Web ------------------------------------ - -* Refer to the Contributor's Guide for instructions on `how to build the - documentation `_. -* Build the documentation with the correct conda environment by entering the - docs directory and running './build_docs.py -release' (-release will update release date file). -* In another directory, checkout the gh-pages branch of repository. -* Create a new directory in the gh-pages branch for the release appending a - "v" to the front, i.e. vX.Y.Z -* Put all contents of docs/_build/html into the directory. -* Update versions.json to add the new directory name. -* Update symbolic link for 'latest' to point to new version. -* Commit changes and push to GitHub. -* Verify that documentation appears in the pull-down and latest points to the - new version on the web: dtcenter.github.io/METplus diff --git a/docs/Release_Guide/release_steps/update_docs_official.rst b/docs/Release_Guide/release_steps/update_docs_official.rst new file mode 100644 index 000000000..cd4a69858 --- /dev/null +++ b/docs/Release_Guide/release_steps/update_docs_official.rst @@ -0,0 +1,27 @@ +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 +to build the documentation for the new release. See the +:ref:`Read the Docs section ` for further information. +For an official release, it is important to update the "Default branch" to +this latest "main" branch. An administrator of the METplus component +repository will need to do the following to update the default branch: + + * Log into their Read the Docs account + + * Click on the appropriate METplus component project + + * Click on Admin in the top menu + + * Click on Advanced Settings in the left menu + + * Select the new default branch in the dropdown menu for "Default branch" + (e.g. main_v4.0.0) + + * Ensure that "latest" points to the new default branch by clicking on + "View Docs"in the upper right corner and confirm that the version number + displayed in the header is the desired version for "latest". + + diff --git a/docs/Users_Guide/quicksearch.rst b/docs/Users_Guide/quicksearch.rst index e2365db9e..b73a0d01e 100644 --- a/docs/Users_Guide/quicksearch.rst +++ b/docs/Users_Guide/quicksearch.rst @@ -6,86 +6,86 @@ METplus Quick Search for Use Cases Use Cases by MET Tool: ---------------------- -| `ASCII2NC `_ -| `CyclonePlotter `_ -| `EnsembleStat `_ -| `GenVxMask `_ -| `GridStat `_ -| `GridDiag `_ -| `MODE `_ -| `MTD `_ -| `PB2NC `_ -| `PCPCombine `_ -| `Point2Grid `_ -| `PlotDataPlane `_ -| `PointStat `_ -| `RegridDataPlane `_ -| `SeriesAnalysis `_ -| `StatAnalysis `_ -| `TCMPRPlotter `_ -| `TCGen `_ -| `TCPairs `_ -| `TCRMW `_ -| `TCStat `_ +| `ASCII2NC `_ +| `CyclonePlotter `_ +| `EnsembleStat `_ +| `GenVxMask `_ +| `GridStat `_ +| `GridDiag `_ +| `MODE `_ +| `MTD `_ +| `PB2NC `_ +| `PCPCombine `_ +| `Point2Grid `_ +| `PlotDataPlane `_ +| `PointStat `_ +| `RegridDataPlane `_ +| `SeriesAnalysis `_ +| `StatAnalysis `_ +| `TCMPRPlotter `_ +| `TCGen `_ +| `TCPairs `_ +| `TCRMW `_ +| `TCStat `_ Use Cases by Application: ------------------------- -| `Climate `_ -| `Convection Allowing Models `_ -| `Ensemble `_ -| `Marine and Cryosphere `_ -| `Medium Range `_ -| `Precipitation `_ -| `Space Weather `_ -| `Subseasonal to Seasonal `_ -| `Tropical Cyclone and Extra-Tropical Cyclone `_ +| `Climate `_ +| `Convection Allowing Models `_ +| `Ensemble `_ +| `Marine and Cryosphere `_ +| `Medium Range `_ +| `Precipitation `_ +| `Space Weather `_ +| `Subseasonal to Seasonal `_ +| `Tropical Cyclone and Extra-Tropical Cyclone `_ Use Cases by Organization: -------------------------- -| `Developmental Testbed Center (DTC) `_ -| `National Center for Atmospheric Research (NCAR) `_ -| `NOAA Weather Prediction Center (WPC) `_ -| `NOAA Space Weather Prediction Center (SWPC) `_ -| `NOAA Environmental Modeling Center (EMC) `_ -| `NOAA Global Systems Laboratory (GSL) `_ -| `NOAA Hydrometeorology Testbed (HMT) `_ -| `NOAA Hazardous Weather Testbed (HWT) `_ -| `State University of New York-Stony Brook University (SUNY-SBU) `_ +| `Developmental Testbed Center (DTC) `_ +| `National Center for Atmospheric Research (NCAR) `_ +| `NOAA Weather Prediction Center (WPC) `_ +| `NOAA Space Weather Prediction Center (SWPC) `_ +| `NOAA Environmental Modeling Center (EMC) `_ +| `NOAA Global Systems Laboratory (GSL) `_ +| `NOAA Hydrometeorology Testbed (HMT) `_ +| `NOAA Hazardous Weather Testbed (HWT) `_ +| `State University of New York-Stony Brook University (SUNY-SBU) `_ Use Cases by METplus Feature: ----------------------------- -| `Introductory Example `_ -| `Custom String Looping `_ -| `Diagnostics `_ -| `Feature Relative `_ -| `GempakToCF `_ -| `Looping by Month or Year `_ -| `List Expansion (using begin_end_incr syntax) `_ -| `Masking for Regions of Interest `_ -| `MET_PYTHON_EXE Environment Variable `_ -| `Multiple Conf File Use `_ -| `Observation Time Summary `_ -| `Observation Uncertainty `_ -| `Python Embedding Ingest `_ -| `Probability Generation `_ -| `Probability Verification `_ -| `Regridding in Tool `_ -| `Revision Series `_ -| `Runtime Frequency `_ -| `Series by Initialization `_ -| `Series by Forecast Lead `_ -| `Validation of Models or Analyses `_ -| `User Defined Script `_ +| `Introductory Example `_ +| `Custom String Looping `_ +| `Diagnostics `_ +| `Feature Relative `_ +| `GempakToCF `_ +| `Looping by Month or Year `_ +| `List Expansion (using begin_end_incr syntax) `_ +| `Masking for Regions of Interest `_ +| `MET_PYTHON_EXE Environment Variable `_ +| `Multiple Conf File Use `_ +| `Observation Time Summary `_ +| `Observation Uncertainty `_ +| `Python Embedding Ingest `_ +| `Probability Generation `_ +| `Probability Verification `_ +| `Regridding in Tool `_ +| `Revision Series `_ +| `Runtime Frequency `_ +| `Series by Initialization `_ +| `Series by Forecast Lead `_ +| `Validation of Models or Analyses `_ +| `User Defined Script `_ Use cases by File Format: ------------------------- -| `GEMPAK `_ -| `GRIB `_ -| `GRIB2 `_ -| `NetCDF `_ -| `Python Embedding `_ -| `prepBUFR `_ +| `GEMPAK `_ +| `GRIB `_ +| `GRIB2 `_ +| `NetCDF `_ +| `Python Embedding `_ +| `prepBUFR `_ diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index 4dce77f9c..fea185dd0 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -7,24 +7,24 @@ METplus Components Release Note Links Release Notes - Latest Official Release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* `MET `__ -* `METviewer `__ +* `MET `__ +* `METviewer `__ * METplotpy - No Official Releases * METcalcpy - No Official Releases * METdatadb - No Official Releases * `METexpress `__ -* `METplus Wrappers `__ +* `METplus Wrappers `__ Release Notes - Development Release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* `MET `__ -* `METviewer `__ +* `MET `__ +* `METviewer `__ * `METplotpy `__ * `METcalcpy `__ * METdatadb - No Development Releases * METexpress - No Development Releases -* `METplus Wrappers `__ +* `METplus Wrappers `__ When applicable, release notes are followed by the GitHub issue number which diff --git a/docs/Verification_Datasets/datasets/aeronet.rst b/docs/Verification_Datasets/datasets/aeronet.rst index c0bffa86a..80fcaa4e9 100644 --- a/docs/Verification_Datasets/datasets/aeronet.rst +++ b/docs/Verification_Datasets/datasets/aeronet.rst @@ -46,7 +46,7 @@ Variables available METplus Use Cases Link to - `METplus Use Cases `_ + `METplus Use Cases `_ for this dataset. Keywords diff --git a/docs/Verification_Datasets/datasets/gdas_ice.rst b/docs/Verification_Datasets/datasets/gdas_ice.rst index cd378ffa1..3a8d19e7d 100644 --- a/docs/Verification_Datasets/datasets/gdas_ice.rst +++ b/docs/Verification_Datasets/datasets/gdas_ice.rst @@ -67,7 +67,7 @@ Variables available METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataGDAS diff --git a/docs/Verification_Datasets/datasets/gdas_prepbufr.rst b/docs/Verification_Datasets/datasets/gdas_prepbufr.rst index b012991ae..231d08fb7 100644 --- a/docs/Verification_Datasets/datasets/gdas_prepbufr.rst +++ b/docs/Verification_Datasets/datasets/gdas_prepbufr.rst @@ -42,7 +42,7 @@ Variables available METplus Use Cases Link to - `METplus Use Cases `_ + `METplus Use Cases `_ for this dataset. Keywords diff --git a/docs/Verification_Datasets/datasets/goes_level_1b.rst b/docs/Verification_Datasets/datasets/goes_level_1b.rst index b07cc6c23..e39690848 100644 --- a/docs/Verification_Datasets/datasets/goes_level_1b.rst +++ b/docs/Verification_Datasets/datasets/goes_level_1b.rst @@ -52,7 +52,7 @@ Variables available ABI L1b Radiances METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataGOESLEV1B diff --git a/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst b/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst index 5c089ced4..08d23128d 100644 --- a/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst +++ b/docs/Verification_Datasets/datasets/goes_level_2_aerosol.rst @@ -58,7 +58,7 @@ Variables available ABI L2 aerosol optical depth (AOD) METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataGOESLEV2AERO diff --git a/docs/Verification_Datasets/datasets/gpm_imerg.rst b/docs/Verification_Datasets/datasets/gpm_imerg.rst index f5e87fe0d..d625a5b1e 100644 --- a/docs/Verification_Datasets/datasets/gpm_imerg.rst +++ b/docs/Verification_Datasets/datasets/gpm_imerg.rst @@ -58,7 +58,7 @@ Variables available Precipitation Rate (mm/hr), precipitationCal METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataIMERG diff --git a/docs/Verification_Datasets/datasets/ims_ice.rst b/docs/Verification_Datasets/datasets/ims_ice.rst index 1dff7ff8b..a2e10f35e 100644 --- a/docs/Verification_Datasets/datasets/ims_ice.rst +++ b/docs/Verification_Datasets/datasets/ims_ice.rst @@ -54,7 +54,7 @@ Variables available METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataIMS diff --git a/docs/Verification_Datasets/datasets/madis.rst b/docs/Verification_Datasets/datasets/madis.rst index dc043b5f9..5d8d07556 100644 --- a/docs/Verification_Datasets/datasets/madis.rst +++ b/docs/Verification_Datasets/datasets/madis.rst @@ -41,7 +41,7 @@ Variables available METplus Use Cases Link to - `METplus Use Cases `_ + `METplus Use Cases `_ for this dataset. Keywords diff --git a/docs/Verification_Datasets/datasets/metar_isu.rst b/docs/Verification_Datasets/datasets/metar_isu.rst index 24fdbc142..e3ffef5ed 100644 --- a/docs/Verification_Datasets/datasets/metar_isu.rst +++ b/docs/Verification_Datasets/datasets/metar_isu.rst @@ -40,7 +40,7 @@ Variables available METplus Use Cases Link to - `METplus Use Cases `_ + `METplus Use Cases `_ for this dataset. Keywords diff --git a/docs/Verification_Datasets/datasets/mping.rst b/docs/Verification_Datasets/datasets/mping.rst index 26e6e5040..ed92a5479 100644 --- a/docs/Verification_Datasets/datasets/mping.rst +++ b/docs/Verification_Datasets/datasets/mping.rst @@ -43,7 +43,7 @@ Variables available None, drizzle, freezing drizzle, rain, freezing rain, ice pellets/sleet, snow, mixed rain/snow, mixed ice pellets/snow, hail, wind damage (by severity), flooding (by severity), mudslide/landslide, dense fog, and blowing dust/sand METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataMPING diff --git a/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst b/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst index 1452b71e3..c74faa8fe 100644 --- a/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst +++ b/docs/Verification_Datasets/datasets/mrms_composite_reflectivity.rst @@ -36,7 +36,7 @@ Variables available composite reflectivity METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataMRMSCompositeReflectivity diff --git a/docs/Verification_Datasets/datasets/nexrad_level_2.rst b/docs/Verification_Datasets/datasets/nexrad_level_2.rst index 81189ad8e..c07e4a871 100644 --- a/docs/Verification_Datasets/datasets/nexrad_level_2.rst +++ b/docs/Verification_Datasets/datasets/nexrad_level_2.rst @@ -45,7 +45,7 @@ Variables available Reflectivity, radial velocity, spectrum width, >2011 differential reflectivity, correlation coefficient, differential phase METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataNexradLevel2 diff --git a/docs/Verification_Datasets/datasets/nexrad_level_3.rst b/docs/Verification_Datasets/datasets/nexrad_level_3.rst index d39b47bfd..fb4051edc 100644 --- a/docs/Verification_Datasets/datasets/nexrad_level_3.rst +++ b/docs/Verification_Datasets/datasets/nexrad_level_3.rst @@ -47,7 +47,7 @@ Variables available 40+ base, derived, post-processed products at reduced resolution METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataNexradLevel3 diff --git a/docs/Verification_Datasets/datasets/opera_eumetnet.rst b/docs/Verification_Datasets/datasets/opera_eumetnet.rst index deda29910..631ae695f 100644 --- a/docs/Verification_Datasets/datasets/opera_eumetnet.rst +++ b/docs/Verification_Datasets/datasets/opera_eumetnet.rst @@ -46,7 +46,7 @@ Variables available Composite instantaneous max radar reflectivity, 1-hour rainfall accumulation, instantaneous surface rain rate METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataOperaEumetnet diff --git a/docs/Verification_Datasets/datasets/template.rst b/docs/Verification_Datasets/datasets/template.rst index 73215258c..66db98021 100644 --- a/docs/Verification_Datasets/datasets/template.rst +++ b/docs/Verification_Datasets/datasets/template.rst @@ -45,7 +45,7 @@ Variables available METplus Use Cases Link to - `METplus Use Cases `_ + `METplus Use Cases `_ for this dataset. .. diff --git a/docs/Verification_Datasets/datasets/viirs.rst b/docs/Verification_Datasets/datasets/viirs.rst index f87e407cc..0ba0fc2ff 100644 --- a/docs/Verification_Datasets/datasets/viirs.rst +++ b/docs/Verification_Datasets/datasets/viirs.rst @@ -48,7 +48,7 @@ Variables available Aerosol optical thickness at 550 nm over land, ocean, and land/ocean METplus Use Cases - Link to `METplus Use Cases `_ for this dataset. + Link to `METplus Use Cases `_ for this dataset. Keywords .. note:: **Current Dataset:** VxDataVIIRS diff --git a/docs/Verification_Datasets/quicksearch.rst b/docs/Verification_Datasets/quicksearch.rst index 6eb8f7a3a..722c4aa06 100644 --- a/docs/Verification_Datasets/quicksearch.rst +++ b/docs/Verification_Datasets/quicksearch.rst @@ -5,33 +5,33 @@ Quick Search for Datasets Dataset Types ------------- -| `Point Data `_ -| `Gridded Data `_ +| `Point Data `_ +| `Gridded Data `_ Dataset Levels -------------- -| `Surface Data `_ -| `Upper-Air Data `_ -| `Satellite Data `_ +| `Surface Data `_ +| `Upper-Air Data `_ +| `Satellite Data `_ Dataset Providers ----------------- -| `EUMETNET `_ -| `ISU `_ -| `NOAA `_ -| `NASA `_ -| `OU `_ -| `USAF `_ -| `NSIDC `_ +| `EUMETNET `_ +| `ISU `_ +| `NOAA `_ +| `NASA `_ +| `OU `_ +| `USAF `_ +| `NSIDC `_ Dataset Applications -------------------- -| `Climate `_ -| `Convection Allowing Models `_ -| `Ensemble `_ -| `Marine and Cryosphere `_ -| `Medium Range `_ -| `Precipitation `_ -| `Space Weather `_ -| `Subseasonal to Seasonal `_ -| `Tropical Cyclone and Extra-Tropical Cyclone `_ +| `Climate `_ +| `Convection Allowing Models `_ +| `Ensemble `_ +| `Marine and Cryosphere `_ +| `Medium Range `_ +| `Precipitation `_ +| `Space Weather `_ +| `Subseasonal to Seasonal `_ +| `Tropical Cyclone and Extra-Tropical Cyclone `_