Skip to content

Commit

Permalink
Merge branch 'develop' into feature_fix_bad_templates
Browse files Browse the repository at this point in the history
  • Loading branch information
georgemccabe committed Mar 15, 2022
2 parents 419e91d + 0b61eed commit c8aa3f4
Show file tree
Hide file tree
Showing 44 changed files with 2,167 additions and 983 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new_feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new_use_case.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Expand Down
9 changes: 2 additions & 7 deletions .github/parm/use_case_groups.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
{
"category": "met_tool_wrapper",
"index_list": "59",
"index_list": "59-60",
"run": false
},
{
Expand Down Expand Up @@ -181,12 +181,7 @@
},
{
"category": "tc_and_extra_tc",
"index_list": "3",
"run": false
},
{
"category": "tc_and_extra_tc",
"index_list": "4",
"index_list": "3-5",
"run": false
}
]
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 0 additions & 15 deletions .github/workflows/release_published.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ METplus is a Python scripting infrastructure around the MET verification tools

Documentation for both Users and Contributors can be found [here](https://metplus.readthedocs.io).
For more information about the entire suite of tools, please visit the
[MET website](https://dtcenter.org/community-code/model-evaluation-tools-met).
[DTC METplus website](https://dtcenter.org/community-code/metplus).

Support for the METplus components is provided through the
[METplus Discussions](https://github.com/dtcenter/METplus/discussions) forum.
Expand Down
10 changes: 5 additions & 5 deletions build_components/Externals_stable.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,35 @@ local_path = ../MET
protocol = git
required = True
repo_url = https://github.com/dtcenter/MET
branch = v10.0.0
tag = v10.1.0

[METviewer]
local_path = ../METviewer
protocol = git
required = True
repo_url = https://github.com/dtcenter/METviewer
branch = v4.0.0
tag = v4.1.0

[METplotpy]
local_path = ../METplotpy
protocol = git
required = True
repo_url = https://github.com/dtcenter/METplotpy
branch = v1.0.0
tag = v1.1.0

[METcalcpy]
local_path = ../METcalcpy
protocol = git
required = True
repo_url = https://github.com/dtcenter/METcalcpy
branch = v1.0.0
tag = v1.1.0

[METdatadb]
local_path = ../METdatadb
protocol = git
required = True
repo_url = https://github.com/dtcenter/METdatadb
branch = develop
tag = v1.1.0


[externals_description]
Expand Down
17 changes: 8 additions & 9 deletions docs/Contributors_Guide/add_use_case.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -905,14 +904,14 @@ Compare the volume_mount_directories file

Compare the feature branch file to the upcoming METplus version directory file::

diff ${METPLUS_FEATURE_BRANCH}/volume_mount_directories ${METPLUS_VERSION}/volume_mount_directories
diff ${METPLUS_FEATURE_BRANCH}/volume_mount_directories v${METPLUS_VERSION}/volume_mount_directories

**ONLY RUN THE COMMAND THAT IS APPROPRIATE TO YOUR USE CASE. READ CAREFULLY!**

**CONDITION 1: IF there is a new entry or change in the feature version**,
copy the feature file into the upcoming METplus version directory and the develop directory::

cp ${METPLUS_FEATURE_BRANCH}/volume_mount_directories ${METPLUS_VERSION}/volume_mount_directories
cp ${METPLUS_FEATURE_BRANCH}/volume_mount_directories v${METPLUS_VERSION}/volume_mount_directories
cp ${METPLUS_FEATURE_BRANCH}/volume_mount_directories develop/volume_mount_directories

Copy data from the feature directory into the next version directory
Expand Down
2 changes: 1 addition & 1 deletion docs/Release_Guide/metplus_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Create a new vX.Y.Z official release from the develop branch.
.. include:: release_steps/metplus/update_release_date.rst
.. include:: release_steps/update_release_notes_official.rst
.. include:: release_steps/rotate_authorship.rst
.. include:: release_steps/metplus/update_manage_externals.rst
.. include:: release_steps/merge_release_issue.rst
.. include:: release_steps/metplus/create_release_reference_branch.rst
.. include:: release_steps/metplus/update_release_content.rst
.. include:: release_steps/push_release_branch.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/metplus/create_release_extra.rst
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
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
(X+6).Y-latest must already exist. For example, for METplus 4.1.0, the MET
DockerHub tag for 10.1-latest must be built.
See https://hub.docker.com/repository/docker/dtcenter/met/general for
a list of existing tags.

* 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
the format main_vX.Y-ref where X.Y is the major/minor release number.
Expand All @@ -11,13 +18,41 @@ Create Release Reference Branch
git checkout develop
git pull
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.

Remove **-dev** from the version number:

* As of METplus 4.0.0, we are naming releases with X.Y.Z format even if Z is 0.
* As of METplus v4.0.0, the file containing the version number is located at
**metplus/VERSION** (in earlier releases, the file was located at
docs/version or doc/version).
* In the develop branch, the version should match the upcoming release
with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev
* Remove **-dev** from the version number so that it matches the release
you are creating.

Commit these changes.

Push reference branch to GitHub
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

git push -u origin main_vX.Y-ref

Pushing this branch to GitHub should trigger the GitHub Actions automation
that runs all of the use cases and creates Docker data volumes with the output
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.

Expand All @@ -28,6 +63,9 @@ Navigate to https://github.com/dtcenter/METplus/actions and verify that a
each use case category on DockerHub (dtcenter/metplus-data-dev). The names
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.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Update the version numbers in the manage externals files
--------------------------------------------------------

build_components/Externals_stable.cfg

Each of the components in these files has a tag associated with them.
Update the value for tag to the tag associated with the release for each
METplus component that is part of this METplus coordinated release, i.e.
MET should be v10.0.0 for the METplus 4.0.0 coordinated release.

This file was deleted.

11 changes: 11 additions & 0 deletions docs/Release_Guide/release_steps/rotate_authorship.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,16 @@ for each official release:
"First Initial. Last Name". Please maintain that format as it is the most
common format for citations.

* The author list is typically found in the conf.py file in the documentation
directory, i.e. *docs/conf.py*.
Most of the component repositories store the list of authors in a variable
named **author_list**. Please ensure that changes to this list match the
correct format listed above.
In the METplus repository, the conf.py file has variable named
CURRENT_AUTHORS that is a list of the authors to rotate.
To rotate, move the first item in the list to the end of the list.
There is logic in this file to read the list and format it properly to match
the expected format for citations.

* Review the list of authors in the citation and at the top level of the
documentation and update as needed.
28 changes: 24 additions & 4 deletions docs/Users_Guide/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5038,25 +5038,45 @@ METplus Configuration Glossary
| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_FHO
Specify the value of output_flag.fho in the MET configuration file.
Specify the value of output_flag.fho in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_CTC
Specify the value of output_flag.ctc in the MET configuration file.
Specify the value of output_flag.ctc in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_CTS
Specify the value of output_flag.cts in the MET configuration file.
Specify the value of output_flag.cts in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_GENMPR
Specify the value of output_flag.genmpr in the MET configuration file.
Specify the value of output_flag.genmpr in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_PCT
Specify the value for 'output_flag.pct' in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_PSTD
Specify the value for 'output_flag.pstd' in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_PJC
Specify the value for 'output_flag.pjc' in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_OUTPUT_FLAG_PRC
Specify the value for 'output_flag.prc' in the MET configuration file for TCGen.

| *Used by:* TCGen
TC_GEN_NC_PAIRS_FLAG_LATLON
Specify the value of nc_pairs_flag.latlon in the MET configuration file.

Expand Down
11 changes: 10 additions & 1 deletion docs/Users_Guide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
======================================

Expand All @@ -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

Expand Down Expand Up @@ -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 />`
Expand Down
Loading

0 comments on commit c8aa3f4

Please sign in to comment.