Skip to content

Commit

Permalink
Update develop-ref after #1587 (#1689)
Browse files Browse the repository at this point in the history
* fixing typos #1049

* moving blank statistic type from statistics to diagnostics #1049

* Feature 1263 v4.1.0 beta4 (#1277)

* update version to note development towards beta5

* fixing errors #1049

* updating table name #1049

* fixing typo #1049

* Feature 934 release stage doc (#1235)

* Per #934 add stages of the METplus release cycle.

* Per #934, adding link to descriptions of the release cycle in the User's Guide.

* Per #934, made corrections

* Per #934, changed Beta and Release Candidate (rc) from bold to subsubsections.

* Update index.rst

Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>

* putting both tables into one chapter

* removing diagnostics since it's going back into the statistics chapter #1049

* Delete diagnostics_list.rst

This table will be added to the statistics page as a separate table. #1049

* test. breaking out directories A-B and C-D #1049

* testing with section names #1049

* alphbetical sections for statistics #1049

* making U-Z statistics list #1049

* alpabetical breaks for diagnostics list #1049

* trying to fix errors #1049

* trying to fix errors take 2 #1049

* trying to fix errors take 3 #1049

* Removed a unnecessary space #1049

* Making all METplus Names CAPITAL LETTERS #1049

* Feature 344 met util refactor (#1292)

* removed deprecated sections from config examples

* minor change to METplus release guide to add a link to the PDF of the User's Guide instead of downloading it and attaching it to the release

* Feature 1285 extract tiles mtd times (#1315)

* Feature 896 more met config (#1322)

* removed incorrect search keyword

* added workflow_dispatch event so workflow can be triggered by an external repository such as MET to test to ensure that changes from that repo will break anything in METplus

* added another input argument for workflow_dispatch event

* added job with name that shows the event name or the repository name if triggered by an external repository such as MET

* GHA: add username that triggered external event to event info job name

* added required input argument for external trigger that contains the commit hash of the push event that triggered in the other repo

* change event info to show commit hash instead of username that merged the PR

* changed input names to match names of event in repository that triggered workflow

* feature 1320 OMP_NUM_THREADS (#1338)

* Feature 1183 memory documentation (#1340)

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* add email address of user who triggered push event to job name

* Feature 1166 series analysis field info (#1353)

* Feature 1116 usecase smos (#1348)

Co-authored-by: Mrinal Biswas <biswas@ucar.edu>

* turn off new use case from every push

* feature 1236 Control Members in EnsembleStat and GenEnsProd (#1357)

* added optional argument to change the directory to untar new input data into so the same Dockerfile can be used to add data for other METplus components such as MET

* feature 1358 v4.1.0-beta5 release (#1359)

* update version for next development cycle

* Feature 1216 usecase smap (#1361)

* Adding a conf file for SMAP

* Adding a directory to host the read file

* Removing temp file

* Updated the valid dates to match Todd's code

* Adding documentation for SMAP case

* Updates the valis dates to match Todd's code

* Removing a tmp file

* Typo in file name

* Updating the input RTOFS to have the init time instead of the valid time ii the file name

* updated file paths, tesing

* updated use case descriptions, rearranged use case group testing

* put new use case into its own group so that the diff logic can evaluate marine_and_cryosphere:3. The truth data for 3-4 does not exist yet so the diff fails.

Co-authored-by: Mrinal Biswas <biswas@ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* updated marine_and_cryo grouping

* Feature 1230 stratosphere metrics (#1354)

* Initial checkin for Meridial Mean use case

* Changed the name and directories

* Added some documentation

* Fixed config variables

* Issue 1230 Stratospheric metrics (zonal/meridional use case) put INPUT_BASE in the user_env_vars so the user doesn't need to set the INPUT_BASE environment in the current working shell

* Issue #1230 remove import of metplotpy-this isn't called

* Issue #1230_stratosphere_metric Add use case to the list of use cases to be run for testing

* Issue 1230 Remove the INPUT_BASE from the user_env_vars section

* Issue #1230 redundant files

* Issue #1230 redundant files

* Issue #1230 redundant files

* Issue #120 replace INPUT_BASE with INPUT_FILE_NAME

* Issue #1230 remove entry for INPUT_FILE_NAME, this goes in the system.conf

* Update all_use_cases.txt

Copy and pasted #11 from s2s use case for the Stratosphere use case but forgot to update the index to 12.

* Update use_case_groups.json

added use case #12 from s2s to test stratosphere use case

* Issue #1230 put INPUT_FILE_NAME back under the user_env_vars

* Issue #1230 forgot to include the filename

* Issue #1230 clean up config file, remove uneccessary comments, group related entries in the user_env_vars

* Issue #1230 remove extraneous and incorrect path to the input_filename setting

* Removed pingouin dependency

* Issue #1230 another cut and paste error fixed for the Stratosphere use case

* Issue #1230 type in name, obs_Only should be obsOnly

* Issue #1230 added the metdatadb to the env, code imports metdatadb and may require some of these dependencies

* issue #1230 removed pingouin dependency from comment to reduce any confusion

* issue #1230 turn off the test for the Stratosphere metrics use case

* Added use case image

Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>
Co-authored-by: bikegeek <3753118+bikegeek@users.noreply.github.com>
Co-authored-by: Christina Kalb <kalb@kiowa.rap.ucar.edu>

* Corrected spelling of occurrence in two places

* Fixed misspelling of occurrence

* Found and fixed two more misspellings of occurence

* Changed version specific information to by X.Y.Z moved text indicating to click save to the bottom of the list.

* Feature 1374 python packages (#1378)

* Added documentation about updating spreadsheet of Python requirements

* Changed references to master_metplus.py to run_metplus.py

* Fixed formatting of section with run_metplus.py commands

* Updated text for updating the spreadsheet

* Removed a newly added section that wasn't needed

Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>

* feature 1368 PCPCombine use zero accum (#1381)

* feature 1369 grid_weight_flag in EnsembleStat (#1379)

* Per #1356, change how wrappers create instances of other wrappers to ensure that config settings for the created instance do not change values in METplusConfig used by the rest of the wrappers, ci-run-all-diff

* Per #1356, remove config_overrides functionality in favor of using instances -- this prevents the issue where overrides for a given tool affect the global config settings. it also forces the configs to override for an instance to be put into another config section so that it will be available in the final conf, ci-run-all-diff

* Per #1356, update documentation to reflect changes

* Per #1356, fixed unit test to no longer use deprecated approach to overriding config variables

* feature 1247 climatology settings (#1385)

* feature 1356 isolate config (#1386)

* Feature 675 Continuous Integration Documentation (#1409)

Co-authored-by: johnhg <johnhg@ucar.edu>

* feature 1382 Filename templates in MODEL (#1414)

* Feature 1289 explicit file list (#1387)

* Per PR #1387 review, fix typo

* Bugfix 1421 EnsembleStat use fcst fields in ens dictionary if ens is unset (#1422)

* fixed missing path change for docker file path

* removed variables that are not used

* Feature 1408 use case ptype (#1425)

* adding imagery, config file, updating internal tests

* updated lists, auto testing

* corrected old reference

* Update use_case_groups.json

* only trigger testing workflow for pull requests that are going into develop or main_* branches

* Feature 1371 blocking wr (#1426)

* turn off use cases for push events

* Feature 1392 climo_cdf.direct_prob and SeriesAnalysis (#1396)

* Changed event triggering rules for documentation workflow so that it will run for pull requests even if no files in the docs directory have changed. A recent pull request passed but develop failed after it was approved because files that were referenced in the use case documentation files had been deleted as part of the PR.

* feature 1273 TCGen -edeck and -shape (#1424)

* Feature 966 Fix mask.poly logic (#1430)

* Feature 1030 total seconds documentation (#1428)

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_obsERA_obsOnly_Blocking.py

* Update UserScript_fcstGFS_obsERA_WeatherRegime.py

* Update UserScript_obsERA_obsOnly_WeatherRegime.py

* Update UserScript_obsERA_obsOnly_WeatherRegime.py

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_fcstGFS_obsERA_WeatherRegime.py

* Update UserScript_obsERA_obsOnly_Blocking.py

* Update UserScript_obsERA_obsOnly_WeatherRegime.py

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_fcstGFS_obsERA_WeatherRegime.py

* Update UserScript_obsERA_obsOnly_Blocking.py

* Update UserScript_obsERA_obsOnly_WeatherRegime.py

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_fcstGFS_obsERA_WeatherRegime.py

* Update UserScript_fcstGFS_obsERA_WeatherRegime.py

* Update UserScript_fcstGFS_obsERA_Blocking.py

* Update UserScript_obsERA_obsOnly_Blocking.py

* Update UserScript_obsERA_obsOnly_WeatherRegime.py

* get branch name in job controls job

* replace logic to update input data volumes with call to dtcenter/metplus-action-data-update action

* feature 1431 remove obs_prepbufr_map (#1433)

* Per #675, added images and updated content

* added statsmodel package to metplotpy docker conda environment

* Added fcst_file_type to two wrappers (#1437)

Co-authored-by: Hank Fisher <fisherh@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* added release notes for tasks that have already been completed for beta6

* updated env var for METplotpy base to match changes made to the METplotpy repository

* Updated METplotpy base env var to preemptively match changes from PR dtcenter/METplotpy#197. Once that PR is merged into develop, a test workflow will run that should fix this issue.

* removed commented code that is no longer used

* update the instructions for updating test input data to ensure volume_mount_directories file is updated in the upcoming version directory, i.e. v4.1, so that the Docker data volumes from the release will be created properly

* removed duplicate script

* updated script to copy volume_mount_directories file into new METplus version directory

* added logic to skip files that are temporary copies of tar files that should not be added to new version directory

* updated release guide instructions for creating METplus data directory for next development cycle

* Feature 911 tc trackint (#1439)

Co-authored-by: Mrinal Biswas <biswas@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* added new use cases that are currently being reviewed to release notes

* updated event info in contributor's guide

* Feature 626 fix hovmoeller documentation (#1444)

* Update UserScript_obsPrecip_obsOnly_Hovmoeller.py

replace hovmoeller_diagram.conf with UserScript_obsPrecip_obsOnly_Hovmoeller.conf

* Update UserScript_obsPrecip_obsOnly_Hovmoeller.py

Removed a typo: UserScript This uses data from...

Now: This uses data from...

* Update UserScript_obsPrecip_obsOnly_Hovmoeller.py

* Modified the PR template to add review of the source issue metadata ci-skip-all

* feature_1403_python_components_table (#1446)

* creating new METplus Components Python Requirements

* adding a return to test

* testing use case links

* testing use case links #2

* testing use case links #3

* testing use case links #4

* Filling in some use cases

* fixing indentation #1403

* fixing indentation #1403 take 2

* fixing indentation #1403 take 3

* cleaning up anything after # in the links #1403

* entries thru D #1403

* entries thru H #1403

* fixing indents #1403

* fixing indents #1403 take 2

* fixing web name #1403

* entries thru L #1403

* entry matplotlib #1403

* entry matplotlib #1403 marking duplicate names

* entry metcalcpy #1403

* entry metcalcpy fix indents #1403

* entry matplotlib #1403 fixing duplicate names

* entry metplotpy #1403

* entry metplotpy #1403 marking duplicate names

* entry metplotpy #1403 fixing

* entry thru ps #1403

* double names #1403

* character fix #1403

* adding in missing links #1403

* thru pyproj #1403

* problem with line 353 #1403

* thru pyproj #1403 typos

* more duplicate names #1403

* line break #1403

* loose ends #1403

* adding >= to some of the versions #1403

* adding name to the Use Cases to avoid duplicate naming issues TEST #1403

* adding name to the Use Cases to avoid duplicate naming issues thru pyproj #1403

* adding thru pyresample #1403

* fixing pyresample typo #1403

* adding thru  scikit-image #1403

* fixing line breaks#1403

* web links thru  scikit-learn #1403

* web links thru scipy #1403

* web links thru sklearn #1403

* Duplicate web names. temp. fix #1403

* Duplicate web names fixed #1403

* Duplicate web names fixing #3 #1403

* Duplicate web names fixing #4 #1403

* Duplicate web names fixing #5 #1403

* table end #1403

* table loose ends #1403

* Removed unnecessary comma

* table loose ends after pull request #1403

* Minor modifications to METplus Component column

* Changed description of pyproj

* Added link for last referenced use case

* Attempting to fix doc warning

Co-authored-by: jprestop <jpresto@ucar.edu>

* Feature 1318 usecase aviso (#1440)

* Correct small typo.

* Update pull_request_template.md

* Added files for ReadTheDocs (#864)

* Updated documentation links for ReadtheDocs

* Update pull_request_template.md

Added entry for completion date for pull request review.

* Adding python embedding script to read AVISO, RTOFS, HYCOM and OSTIA data

* Updated the script - working but only RMSE values match

* Adding documentation for the AVISO case

* Adding a conf file for the AVISO case

* Updates to the codel to include model3, obs, climo3 but also has many extra print statements, netcdf output files which needs to be cleaned

* Cleaning up the conf file and adding SAL1L2 to get the model_climo sdev and obs_climo sdev

* Updating the file to fix the standard names and add the model3, climo3 and obs3

* Updating the file to fix the standard names and add the model3, climo3 and obs3

* Adding an image to the use case. Image Courtesy: EMC/NOAA website

* added to use case list

* updated case description

* removed merge issues

* caught second docs issue

* removed other doc merge issues, turned off auto test

* more merge comments sneaking in

Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Mrinal Biswas <biswas@ucar.edu>

* Revert "Feature 1318 usecase aviso (#1440)" (#1459)

This reverts commit d3021de.

* Feature 1449 v4.1.0 beta6 (#1461)

* Per #1449, updated version as specified in the Release Guide

* Per #1449, updated release notes

* Updated release date for beta6 release

Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>

* updated version number after beta release

* Feature 1318 usecase aviso attempt 2 (#1473)

Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Mrinal Biswas <biswas@ucar.edu>
Co-authored-by: j-opatz <jopatz@ucar.edu>

* error if no input template is set for GridDiag wrapper

* added comment for new logic, ci-run-diff

* updated old section name to config, ci-run-all-diff

* fixed bug with replacing wildcard characters with 'all' in output file paths

* Revert "fixed bug with replacing wildcard characters with 'all' in output file paths"

This reverts commit c11711e.

* fixed bug with replacing wildcard characters with 'all' in output file paths, ci-run-all-diff

* feature 1102 -out for TCStat and StatAnalysis (#1477)

* feature 1464 EnsembleStat probabilistic additions (#1479)

* feature 1445 normalize in GenEnsProd (#1478)

* added logic to add quotes around grid value if they are not set in conf variable value, moved error check for unset grid to init step, ci-run-all-diff

* bugfix 1486 PB2NC file window variables not read (#1487)

* added build arg to override MET DockerHub repository so development version tests can use dtcenter/met-dev:develop

* set MET DockerHub repo based on develop or stable version of METplus

* run diff logic for push events to develop and main_v* branches so we can catch if changes to external repositories caused differences in the output

* do not run diff logic on main_v* and develop branch push events -- diff logic is already running when external repository triggers workflow, which is what we need to test with the diff logic

* Added description for Use Cases

* updated script to set up new release input data directories -- use real path for all symbolic links for consistency, added usage statement

* changed logic to error if new version directory to create already exists at all -- previous logic only errors if directory is not empty

* Changed all filename template tags for datetime objects (init/valid/da_init/etc.) to use %H instead of %2H. We discovered that Python 3.6.8 interprets %2H as the same as %H (correctly substituting the hour), however Python 3.8.8 interprets %2H as 2H. The number in between the % and letter is not supported by strftime so it is not valid for these datetime values. The logic to zero-pad using this notation was written in the METplus string substitution logic and only applies to lead and level template tags. ci-run-all-diff

* feature 1274 TCGen use case using -shape/-genesis (#1492)

Co-authored-by: Kathryn Newman <knewman@seneca.rap.ucar.edu>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>

* feature 1490 Python Embedding for Point Observations (#1491)

* update use case groupings for automated tests

* removed extra comma typo, ci-run-all-diff

* added missing characters in commmands

* Feature 1403 python components table (#1497)

Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>

* testing new statistics provided by Tara #1049

* testing new statistics #2 #1049

* New statistics from Tara #1049

* New statistics from Tara small corrections #1049

* New statistics from Tara small corrections #2 #1049

* New statistics from Tara small moving to Diagnostics table #1049

* Fixing space-time, like that's possible #1049

* Fixing spacing #1049

* feature 1471 fix current field info in output_prefix (#1500)

* Feature 1503 v4.1.0 rc1 (#1504)

* update version after rc1 release to reflect development towards 4.1.0 release

* Corrected documentation title name

* bugfix 1486 pb2nc window variables (#1507)

* feature 1443 document probabilistic field settings (#1508)

Co-authored-by: johnhg <johnhg@ucar.edu>

* feature 943 document referencing current level (#1509)

* feature 1510 v4.1.0 Release (#1511)

* updated release guide to reflect updated process to trigger reference branch GHA workflow for an official release

* update version to reflect development towards 5.0.0-beta1 release

* Feature 673 MET (#1517)

* set MET docker repo to dtcenter/met if forcing a specific MET tag to use since that is where the stable release versions are stored on DockerHub

* pass variable to tell docker build script that an external workflow triggered the run and use -lite if so to ensure that MET docker image that was created by the triggering MET workflow is used

* echo output variables from job control job so they can be reviewed in the GHA log output

* minor fix for consistency in logs, ci-skip-all

* Feature 1399 usecase cable (#1538)

* Adding initial code to read AOML Cable Transport and RTOFS cable transport variables

* Updating the conf file (no stat analysis yet) and updates to the read file

* Updating the conf file to add STAT_ANALYSIS

* Updates to the code- adding stats

* Updated code--runs now but needs to follow User Script conventions

* Changed directory name based on MET conventions

* Updating the read file and adding a conf file

* Added logic to count the number of directories in the RTOFS dir

* Updated to run with UserScript conf

* update version for official release

* Adding a yaml file to specify start_date

* Added the yaml file and cleaned up the conf file

* Added logic to read the yaml file, cleaned up the script

* Updating the confile to add output dir, input template and clean up

* Removing yaml, getting vDate from conf file, adding output file

* Adding the doc file for the cable use case

* Adding image courtesy NOAA

* Adding more documentation

* Adding more info

* Updated docs

* Correcting the python embedding script

* Updating to see if the error goes away..no clue

* Fixing the doc error

* modifed docs, testing

* updated permissions for script

* turned off always testing

* Updated version number

* Update use_case_groups.json

* Removed erroneous file

* Apply suggestions from code review

* Update .github/parm/use_case_groups.json

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Update docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Update docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Update docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

Co-authored-by: Mrinal Biswas <biswas@ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Update UserScript_fcstGFS_obsERA_WeatherRegime.conf

Fixed a title typo

* Feature component links (#1518)

* Feature 770 3rd person (#1564)

* changing from 2nd to 3rd person and fixing some spacing #770

* missed we and corrected #770

* typos, spacing etc #770

* spelling, italics and bolding #770

* removing you changing to 3rd person #770

* changing to 3rd person #770

* 3rd person already done.  Fixing formatting, typos etc.  #770

* 3rd person already done.  Fixing formatting  #770

* changing to 3rd person, fixing typos, spacing, etc. #770

* changing to 3rd person, fixing typos, grammar and punctuation. #770

* google doc corrections. #770

* clean up #770

* removing |  #770

* typo #770

* Fixing TOC and coding block #770

* fixing note #770

* one 3rd person fix.  Updating bolding and italics for file names and directories #770

* Modified Python Code Analyis Tools

* Modified Python Code Analyis Tools

* Removed link for PROCESS_LIST. If we can't have an internal link, we do not want one in this case.

* fixing space #770

* fixing conflict #2 #770

* fixing typos #770

* fixing typos #2 #770

* directory formatting #2 #770

* Changed sub process to subprocess

* Modified usage of user because this text is for developers. Made other minor changes.

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>

* bugfix 1555 develop clear args properly (#1562)

* Fixed bug in classification text file (#1568)

* bugfix 1534 develop fix removal of semi-colon at end of list (#1535)

* fixed typo missed in #1477

* feature 33 (internal) disable UserScript wrapper (#1607)

* METplus-Internal #14 Initial release

* METplus-Internal #16 initial release for python scanning

* METplus-Internal #17 Disable SonarQube related path for Docker

* change Linked issue/Development issue ci-skip-all

* change Linked issue/Development issue ci-skip-all

* change Linked issue/Development issue ci-skip-all

* change Linked issue/Development issue ci-skip-all

* change Linked issue/Development issue

* Updated METexpress release guide to reflect new use of github

* added section for RAL machines

* Fix location of VERSION file

* Hofix for the develop branch to correct typo in the internal_tests/scanning/sonarqube directory name.

* install requests python package in Docker image used in run_tests custom action because it appears to no longer be available in python3 that comes with alpine:latest (latest was recently updated to 3.16.0), ci-run-all-cases

* test using specific version of alpine Docker image to see if the latest version broke the automation logic, ci-run-all-cases

* Revert "test using specific version of alpine Docker image to see if the latest version broke the automation logic, ci-run-all-cases"

This reverts commit e417803.

* Change Linked issue/Development issue ci-skip-all

* Feature 1627 release guide (#1630)

* Added instructions for updating the Coordinated METplus X.Y release section on the DTC website

* Made some wording changes.

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

* Update docs/Release_Guide/release_steps/common/update_dtc_website.rst

Co-authored-by: johnhg <johnhg@ucar.edu>

Co-authored-by: johnhg <johnhg@ucar.edu>

* feature 1608 METDbLoad read MODE/MTD txt files (#1628)

* #1614 Cycloneplotter METplotlibDeprecationWarning observed in Matplotlib versions above 3.2 (#1621)

* bugfix #1641 develop StatAnalysis list format (#1646)

* feature 1586 added wrapper-specific version of probabilistic config variables (#1644)

* Feature 1603 met data db mode (#1649)

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: Christina Kalb <kalb@mohawk.rap.ucar.edu>

* Feature 1159 discussions (#1634)

* Initial documentation for user support

* Modified to try to resolve documentation errors

* Update wording and formatting

* Attempt to fix formatting problem

* Modified and added content

* Trying out new formatting

* Trying out new formatting

* Made suggested changes from John.

* Added QC_FLAGS and ADP to the arguments correctly (#1654)

Co-authored-by: Hank Fisher <fisherh@seneca.rap.ucar.edu>

* Updating order to remove data before creating new tarfile

* feature 1585 multi-variate MODE support (#1665)

* Feature 1650 update hovmoeller (#1666)

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* feature 1599 set climo_mean/stdev using VAR<n> variable syntax (#1658)

* feature 1653 develop climo day_interval NA value (#1671)

* moved logic to handle climo_mean/stdev dictionaries into met_config utility

* moved constant variable to constants and made name uppercase

* per #1599, added logic to read VAR<n> variables for climo_mean/stdev (i.e. GRID_STAT_CLIMO_MEAN_VAR1_NAME). Added function to easily format field info for a single field or list of fields with fewer arguments

* added function to format field info that is easier to call than get_field_info and can eventually replace it

* added line breaks to match pep8 standards, ci-run-all-diff

* per 1599, added documentation for new config variables

* replaced calls to get_field_info with format_field_info since it is much simpler

* fixed bug where field list is never returned from function call

* removed whitespace

* modified logic to report an error if no commands were run at all

* only report an error if the process list contains a wrapper that should generate at least 1 command. Example and CyclonePlotter wrappers do not run any shell commands, so they are excluded

* per feedback in PR #1658 review, added glossary entry that is wrapper independent and provide reference to that entry instead of duplicating information for each wrapper

* per #1653, add unit tests to check that day_interval value of climo_mean/stdev dictionary can be NA or an integer

* per #1653, modified function to read climo variables to support NA instead of just integers

* per #1653, updated unit tests to test both climo_mean and climo_stdev variables, added tests for all other climo variables

* feature #1673 5.0.0-beta1 release (#1674)

Co-authored-by: jprestop <jpresto@ucar.edu>

* update version for development towards 5.0.0-beta2

* added logic to switch DockerHub repo used to obtain MET to use dtcenter/met-dev if the tag is develop, otherwise use dtcenter/met

* Updates to the release instructions based on MET version 11.0.0-beta1. After restructuring the repo, remove the 'met/' prefix from some paths. Also, remove the attach_release_tarfile.rst instructions since that step is no longer required. Technically, its still needed for version 10 bugfix releases, but just removing it now is simpler.

* changed version back to fix release

* changed version to show development towards 5.0.0-beta2 release after release was created

* Feature 1531 use case CFSv2 s2s (#1587)

* added documentation

* added pic, config file, more documentation

* modified config file, added to internal tests

* attempt to correct docs error

* added new tool-specific probability feature

* Updated run option in json file

Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: Mrinal Biswas <biswas@ucar.edu>
Co-authored-by: bikegeek <minnawin@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>
Co-authored-by: bikegeek <3753118+bikegeek@users.noreply.github.com>
Co-authored-by: Christina Kalb <kalb@kiowa.rap.ucar.edu>
Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: Christina Kalb <kalb@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@seneca.rap.ucar.edu>
Co-authored-by: Mrinal Biswas <biswas@seneca.rap.ucar.edu>
Co-authored-by: Kathryn Newman <knewman@seneca.rap.ucar.edu>
Co-authored-by: Howard Soh <hsoh@seneca.rap.ucar.edu>
Co-authored-by: Molly Smith <molly.b.smith@noaa.gov>
Co-authored-by: hsoh-u <hsoh@ucar.edu>
Co-authored-by: Christina Kalb <kalb@mohawk.rap.ucar.edu>
  • Loading branch information
22 people authored Jul 6, 2022
1 parent 4df6e55 commit dde9411
Show file tree
Hide file tree
Showing 49 changed files with 1,984 additions and 801 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 @@ -174,6 +174,11 @@
"index_list": "12",
"run": false
},
{
"category": "s2s",
"index_list": "13",
"run": false
},
{
"category": "space_weather",
"index_list": "0-1",
Expand Down
12 changes: 6 additions & 6 deletions docs/Contributors_Guide/add_use_case.rst
Original file line number Diff line number Diff line change
Expand Up @@ -966,6 +966,12 @@ the use case category just in case something goes wrong::
version**, then simply remove the tarfile link::

unlink sample_data-${METPLUS_USE_CASE_CATEGORY}.tgz

Remove old data (if applicable).

If the pull request notes mention an old directory path that should be removed,
please remove that directory. Be careful not to remove any files that are
still needed.

Create the new sample data tarfile.

Expand All @@ -981,12 +987,6 @@ Create the new sample data tarfile.

tar czf sample_data-${METPLUS_USE_CASE_CATEGORY}-${METPLUS_VERSION}.tgz met_test

Remove old data (if applicable)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If the pull request notes mention an old directory path that should be removed,
please remove that directory. Be careful not to remove any files that are
still needed.

Update the link in the develop directory if needed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
1 change: 1 addition & 0 deletions docs/Contributors_Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Contributor's Guide
add_use_case
continuous_integration
documentation
user_support

Indices and tables
==================
Expand Down
138 changes: 138 additions & 0 deletions docs/Contributors_Guide/user_support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
************
User Support
************

Support for the METplus components is provided through the
`METplus GitHub Discussions Forum <https://github.com/dtcenter/METplus/discussions>`_.
Discussions is a collaborative communication forum, where the METplus
community can ask and answer questions, gather feedback, and share tips and
tricks. Discussions are categorized to help community members find related
discussions and begin conversations in the right place.


Support Responsibilities
========================

Five staff members take turns monitoring Discussions each day of the week.
The responsibilities for each daily assignee are described below.


Review the Tips/Tricks Page
---------------------------

Review the `Tips/Tricks <https://github.com/dtcenter/METplus/discussions/categories/tips-tricks>`_
page.

The Tips/Tricks page is for discussion only and does not have the ability to
have an *answer* assigned to it. Check for any new dicussions that have been
added by users that are actually questions. If there are, move the discussion
to a more appropriate category so that it can be found when filtering for
unanswered discussions. Please note that if the discussions have been
filtered by "Unanswered" and the Tips/Tricks category is selected, no results
will be found because these discussions are not answerable.

If a new tip or trick has been added, please review the addition. Consider
adding any comments to add detail or clarify, and thank the user for their
contribution.

Review the Unanswered Discussions
---------------------------------

Review the `unanswered discussions <https://github.com/dtcenter/METplus/discussions?discussions_q=is%3Aunanswered>`_.

* For new discussions that have been posted on the current day (i.e. since last midnight):

* If the issue is time sensitive (i.e. related to an upcoming training series
session) or from a user with priority support, take action. See :ref:`actions_new_discussions`.

* Otherwise, leave the discussion unanswered until the next day to allow the
user community time to respond.

* For new discussions that have 0 repsonses and were posted the previous day:

* Take action. See :ref:`actions_new_discussions`.

* Remaining unanswered discussions:

* Review the latest on discussion history to see if any additional action is
required.

* If an obvious answer exists, consider marking it as the answer and
locking the discussion to prevent future posts. See
:ref:`lock_discussions`.

* If the user has not responded in 7 or more days, consider following up to
see if the user's issue is resolved or if they need more assistance.

* If unsure how to proceed, post in the User Support Slack channel of
dtc-metplus.slack.com tagging the person who has been assisting the user.

Review Answered Discussions that are Unlocked
---------------------------------------------

Review `anwered discussions that are unlocked <https://github.com/dtcenter/METplus/discussions?discussions_q=is%3Aanswered+is%3Aunlocked>`_.

If there is any recent activity on an **answered** question that indicates the
questioner is satisified with the response, click on the button to **lock** the
discussion to prevent future activity. See :ref:`lock_discussions`.

.. _actions_new_discussions:

Actions for Handling New Discussions
------------------------------------

* Check to see if the discussion should be reassigned from its current category
to some other category.

* Review the labels and pick at least one of the blue ones ("component:" and/or
repository-specific - e.g. "MET:", "METplus:", etc.) to further categorize it.

* Ensure the discussion is answered:

* If you can answer it yourself, do so.

* If you can answer it with help from someone, post to the User Support Slack
channel of dtc-metplus.slack.com, asking for advice.

* If it would be better to have someone else answer, coordinate in the User
Support Slack channel of dtc-metplus.slack.com or comment on the discussion
with something like:

*@<fill in username> would be the best person to address your question
and should respond within a couple of days.*

If it is obvious that test data will be needed, please ask the user to
send that data, pointing them to the
`How to Send Us Data <https://github.com/dtcenter/METplus/discussions/954>`_
discussions post and asking them to let you know once they have uploaded it.

.. _lock_discussions:


How to Lock a Discussion
------------------------

If an obvious answer exists and it is apparent the questioner is satisified
with the response, consider posting something like the following before locking
the discussion:

*At this point I'm going to LOCK this conversation to prevent future posts. Our team has decided that once discussions have been answered, and the answer has been confirmed, we'll lock them. We want to encourage users to ask new questions in new discussions rather than posting to old ones. Hopefully that'll make the questions/answers easier for other users to follow. So if/when more issues/questions arise, please feel free to start a new discussion.*

If there is no answer selected and no indication that the questioner is
satisified with the response, follow up, requesting that the user mark
the best answer so we can lock the discussion. The following text may need
to be modified to match a specific situation, but this is a good starting
point as an example:

*I'd like to mark this discussion as being answered and "lock it" to prevent future posts. That's how we encourage users to create new discussions for new questions. But I wanted to give you an opportunity to comment on it before doing so. Please feel free to select one of the responses as being the best answer to your original question. That'll help future users with similar questions find answers.*

If following up on discussions where the user hasn't responded back in a while,
consider posting something like the following before locking the discussion,
filling in the MONTH and DAY below:

*I wanted to check in with you about the initial discussion you submitted. We were able to provide some guidance for you on <MONTH DAY>, but haven't heard back if the suggested actions helped. If it did, or if you found a different way of accomplishing your goal, we'd appreciate hearing from you. If you have additional questions on this, we can try to find a solution; otherwise we'll choose an answer and lock this discussion due to inactivity.*

GitHub users with sufficient permissions in the METplus repository should see a
"Lock conversation" link on the right side navigation of each Discussions page.


1 change: 0 additions & 1 deletion docs/Release_Guide/met_bugfix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
.. include:: release_steps/merge_release_issue.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/create_release_extra.rst
.. include:: release_steps/met/attach_release_tarfile.rst
.. include:: release_steps/met/update_dtc_website.rst
.. include:: release_steps/met/confirm_zenodo.rst
.. include:: release_steps/finalize_release_on_github_bugfix.rst
1 change: 0 additions & 1 deletion docs/Release_Guide/met_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,5 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
.. include:: release_steps/merge_release_issue.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/create_release_extra.rst
.. 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
1 change: 0 additions & 1 deletion docs/Release_Guide/met_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Create a new vX.Y.Z official release from the develop branch.
.. include:: release_steps/create_release_branch.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/create_release_extra.rst
.. 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/update_docs_official.rst
Expand Down
11 changes: 0 additions & 11 deletions docs/Release_Guide/release_steps/met/attach_release_tarfile.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Update Version Number

* Update the version in the code and documentation:

* Update the *met_version* variable in *met/src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.
* Update the *met_version* variable in *src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.

* In *met/docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
* In *docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.

* DO NOT update the version number listed in the MET configuration files, add a new table file, or add a new test header file.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Update Version Number

* If the official release version has already been updated (e.g. beta2 and beyond), do the following:

* In *met/docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
* In *docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
14 changes: 7 additions & 7 deletions docs/Release_Guide/release_steps/met/update_version_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ Update Version Number

* Update the version in the code and documentation:

* If necessary, update the *met_version* variable in *met/src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.
* If necessary, update the *met_version* variable in *src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.

* In *met/docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
* In *docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.

* If necessary, update the version number listed in the MET configuration files:

* Default configuration files in *met/data/config*.
* Default configuration files in *data/config*.

* Sample configuration files in *met/scripts/config*.
* Sample configuration files in *scripts/config*.

* Test configuration files, searching recursively, in *test/config*.
* Test configuration files, searching recursively, in *internal/test_unit/config*.

* If necessary, add a new *met/data/table_files/met_header_columns_VX.Y.txt* defining the columns names for this version.
* If necessary, add a new *data/table_files/met_header_columns_VX.Y.txt* defining the columns names for this version.

* If necessary, add a new *test/hdr/met_X_Y.hdr* file defining the column names for this version for the test scripts.
* If necessary, add a new *internal/test_unit/hdr/met_X_Y.hdr* file defining the column names for this version for the test scripts.
19 changes: 15 additions & 4 deletions docs/Release_Guide/release_steps/update_release_notes_bugfix.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
Update Release Notes
--------------------

You can refer to the GitHub Issues page to see what has changed for this
You can refer to the GitHub Project board to see what has changed for this
release. Open the following URL in a browser:

.. parsed-literal::
https://github.com/dtcenter/|projectRepo|/issues
https://github.com/orgs/dtcenter/projects?type=beta
* Click on the Projects tab and select the project (under Repository) that
corresponds to the release you are creating.
* Click on the project that corresponds to support for the release, i.e.
|projectRepo| Version X.Y Support

* Navigate to the "Closed Issues" tab.
**If this tab does not exist**, follow these instructions to create it:

* Click on "+ New view" button on the far right side of the view tabs
* Click on "View <N>" (where <N> is an integer) and rename it to
"Closed Issues"
* Click on the down arrow next to the newly created view
* Click on "Search or filter this view"
* Enter the following info into the filter bar: **is:closed is:issue**
* Click on the down arrow next to the view and click "Save changes"

* Update the release-notes.rst file found in the User's Guide directory.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
Update Release Notes
--------------------

You can refer to the GitHub Issues page to see what has changed for this
You can refer to the GitHub Project board to see what has changed for this
release. Open the following URL in a browser:

.. parsed-literal::
https://github.com/dtcenter/|projectRepo|/issues
https://github.com/orgs/dtcenter/projects?type=beta
* Click on the Projects tab and select the project (under Repository) that
corresponds to the release you are creating.
* Click on the project that corresponds to this release, i.e.
|projectRepo|-X.Y.Z-betaN

* Navigate to the "Closed Issues" tab.
**If this tab does not exist**, follow these instructions to create it:

* Click on "+ New view" button on the far right side of the view tabs
* Click on "View <N>" (where <N> is an integer) and rename it to
"Closed Issues"
* Click on the down arrow next to the newly created view
* Click on "Search or filter this view"
* Enter the following info into the filter bar: **is:closed is:issue**
* Click on the down arrow next to the view and click "Save changes"

* Update the release-notes.rst file found in the User's Guide directory.

Expand Down
19 changes: 15 additions & 4 deletions docs/Release_Guide/release_steps/update_release_notes_official.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
Update Release Notes
--------------------

You can refer to the GitHub Issues page to see what has changed for this
You can refer to the GitHub Project board to see what has changed for this
release. Open the following URL in a browser:

.. parsed-literal::
https://github.com/dtcenter/|projectRepo|/issues
https://github.com/orgs/dtcenter/projects?type=beta
* Click on the Projects tab and select the project (under Repository) that
corresponds to the release you are creating.
* Click on the project that corresponds to this release, i.e.
|projectRepo|-X.Y.Z-rcN

* Navigate to the "Closed Issues" tab.
**If this tab does not exist**, follow these instructions to create it:

* Click on "+ New view" button on the far right side of the view tabs
* Click on "View <N>" (where <N> is an integer) and rename it to
"Closed Issues"
* Click on the down arrow next to the newly created view
* Click on "Search or filter this view"
* Enter the following info into the filter bar: **is:closed is:issue**
* Click on the down arrow next to the view and click "Save changes"

* Update the release-notes.rst file found in the User's Guide directory.

Expand Down
Loading

0 comments on commit dde9411

Please sign in to comment.