Feature 1403 python components table (#1497)

Co-authored-by: Lisa Goodrich <[email protected]> Co-authored-by: Julie Prestopnik <[email protected]>
dtcenter · Mar 9, 2022 · 2d4a392 · 2d4a392
1 parent d1a8867
commit 2d4a392
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 8 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -65,6 +65,7 @@ Branch name: `bugfix_<Issue Number>_main_<Version>_<Description>`
 - [ ] Add/update log messages for easier debugging.
 - [ ] Add/update unit tests.
 - [ ] Add/update documentation.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
 - [ ] Push local changes to GitHub.
 - [ ] Submit a pull request to merge into **main_\<Version>**.
 Pull request: `bugfix <Issue Number> main_<Version> <Description>`

diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md
@@ -54,6 +54,7 @@ Branch name: `feature_<Issue Number>_<Description>`
 - [ ] Add/update log messages for easier debugging.
 - [ ] Add/update unit tests.
 - [ ] Add/update documentation.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
 - [ ] Push local changes to GitHub.
 - [ ] Submit a pull request to merge into **develop**.
 Pull request: `feature <Issue Number> <Description>`

diff --git a/.github/ISSUE_TEMPLATE/new_feature_request.md b/.github/ISSUE_TEMPLATE/new_feature_request.md
@@ -58,6 +58,7 @@ Branch name: `feature_<Issue Number>_<Description>`
 - [ ] Add/update log messages for easier debugging.
 - [ ] Add/update unit tests.
 - [ ] Add/update documentation.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
 - [ ] Push local changes to GitHub.
 - [ ] Submit a pull request to merge into **develop**.
 Pull request: `feature <Issue Number> <Description>`

diff --git a/.github/ISSUE_TEMPLATE/new_use_case.md b/.github/ISSUE_TEMPLATE/new_use_case.md
@@ -67,6 +67,7 @@ Branch name: `feature_<Issue Number>_<Description>`
 - [ ] Add/update log messages for easier debugging.
 - [ ] Add/update unit tests.
 - [ ] Add/update documentation.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
 - [ ] Push local changes to GitHub.
 - [ ] Submit a pull request to merge into **develop**.
 Pull request: `feature <Issue Number> <Description>`

diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md
@@ -54,6 +54,7 @@ Branch name: `feature_<Issue Number>_<Description>`
 - [ ] Add/update log messages for easier debugging.
 - [ ] Add/update unit tests.
 - [ ] Add/update documentation.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
 - [ ] Push local changes to GitHub.
 - [ ] Submit a pull request to merge into **develop**.
 Pull request: `feature <Issue Number> <Description>`

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -15,6 +15,7 @@ If **yes**, describe the new output and/or changes to the existing output:</br>
 
 ## Pull Request Checklist ##
 See the [METplus Workflow](https://metplus.readthedocs.io/en/latest/Contributors_Guide/github_workflow.html) for details.
+- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements) table.
 - [ ] Review the source issue metadata (required labels, projects, and milestone).
 - [ ] Complete the PR definition above.
 - [ ] Ensure the PR title matches the feature or bugfix branch name.

diff --git a/docs/Contributors_Guide/add_use_case.rst b/docs/Contributors_Guide/add_use_case.rst
@@ -210,15 +210,14 @@ use case OR category directory for a model_applications use case
     * Update the description of the input data in the Datasets section.
 
     * Update the list of External Dependencies (if applicable) to include any
-      required Python packages.  Update the
-      `METplus  Components Python Requirements <https://docs.google.com/spreadsheets/d/1Lf-yxZBXTTnBaqCOWUk-jdP9RpaLfil_s-KKH29CkKU/edit#gid=0>`_
-      spreadsheet.  If the package is already listed in the spreadsheet, add
+      required Python packages.  Update the :ref:`python_requirements_table`
+      table.  If the package is already listed in the spreadsheet, add
       a link to the documentation page for this new use case, following the
-      format in the spreadsheet.  If the package is not already listed, update
-      the spreadsheet to include the name of the required package, the version,
+      format in the table.  If the package is not already listed, update
+      the table to include the name of the required package, the version,
       the METplus component (e.g. METplus wrappers, METcalcpy, METplotpy), the
-      source, a brief description, and a link to this new use case that uses
-      this new Python package.
+      source, a brief description of the package, and a link to this new use
+      case that uses this new Python package.
 
     * Update the list of tools used in the METplus Components section.
 

diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst
@@ -85,6 +85,8 @@ METplus Wrappers configuration files. Some Python wrappers do not
 correspond to a particular MET tool, but wrap utilities to extend
 METplus functionality.
 
+.. _python_requirements_table:
+
 METplus Components Python Requirements
 ======================================
 
@@ -96,7 +98,6 @@ METplus Components Python Requirements
    Description - no more than 22 (was 20) characters
    Use Cases - no more than 17 (was 10) characters
 
-
 .. role:: raw-html(raw)
    :format: html	  
 
@@ -414,6 +415,14 @@ METplus Components Python Requirements
       Python programming :raw-html:`<br />`
       language
     - For using MET Python embedding functionality in use cases
+  * - pint
+    - >=0.18
+    - METcalcpy
+    - https://github.com/hgrecco/pint
+    - Python package to define, :raw-html:`<br />`
+      operate and manipulate :raw-html:`<br />`
+      physical quantities
+    -
   * - plotly
     - >=4.9.0
     - METcalcpy, :raw-html:`<br />`