Skip to content

Commit

Permalink
Update develop-ref after #2192 (#2199)
Browse files Browse the repository at this point in the history
Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: cristianastan2 <cstan@gmu.edu>
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: bikegeek <minnawin@ucar.edu>
Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: Hank Fisher <fisherh@ucar.edu>
Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Tracy Hertneky <hertneky@seneca.rap.ucar.edu>
Co-authored-by: Giovanni Rosa <giovanni.rosa@unimol.it>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>
Co-authored-by: Mrinal Biswas <biswas@seneca.rap.ucar.edu>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: bikegeek <3753118+bikegeek@users.noreply.github.com>
Co-authored-by: j-opatz <jopatz@ucar.edu>
Co-authored-by: Will Mayfield <59745143+willmayfield@users.noreply.github.com>
Co-authored-by: metplus-bot <97135045+metplus-bot@users.noreply.github.com>
Co-authored-by: Tracy Hertneky <39317287+hertneky@users.noreply.github.com>
Co-authored-by: Giovanni Rosa <g.rosa1@studenti.unimol.it>
Co-authored-by: mrinalbiswas <biswas@ucar.edu>
fixing errors #650
fixing errors take 2 #650
fixing errors take 3 #650
fixing errors take 4 #650
fixing errors take 5 #650
fixing question order #650
fix #1706 fix PhaseDiagram use case to avoid writing into INPUT_BASE (#1708)
fix #1713 develop METPLOTPY_BASE (#1715)
fix #1691 remove whitespace from output file paths (#1721)
fix Contributor's Guide GitHub Workflow page (#1774)
fix release (#1790)
fix GitHub Actions warnings (#1864)
fix #1884 develop PCPCombine {custom} in subtract method (#1887)
fix #1939 develop - failure reading obs when zipped file also exists (#1941)
Closes #1986
fix develop Fix broken documentation links (#2004)
fix #2026 develop StatAnalysis looping (#2028)
fix priority of obs_window config variables so that wrapper-specific version is preferred over generic OBS_WINDOW_BEGIN/END (#2062)
fix #2070 var list numeric order (#2072)
fix #2087 develop docs_pdf (#2091)
fix #2096/#2098 develop - fix skip if output exists and do not error if no commands were run (#2099)
Fix for Dockerfile smell DL4000 (#2112)
fix #2082 develop regrid.convert/censor_thresh/censor_val (#2140)
fix #2082 main_v5.0 regrid.convert/censor_thresh/censor_val (#2101)
fix #2137 develop PointStat -obs_valid_beg/end (#2141)
fix failured introduced by urllib3 (see urllib3/urllib3#2168)
fix #2161 develop PCPCombine additional field arguments in -subtract mode (#2162)
fix #2168 develop - StatAnalysis time shift (#2169)
fix releases. (#2183)
fix #2189 develop - spaces in complex thresholds (#2191)
  • Loading branch information
github-actions[bot] committed Jun 5, 2023
1 parent 3efb304 commit d77358d
Show file tree
Hide file tree
Showing 33 changed files with 841 additions and 72 deletions.
5 changes: 5 additions & 0 deletions .github/parm/use_case_groups.json
Original file line number Diff line number Diff line change
Expand Up @@ -233,5 +233,10 @@
"category": "unstructured_grids",
"index_list": "0",
"run": false
},
{
"category": "land_surface",
"index_list": "0",
"run": false
}
]
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ information, please read
This infrastructure utilizes the NCEP produtil package, which is a platform-independent
weather and ocean forecasting utility package developed at the National Oceanic
and Atmospheric Administration (NOAA).

For information about the support provided for releases, see our [Release Support Policy](https://metplus.readthedocs.io/en/develop/Release_Guide/index.html#release-support-policy).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Contributors_Guide/figure/3PR-set-status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Contributors_Guide/figure/5PR-link-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 65 additions & 2 deletions docs/Contributors_Guide/github_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,8 @@ Detailed instructions for each item can be found below or by clicking the link.

.. _wo-find-issue:

Find the GitHub issue
^^^^^^^^^^^^^^^^^^^^^
Find or Create a GitHub Issue
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Go to the `METplus repository <https://github.com/dtcenter/METplus>`_ and
click on the `Issues tab <https://github.com/dtcenter/METplus/issues>`_.
Expand All @@ -336,6 +336,46 @@ Find the GitHub issue
`new Discussion <https://github.com/dtcenter/METplus/discussions/new>`_ on
the METplus GitHub Discussions page to ask if an issue should be created.

* If creating a new issue, select the
`"New Issue" <https://github.com/dtcenter/METplus/issues/new/choose>`_ button
and review the categories of issues (e.g. Bug report, enhancement request,
New feature request, New use case, Sub-Issue, Task). Find an appropriate
categories and click on "Get Started" next to the category.

Create a short, but descriptive title. In the 'write' window, follow the
directions and fill in the template. Add any additional comments/details.
When filling in the template, be sure to "Define the PR metadata, as
permissions allow. Select: **Assignee(s), Project(s)**, and **Milestone**".

Before an issue is created, a "Project" can be selected, but there is no
option to select a cycle.

.. image:: figure/1Issue-before-created.png
:width: 400

After the issue is created, more options appear under the "Project" section.

.. image:: figure/2Issue-after-created.png
:width: 400

Click the "Status" drop down and select "Todo".

.. image:: figure/3Issue-set-status.png
:width: 400

Click on "+1 more" then under "Cycle", click "Choose an iteration" and
select the current development cycle.

.. image:: figure/4Issue-plus-one-set-cycle.png
:width: 400

After selecting the appropriate "Cycle", be sure to remove the
**alert: NEED CYCLE ASSIGNMENT** label, which is added by default.

If the description of the issue is clear and does not need further
definition, be sure to remove the **alert: NEED MORE DEFINITION**
label, which is added by default.

.. _wo-fork-repo:

Fork the dtcenter/METplus repository
Expand Down Expand Up @@ -672,6 +712,29 @@ Open a pull request
* When everything looks satisfactory, click on the green 'Create pull
request' button.

* Before a pull request is created, a "Project" can be selected, but there
is no option to select a cycle.

.. figure:: figure/1PR-before-created.png

After the pull request is created, more options appear under the
"Project" section.

.. figure:: figure/2PR-after-created.png

Click the "Status" drop down and select "Review".

.. figure:: figure/3PR-set-status.png

Click on "+1 more" then under "Cycle", click "Choose an iteration" and
select the current development cycle.

.. figure:: figure/4PR-plus-one-set-cycle.png

To link the issue that correspondes to the pull request, click on the
gear next to "Development," type the issue number, then select the issue
that is displayed.

* An authorized METplus developer will accept the pull request (if
everything meets acceptance criteria) and merge the code into the remote
repository's develop branch.
Expand Down
15 changes: 15 additions & 0 deletions docs/Release_Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,21 @@ Bugfix Release
A bugfix release introduces no new features, but fixes bugs in previous
official releases and targets the most critical bugs affecting users.

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
includes addressing critical bugs, security vulnerabilities, and functionality
issues. We acknowledge that certain exceptions may arise to cater to the
specific needs of funding institutions. These exceptions may include dedicating
resources, prioritizing bug fixes, or extending support beyond the standard
policy for funding-related requirements. Such exceptions will be evaluated on
a case-by-case basis, ensuring a mutually beneficial collaboration between our
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 <https://github.com/dtcenter/METplus/discussions>`_.

Instructions Summary
====================

Expand Down
29 changes: 11 additions & 18 deletions docs/Release_Guide/release_steps/common/update_dtc_website.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Update DTC Website
* For *Related Community Code* select both the METplus and the |projectName|
options (For Macs, hold the Command key to select both).

* For *Version Label* type "|projectRepo| X.Y.Z betaN".
* For *Version Label* type "|projectRepo| X.Y.Z-betaN".

* Select the release type (*Recommended* for official or bugfix releases or
*Development* for development versions).
Expand Down Expand Up @@ -48,8 +48,9 @@ Update DTC Website

* Update the existing releases, as needed.

* For a development release, change any previous *Development*
versions to *Other*.
* For a development release, ensure the "Release Type" is set to
*Development* and change any previous *Development* versions to
*Other*.

* For a bugfix or official release, change any previous
*Recommended* versions to *Other*.
Expand All @@ -59,22 +60,14 @@ Update DTC Website

* Create or edit the "Coordinated METplus Version X.Y" software release.

* For a beta1 development release, create the "Coordinated METplus
Version X.Y" release entry if it doesn't already exist. Ensure the
"Release Type" is set to *Development*. Add links for the |projectRepo|
X.Y.Z beta1, the METplus "Documentation", the METplus "Existing Builds
and Docker" page, and the "Release Notes". Add to the Release Notes a link to the
|projectRepo| Release Notes.
* For an official release, create the "Coordinated METplus Version X.Y"
release entry if it doesn't already exist. Ensure the "Release Type"
is set to *Recommended*. Consider changing the "Release Type" of
previous coordinated releases from *Recommended* to *Other*. Add
links for the |projectRepo| X.Y.Z, the METplus "Documentation",
the METplus "Existing Builds and Docker" page, and the "Release Notes".
Make the Release Notes a link to the |projectRepo| Release Notes.

* For a beta2 or beyond development release, update the existing link and text in
the "Coordinated METplus Version X.Y" release section with the updated
development release information.

* For an official release, update the existing link and text in
the "Coordinated METplus Version X.Y" release section with the X.Y.Z
information. Change the "Release Type" from *Development* to
*Recommended*. Consider changing the "Release Type" of previous coordinated releases from *Recommended* to *Other*.

* For a bugfix release, update the existing link and text in
the "Coordinated METplus Version X.Y" release section with the
X.Y.Z+1 information.
Expand Down
42 changes: 21 additions & 21 deletions docs/Users_Guide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,17 +112,17 @@ METplus Components Python Requirements
- Description
- Use Cases (only applicable for METplus wrappers component)(followed by
python package name)
* - Python 3.8.6+
* - Python 3.10.4+
-
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy,:raw-html:`<br />`
METplotpy, :raw-html:`<br />`
METdataio
-
-
-
* - cartopy
- >=0.18.0
- >=0.21.1
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
Expand Down Expand Up @@ -167,7 +167,7 @@ METplus Components Python Requirements
oceanographic variables
-
* - dateutil
- >=2.8
- >=2.8.2
- METplus wrappers
- https://github.com/dateutil/dateutil/releases
- provides powerful :raw-html:`<br />`
Expand Down Expand Up @@ -208,7 +208,7 @@ METplus Components Python Requirements
(h5py)
<../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_
* - imutils
- >=0.5.3
- >=0.5.4
- METplotpy :raw-html:`<br />`
- https://pypi.org/project/imutils/
- A series of convenience :raw-html:`<br />`
Expand Down Expand Up @@ -236,7 +236,7 @@ METplus Components Python Requirements
and scientific formats
-
* - lxml
-
- >=4.9.1
- METcalcpy, :raw-html:`<br />`
METplotpy, :raw-html:`<br />`
METdataio
Expand All @@ -246,7 +246,7 @@ METplus Components Python Requirements
libxml2 and libxslt
-
* - matplotlib
- >=3.3.4
- >=3.6.3
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
Expand Down Expand Up @@ -349,7 +349,7 @@ METplus Components Python Requirements
(metplotpy)
<../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_
* - metpy
-
- >=1.4.0
- METplus wrappers
- https://www.unidata.ucar.edu/software/metpy/
- a collection of tools :raw-html:`<br />`
Expand All @@ -371,7 +371,7 @@ METplus Components Python Requirements
\**REQUIRES Python 3.7
-
* - netCDF4
- >=1.5.4
- >=1.6.2
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
Expand All @@ -380,7 +380,7 @@ METplus Components Python Requirements
the netCDF C library
- For using MET Python embedding functionality in use cases
* - numpy
- >=1.19.2
- >=1.24.2
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy, :raw-html:`<br />`
Expand All @@ -394,7 +394,7 @@ METplus Components Python Requirements
Fourier transforms, and more.
- For using MET Python embedding functionality in use cases
* - pandas
- >=1.0.5, <=1.2.3 (METdataio)
- >=1.5.2
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy, :raw-html:`<br />`
Expand All @@ -409,15 +409,15 @@ METplus Components Python Requirements
language
- For using MET Python embedding functionality in use cases
* - pint
- >=0.18
- >=0.20.1
- 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
- >=5.13.0
- METcalcpy, :raw-html:`<br />`
METplotpy
- https://github.com/plotly/plotly.py
Expand Down Expand Up @@ -458,7 +458,7 @@ METplus Components Python Requirements
(pylab)
<../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_
* - pymysql
-
- >=1.0.2
- METcalcpy, :raw-html:`<br />`
METplotpy, :raw-html:`<br />`
METdataio
Expand All @@ -468,7 +468,7 @@ METplus Components Python Requirements
based on PEP 249
-
* - pyproj
- 2.3.1
- >=2.3.1
- METplus wrappers
- https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz
- Python interface to PROJ :raw-html:`<br />`
Expand Down Expand Up @@ -506,7 +506,7 @@ METplus Components Python Requirements
(pyresample)
<../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_
* - pytest
- >=5.2.1
- >=7.2.1
- METcalcpy, :raw-html:`<br />`
METplotpy, :raw-html:`<br />`
METdataio
Expand All @@ -528,7 +528,7 @@ METplus Components Python Requirements
libraries like Plotly
-
* - pyyaml
- >=5.3.1
- >=6.0
- METcalcpy, :raw-html:`<br />`
METplotpy, :raw-html:`<br />`
METdataio
Expand All @@ -538,7 +538,7 @@ METplus Components Python Requirements
programming language
-
* - scikit-image
- >=0.16.2
- >=0.19.3
- METcalcpy, :raw-html:`<br />`
METplotpy
- https://scikit-image.org
Expand All @@ -547,7 +547,7 @@ METplus Components Python Requirements
processing
-
* - scikit-learn
- 0.23.2
- >=1.2.2
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
Expand All @@ -572,7 +572,7 @@ METplus Components Python Requirements
(scikit-learn)
<../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_
* - scipy
- >=1.5.1
- >=1.9.3
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
Expand Down Expand Up @@ -635,7 +635,7 @@ METplus Components Python Requirements
(sklearn)
<../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_
* - xarray
- >=0.17.0
- >=2023.1.0
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
Expand Down
2 changes: 2 additions & 0 deletions docs/Users_Guide/quicksearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Use Cases by Application:
| `Short Range <../search.html?q=ShortRangeAppUseCase&check_keywords=yes&area=default>`_
| `Data Assimilation <../search.html?q=DataAssimilationAppUseCase&check_keywords=yes&area=default>`_
| `Ensemble <../search.html?q=EnsembleAppUseCase&check_keywords=yes&area=default>`_
| `Land Surface <../search.html?q=LandSurfaceAppUseCase&check_keywords=yes&area=default>`_
| `Marine and Cryosphere <../search.html?q=MarineAndCryosphereAppUseCase&check_keywords=yes&area=default>`_
| `Medium Range <../search.html?q=MediumRangeAppUseCase&check_keywords=yes&area=default>`_
| `Precipitation <../search.html?q=PrecipitationAppUseCase&check_keywords=yes&area=default>`_
Expand All @@ -91,6 +92,7 @@ Use Cases by Application:
| **Short Range**: *ShortRangeAppUseCase*
| **Data Assimilation**: *DataAssimilationAppUseCase*
| **Ensemble**: *EnsembleAppUseCase*
| **LandSurface**: *LandSurfaceAppUseCase*
| **Marine and Cryosphere**: *MarineAndCryosphereAppUseCase*
| **Medium Range**: *MediumRangeAppUseCase*
| **Precipitation**: *PrecipitationAppUseCase*
Expand Down
Loading

0 comments on commit d77358d

Please sign in to comment.