From 0e4db774e7c16ae77c4a88505a0e7d5d1e019c39 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 16 Mar 2023 16:07:31 -0600 Subject: [PATCH] Feature 2076 release dropdown menu (#2083) * test dropdowns * Update release-notes.rst Attempting to resolve WARNING * testing dropdowns * adding dropdown menus * testing dropdown remove from warning section * dropdown testing * dropdown menu tests * dropdown menus after the warnings section, the dropdown menu only has one space instead of the normal 2 spaces. If it has 2 spaces, it gets sucked into the warning section. * spaces with warning * no spaces for warning * Update release-notes.rst warning note has to be indented 1 space. Originally it was no spaces but then all of the dropdown menus end up in the warning message. If it's 2 spaces, as is normal, then the warning is indented, which is unnecessary. 1 space is slightly indented and keeps the dropdown menus separate. --------- Co-authored-by: jprestop --- docs/Users_Guide/release-notes.rst | 375 ++++++++++++++--------------- 1 file changed, 187 insertions(+), 188 deletions(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index e31fb0c9e..e6cffdac4 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -34,206 +34,205 @@ describes the bugfix, enhancement, or new feature. METplus Version 5.1.0-beta1 Release Notes (2023-02-28) ------------------------------------------------------ -* Enhancements: + .. dropdown:: Enhancements - * Add support for multiple interp widths - (`#2049 `_) - * TCPairs - Add support for setting consensus.write_members - (`#2054 `_) + * Add support for multiple interp widths (`#2049 `_) + * TCPairs - Add support for setting consensus.write_members + (`#2054 `_) -* Bugfix: + .. dropdown:: Bugfix - * StatAnalysis - allow run once for each valid time - (`#2026 `_) + * StatAnalysis - allow run once for each valid time + (`#2026 `_) -* Documentation: + .. dropdown:: Documentation - * Update the METplus Components Python Requirements Documentation - (`#2016 `_) + * Update the METplus Components Python Requirements Documentation + (`#2016 `_) -* Internal: + .. dropdown:: Internal - * Improve use case testing - (`#685 `_) - * Update conda environments to use 3.10 for automated use case tests - (`#2005 `_) - * Add modulefiles to the repository - (`#2015 `_) - * **Upgrade to using Python 3.10.4** - (`#2022 `_) - * Add 'License.txt' to the METplus repo - (`#2058 `_) + * Improve use case testing + (`#685 `_) + * Update conda environments to use 3.10 for automated use case tests + (`#2005 `_) + * Add modulefiles to the repository + (`#2015 `_) + * **Upgrade to using Python 3.10.4** + (`#2022 `_) + * Add 'License.txt' to the METplus repo + (`#2058 `_) METplus Version 5.0.0 Release Notes (2022-12-09) ------------------------------------------------ -.. warning:: **MAJOR CHANGES**: - - * The LOOP_ORDER config variable was removed. The variable set in a user's - config file will be ignored in favor of executing the logic that - corresponds to *LOOP_ORDER = processes*, where all times are processed for - the first item in the PROCESS_LIST, then all times are processed for the - second item in the PROCESS_LIST, etc. This may change the order that - commands are executed in a use case, but it should not change the results. - * The METplus Dockerfile was moved to internal/scripts/docker. - It was previously found in scripts/docker. - * Use cases that include **EnsembleStat** wrapper will require config file - updates. See :ref:`upgrade-instructions`. - * The default value of :term:`SCRUB_STAGING_DIR` is now *True*. - This means some intermediate files that are auto-generated by METplus such - as file lists and uncompressed files will automatically be removed unless - this option is set by the user. - These files are typically only used to debug unexpected issues. - * The default value of :term:`METPLUS_CONF` now includes the - :term:`LOG_TIMESTAMP` so each METplus run will generate a unique final - config file, e.g. metplus_final.conf.20220921121733. - - -* Enhancements: - - * **Enhance MODE wrapper to support multi-variate MODE** - (`#1585 `_) - * **Allow FCST_IS_PROB variable setting specific to tool - (FCST__IS_PROB)** - (`#1586 `_) - * **Enhance climatology field settings to be consistent with fcst/obs field** - (`#1599 `_) - * Update Hovmoeller Use case to use updated Hovmoeller plotting - (`#1650 `_) - * **Update the EnsembleStat wrapper and use case examples to remove - ensemble post processing logic** - (`#1816 `_) - * Enhance logic to consistently create directories - (`#1657 `_) - * Create checksum for released code - (`#262 `_) - * Add the user ID to the log output at beginning and end of each - METplus wrappers run - (`dtcenter/METplus-Internal#20 `_) - * Update logic to name final conf and intermediate files with a unique - identifier - (`dtcenter/METplus-Internal#32 `_) - * Change default logging time information - (`dtcenter/METplus-Internal#34 `_) - * **Remove LOOP_ORDER config variable** - (`#1687 `_) - * **Add unique identifier for each METplus run to configuration** - (`#1829 `_) - * StatAnalysis - Support setting multiple jobs - (`#1842 `_) - * StatAnalysis - Set MET verbosity - (`#1772 `_) - * StatAnalysis - Support using both init/valid variables in - string substitution - (`#1861 `_) - * StatAnalysis - Allow filename template tags in jobs - (`#1862 `_) - * StatAnalysis - Support looping over groups of list items - (`#1870 `_) - * StatAnalysis - Allow processing of time ranges other than daily - (`#1871 `_) - * StatAnalysis - Add support for using a custom loop list - (`#1893 `_) - * Remove MakePlots wrapper - (`#1843 `_) - * Add support in EnsembleStat wrapper for setting -ens_mean - command line argument - (`#1569 `_) - * Enhance METplus to have better signal handling for shutdown events - (`dtcenter/METplus-Internal#27 `_) - * TCPairs and TCStat - add support for new config options and - command line arguments - (`#1898 `_) - * Enhance the GridStat and PointStat wrappers to handle the - addition of SEEPS - (`#1953 `_) - * SeriesAnalysis - add support for setting mask dictionary - (`#1926 `_) - * Update Python requirement to 3.8.6 - (`#1566 `_) - * Enhance StatAnalysis wrapper to support now and today - (`#1669 `_) - * **Clean up use case configuration files** - (`#1402 `_) - * Add support for creating multiple input datasets - (`#1694 `_) - -* Bugfixes: - - * PCPCombine - custom loop list does not work for subtract method - (`#1884 `_) - * Set level properly in filename template for EnsembleStat forecast input - (`#1910 `_) - * Prevent duplicate observation files using a file window if - compressed equivalent files exist in same directory - (`#1939 `_) - * Allow NA value for _CLIMO_[MEAN/STDEV]_HOUR_INTERVAL - (`#1787 `_) - * Reconcile setting of METPLOTPY_BASE for use cases - (`#1713 `_) - * Add support for the {custom} loop string in the MODEL config variable - (`#1382 `_) - * Fix PCPCombine extra options removal of semi-colon - (`#1534 `_) - * Fix reset of arguments for some wrappers - (i.e. GenEnsProd) after each run - (`#1555 `_) - * Enhance METDbLoad Wrapper to find MODE .txt files - (`#1608 `_) - * Add missing brackets around list variable values for StatAnalysis wrapper - (`#1641 `_) - * Allow NA value for _CLIMO_[MEAN/STDEV]_DAY_INTERVAL - (`#1653 `_) - -* New Wrappers: - - * PlotPointObs - (`#1489 `_) - -* New Use Cases: - - * PANDA-C use cases - (`#1686 `_) - * MJO-ENSO diagnostics - (`#1330 `_) - * Probability of Exceedence for 85th percentile temperatures - (`#1808 `_) - * FV3 Physics Tendency plotting via METplotpy - (`#1852 `_) - * StatAnalysis Python Embedding using IODA v2.0 - (`#1453 `_) - * StatAnalysis Python Embedding to read native grid (u-grid) - (`#1561 `_) - -* Documentation: - - * Update documentation to include instructions - to disable UserScript wrapper - (`dtcenter/METplus-Internal#33 `_) - -* Internal: - - * Organize utility scripts used by multiple wrappers - (`#344 `_) - * Fix GitHub Actions warnings - update the version of actions - and replace set-output - (`#1863 `_) - * Update diff logic to handle CSV files that have rounding differences - (`#1865 `_) - * Add unit tests for expected failure - (`dtcenter/METplus-Internal#24 `_) - * Add instructions in Release Guide for "Recreate an Existing Release" - (`#1746 `_) - * Add modulefiles used for installations on various machines - (`#1749 `_) - * Document GitHub Discussions procedure for the Contributor's Guide - (`#1159 `_) - * Create a METplus "Release Guide" describing how to build - releases for the METplus components - (`#673 `_) - * Update documentation about viewing RTD URLs on branches - (`#1512 `_) + .. warning:: **MAJOR CHANGES**: + + * The LOOP_ORDER config variable was removed. The variable set in a user's + config file will be ignored in favor of executing the logic that + corresponds to *LOOP_ORDER = processes*, where all times are processed for + the first item in the PROCESS_LIST, then all times are processed for the + second item in the PROCESS_LIST, etc. This may change the order that + commands are executed in a use case, but it should not change the results. + * The METplus Dockerfile was moved to internal/scripts/docker. + It was previously found in scripts/docker. + * Use cases that include **EnsembleStat** wrapper will require config file + updates. See :ref:`upgrade-instructions`. + * The default value of :term:`SCRUB_STAGING_DIR` is now *True*. + This means some intermediate files that are auto-generated by METplus such + as file lists and uncompressed files will automatically be removed unless + this option is set by the user. + These files are typically only used to debug unexpected issues. + * The default value of :term:`METPLUS_CONF` now includes the + :term:`LOG_TIMESTAMP` so each METplus run will generate a unique final + config file, e.g. metplus_final.conf.20220921121733. + + + .. dropdown:: Enhancements + + * **Enhance MODE wrapper to support multi-variate MODE** + (`#1585 `_) + * **Allow FCST_IS_PROB variable setting specific to tool + (FCST__IS_PROB)** + (`#1586 `_) + * **Enhance climatology field settings to be consistent with fcst/obs field** + (`#1599 `_) + * Update Hovmoeller Use case to use updated Hovmoeller plotting + (`#1650 `_) + * **Update the EnsembleStat wrapper and use case examples to remove + ensemble post processing logic** + (`#1816 `_) + * Enhance logic to consistently create directories + (`#1657 `_) + * Create checksum for released code + (`#262 `_) + * Add the user ID to the log output at beginning and end of each + METplus wrappers run + (`dtcenter/METplus-Internal#20 `_) + * Update logic to name final conf and intermediate files with a unique + identifier + (`dtcenter/METplus-Internal#32 `_) + * Change default logging time information + (`dtcenter/METplus-Internal#34 `_) + * **Remove LOOP_ORDER config variable** + (`#1687 `_) + * **Add unique identifier for each METplus run to configuration** + (`#1829 `_) + * StatAnalysis - Support setting multiple jobs + (`#1842 `_) + * StatAnalysis - Set MET verbosity + (`#1772 `_) + * StatAnalysis - Support using both init/valid variables in + string substitution + (`#1861 `_) + * StatAnalysis - Allow filename template tags in jobs + (`#1862 `_) + * StatAnalysis - Support looping over groups of list items + (`#1870 `_) + * StatAnalysis - Allow processing of time ranges other than daily + (`#1871 `_) + * StatAnalysis - Add support for using a custom loop list + (`#1893 `_) + * Remove MakePlots wrapper + (`#1843 `_) + * Add support in EnsembleStat wrapper for setting -ens_mean + command line argument + (`#1569 `_) + * Enhance METplus to have better signal handling for shutdown events + (`dtcenter/METplus-Internal#27 `_) + * TCPairs and TCStat - add support for new config options and + command line arguments + (`#1898 `_) + * Enhance the GridStat and PointStat wrappers to handle the + addition of SEEPS + (`#1953 `_) + * SeriesAnalysis - add support for setting mask dictionary + (`#1926 `_) + * Update Python requirement to 3.8.6 + (`#1566 `_) + * Enhance StatAnalysis wrapper to support now and today + (`#1669 `_) + * **Clean up use case configuration files** + (`#1402 `_) + * Add support for creating multiple input datasets + (`#1694 `_) + + .. dropdown:: Bugfixes + + * PCPCombine - custom loop list does not work for subtract method + (`#1884 `_) + * Set level properly in filename template for EnsembleStat forecast input + (`#1910 `_) + * Prevent duplicate observation files using a file window if + compressed equivalent files exist in same directory + (`#1939 `_) + * Allow NA value for _CLIMO_[MEAN/STDEV]_HOUR_INTERVAL + (`#1787 `_) + * Reconcile setting of METPLOTPY_BASE for use cases + (`#1713 `_) + * Add support for the {custom} loop string in the MODEL config variable + (`#1382 `_) + * Fix PCPCombine extra options removal of semi-colon + (`#1534 `_) + * Fix reset of arguments for some wrappers + (i.e. GenEnsProd) after each run + (`#1555 `_) + * Enhance METDbLoad Wrapper to find MODE .txt files + (`#1608 `_) + * Add missing brackets around list variable values for StatAnalysis wrapper + (`#1641 `_) + * Allow NA value for _CLIMO_[MEAN/STDEV]_DAY_INTERVAL + (`#1653 `_) + + .. dropdown:: New Wrappers + + * PlotPointObs + (`#1489 `_) + + .. dropdown:: New Use Cases + + * PANDA-C use cases + (`#1686 `_) + * MJO-ENSO diagnostics + (`#1330 `_) + * Probability of Exceedence for 85th percentile temperatures + (`#1808 `_) + * FV3 Physics Tendency plotting via METplotpy + (`#1852 `_) + * StatAnalysis Python Embedding using IODA v2.0 + (`#1453 `_) + * StatAnalysis Python Embedding to read native grid (u-grid) + (`#1561 `_) + + .. dropdown:: Documentation + + * Update documentation to include instructions + to disable UserScript wrapper + (`dtcenter/METplus-Internal#33 `_) + + .. dropdown:: Internal + + * Organize utility scripts used by multiple wrappers + (`#344 `_) + * Fix GitHub Actions warnings - update the version of actions + and replace set-output + (`#1863 `_) + * Update diff logic to handle CSV files that have rounding differences + (`#1865 `_) + * Add unit tests for expected failure + (`dtcenter/METplus-Internal#24 `_) + * Add instructions in Release Guide for "Recreate an Existing Release" + (`#1746 `_) + * Add modulefiles used for installations on various machines + (`#1749 `_) + * Document GitHub Discussions procedure for the Contributor's Guide + (`#1159 `_) + * Create a METplus "Release Guide" describing how to build + releases for the METplus components + (`#673 `_) + * Update documentation about viewing RTD URLs on branches + (`#1512 `_) .. _upgrade-instructions: