Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature 1089 add distance_map to GridStat #1190

Merged
merged 8 commits into from
Oct 6, 2021

Conversation

georgemccabe
Copy link
Collaborator

@georgemccabe georgemccabe commented Oct 4, 2021

Changes in the PR

  • Clean up logic for overriding MET config dictionaries so that they are handled consistently. This makes it much easier to add support for a new dictionary.
  • Added support for setting distance_map in GridStat including the newly added beta_value(n) variable from Feature 1673 gbeta MET#1857
  • Added information to Contributor's Guide to add new support for MET configuration variables including dictionaries

Pull Request Testing

  • Describe testing already performed for these changes:

Ensured all tests pass and added new tests to ensure new variables are read and set properly.
Also tested setting the new METplus config variables and verified that they set the correct settings in the wrapped MET config file.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

Review code changes and new Contributor's Guide content

https://metplus.readthedocs.io/en/feature_1089_distance_map/Contributors_Guide/basic_components.html#adding-support-for-met-configuration-variables

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

Info added to contributor's guide will make it easier for developers to add new support in the future

  • Do these changes include sufficient testing updates? [Yes]

New tests were added to test that the distance_map variable can be set properly

  • Will this PR result in changes to the test suite? [No]

  • Please complete this pull request review by 10/6/2021.

Pull Request Checklist

See the METplus Workflow for details.

  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Linked issues with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

@georgemccabe georgemccabe added this to the METplus-4.1.0 milestone Oct 4, 2021
@georgemccabe georgemccabe linked an issue Oct 4, 2021 that may be closed by this pull request
20 tasks
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve of this PR.

I reviewed the contributor's guide additions, and ran the doc_util.py examples. The output seems very useful and should make wrapping new MET config options in METplus easier.

I reviewed the newly wrapped distance map options and they match what MET expects.

The changes to copmare_gridded_wrapper.py to call the utility "handle" functions make the code more concise. I see additions to the grid-stat, mode, and tc-gen wrappers.

@georgemccabe georgemccabe merged commit c3e84d7 into develop Oct 6, 2021
@georgemccabe georgemccabe deleted the feature_1089_distance_map branch October 6, 2021 15:44
j-opatz added a commit that referenced this pull request Oct 6, 2021
* removed -ref from end of branch name when looking for new input data on web server so develop-ref can check for new develop data

* feature 779 add support for output_flag, nc_pairs_flag, and climo_cdf dictionaries in GridStat (#858)

* Feature 779 compare pdf (#860)

* Feature 857 tc stat met config (2nd attempt) (#862)

* remove quotes around branch items

* only build docs in GHA

* added missing jobs item

* cd back to GITHUB_WORKSPACE

* cd back to github workspace

* removed html theme options needed for version selector that are no longer used

* moved documentation building into script, use sphinx_rtd_theme from pip instead of custom version, added info to contrib guide about CI

* rename jobs and steps

* Feature 767 ext dependencies doc update (#866)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* feature CI documentation (#867)

* Feature 836 rtd release doc (#870)

* Added section for ReadTheDocs, added basic info about the Release Guide and Verification Datasets Guide, but more information on those needs to be added later

* Added information about the various versions available in the documentation

* Updated the ReadTheDocs section with information on hidden branches and how to access them; Modified dtcenter.github.io references

* Added section to add_use_case.rst about Accessing the Documentation and modified documentation.rst to indicate the docs can still be built manually

* Modified format of list

* Modified formatting

* Changed GitHub Pages links to Read the Docs links

* Modified formatting

* Fixed typo

* Updated Release Guide for Read The Docs

* Took out duplicate data and consolidated sections

* Update docs/Contributors_Guide/add_use_case.rst

Removed sentence

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

* Update docs/Contributors_Guide/add_use_case.rst

Fixed typo

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

* Update docs/Contributors_Guide/add_use_case.rst

Removed end of previously removed sentence.

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

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

* Adding NOAA/CPC to the list of requestors. Already ran the script to push this change to all the METplus repos.

* Adding common label for NOAA/OPC. The new label has already been pushed to all the METplus-related repos.

* sort list of files in directory to ensure the same result regardless of OS

* Feature 852 series by same name (#868)

* feature 871 TCGen new MET config variables (#872)

* Feature 728 update python embedding (#876)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* Feature 629 metdbload (#882)

Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: George McCabe <mccabe@dakota.rap.ucar.edu>

* feature_630_UIUC_GDF_TDF (#878)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* moved new use case into another group

* Update MODE_fcstFV3_obsGOES_BrightnessTempObjs.py

* feature 880 improve field info handling (#881)

* Feature 686 hdr tdr (#885)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* removed NEW from newly added use case

* feature 768 fix broken climo stdev (#886)

* Switched order of instructions to merge release branch and updating release notes.  Updating release notes should occur before merging the release branch.

* Feature 551 create pdf user guide (#890)

* Test latex_* settings in conf.py

* Test latex_* settings in conf.py

* Formatting in rst files for PDF

* Formatting in rst files for PDF

* Formatting in rst files for PDF

* Test rst file change for PDF formatting

* Change tocdepth to 3

* Change secnumdepth to 3

* Change secnumdepth/tocdepth to 4

* Change tocdepth to 3

* Change secnumdepth to 3

* Change secnumdepth/tocdepth to 4

* Test TOC settings

* Test TOC settings

* Test TOC settings

* Test reference section

* Test reference section

* Test quick search

* Test quick search

* Test quick search

* Test quick search

* Test quick search

* Test quick search

* Remove local pdf build lines

* Test quick search mods for PDF

* Test quick search mods for PDF

* Update quicksearch.rst

Format HTML and PDF separately

* Update quicksearch.rst

Fix typo in "only" directive

* Update quicksearch.rst

Fix typos in latex formatting

* Fix typo in quicksearch.rst

* Update systemconfiguration.rst

* Update conf.py

Address: WARNING: The config value `latex_show_pagerefs' has type `str', defaults to `bool'.

* Update conf.py

Fix typo, change master_doc variable to address warning

* Update conf.py

* Update conf.py

* Update conf.py

* Update conf.py

Test changing the root doc for PDF

* Update conf.py

Change latex_master_doc back to Users Guide

Co-authored-by: Keith Searight <searight@ucar.edu>

* Feature 779 add support for MODE and PointStat configs (#888)

* removed duplicate entry in glossary

* changed string to boolean to remove warning

* Added identifier to quicksearch.rst ci-docs-only

* Feature 779 pb2nc configs (#893)

* Feature 779 grid stat configs and climo_mean/stdev (#894)

* Changes to release guide steps for MET. Recommend making silimar changes for the other repos. For each release type, after the checkout_[develop|main]_branch.rst step, add a call to the new create_release_feature_branch.rst release step.

* Adding create_release_feature_branch.rst to all the release steps for METcalcpy, METplotpy, METdatadb, METviewer, and METexpress.

* Added argument to code-blocks

* Added release guide for METexpress development releases.

* Delete Regrid_PCP_obsERA_obsOnly_Blocking_orig.conf

Old configuration file

* Feature 626 hovmoeller diagram (#889)

Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Feature 627 coherence spectra (#891)

Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* create 4.0.0-beta5 release (#897)

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

* Update pull_request_template.md

Added entry for completion date for pull request review.

* feature 900 single metplus_config.conf file (#901)

* update version for development towards rc1

* Feature authorship (#912)

* Add a direct link for the user's guide citation and then link to it from the top-level list of authors.

* Add a release_steps/rotate_authorship.rst step and update the official release instructions for MET, METcalcpy, METplotpy, and METplus. The other repos do not include a complete set of release instructions yet.

* Change top-level authorship list to alphabetical order.

* Define author_list in docs/conf.py and reference it in the citation.

* Adding author_list to the variables to be exported.

* Use CIRA and IMSG instead of CIR and IM, respectively.

* do not run documentation workflow on develop-ref branch, only run step to upload warnings artifact if there was a failure

* test sending slack message when a release is published

* tabs to spaces

* fixed multi line command

* removed old Travis-CI content

* clean docs, READMEs, and CI for release

* changed badge for testing workflow to display status of default branch instead of specific branch so users don't see accidental breaks in develop branch and we don't need to update it for each release

* fixed path to version file in docker hook helper script

* updated manage externals stable config and created symbolic link to Externals.cfg to avoid duplicate information

* updated METplus release instructions to isolate release specific changes to release branch to avoid having to change develop branch back to original content

* ci-run-diff

* run all use cases if push to develop or main_v* branches to ensure nothing breaks!

* run ALL use cases if push to develop on main_v*

* cast PosixPath to string to prevent crash when using Python 3.8.10

* feature 681 Modifed wording of regrid dictionary references (#916)

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

* bugfix 914 handle complex _VAR<n>_OPTIONS like MET dictionaries (#915)

* added test to recreate error, then fix it

* ci-run-diff

* Feature 673 metviewer release (#910)

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

* Updated directions per Tara's instructions.

* Added update_dtc_website.rst to metcalcpy and metplotpy subdirectories

* .. include:: release_steps/met/update_dtc_website.rst

* Corrected subdirectories from met to metcalcpy and metplotpy as needed

* Feature 903 update users guide (#919)

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

* Fixes to automation to handle main_vX.Y branches (#920)

* update version to show development towards 4.1.0-beta1

* changes made to main_v4.0 as bugfix to get docker data build to stop reporting a failure

* generate union of sample data with subset to force a successful build to remove failed check

* Added release guide for METexpress production releases.

* Added announcement section to release guide for METexpress production releases.

* Added rotate author section to release guide for METexpress production releases.

* Fixed length of title underlines for METexpress release guide.

* added useful logging messages to script that builds documentation so it is clear why it fails or if is succeeds

* Added new alert: REQUIRED FOR RELEASE label to all the METplus repos.

* modified steps for METplus to include updating release date and creating -ref branch to generate truth data for testing

* Added more content to METdatadb release guides, following model of METcalcpy (#927)

* added script to run on DTCenter web server to create a new input data directory for the next upcoming release and create symbolic links to the correct files from previous releases

* feature 928 PCPCombine option to skip lookback in derive mode (#930)

* Edits to METexpress release guide

* feature 924 support extra options in RegridDataPlane (#929)

* fixed minor bug in usage wrapper

* strip off whitespace from version numbers so they are read correctly when installing as a package

* Migrate issue and PR template changes from PR MET/#1803 into METplus develop branch.

* Update README.md

Adding GitHub Discussions info

* changed non-unicode apostrophe and fixed typo in URL

* feature 749 TCPairs refactor (#937)

* removed file that should have been deleted in merge

* Probability field threshold control in SeriesAnalysis (#942)

* Somehow the required labels weren't present. Adding 2 required: labels as well as one for requestor: NASA/other.

* feature 960 GenVxMask -type (#961)

* feature 926 TCMPRPlotter improvements (#959)

* changed variable name so that it does not overwrite author variable used in copyright

* add missing quick search items (#962)

* run pip freeze before use case commands to see python environment used to run in the logs

* Feature 933 cartopy hpc (#964)

* Modification to use NaturalEarth shapefiles that are already downloaded
and saved to file in location designated by the CARTOPY_DIR environment.

* Github Issue #933 Check for CARTOPY_DIR first, if unset, then proceed as
before.

* updated documentation for offline systems

* Updated docs based on feedback

Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>

* Updated thumbnail path

* Feature 963 quick search (#965)

* Per #963, testing syntax

* Per #963, testing syntax again after error

* Per #963, testing string substitution

* Per #963, trying dot dot slash

* Per #963, found a relative path solution with dot dot slash, modified one line only

* updating quick search from develop to working branch with dot dot slash

* fixing typo

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

* Feature 839 conda envs in automation (#967)

* feature 641 MTD input to ExtractTiles (#968)

Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>

* fixed documentation typos from bad merge

* Feature 834 use case ice cover (#970)

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

* doc updates (#972)

* fixed timing logs to show MM:SS instead of HH:MM

* fixed typo in doc

* feature 936 force MET version used for testing (#977)

* moved logic for creating conda environments for metplus base and py_embed base to a script so it can be called on a local machine to create these environments

* moved logic to update conda to docker file because update cannot be done on conda for a shared version

* updated instructions to include steps to create conda environments on a local machine

* Feature 963 quick search (#981)

* Per #963, testing syntax

* Per #963, testing syntax again after error

* Per #963, testing string substitution

* Per #963, trying dot dot slash

* Per #963, found a relative path solution with dot dot slash, modified one line only

* updating quick search from develop to working branch with dot dot slash

* fixing typo

* Per #963, removed replace directive since it is not being used

* Per #963, testing change to Note section for keywords

* Per #963, Testing return in note

* Per #963, removed note section under keywords and moved down the png name.

* Per #963, trying out various formatting options

* Per #963, trying out various formatting options

* Per #963, added additional keywords headers to get a better feel for what it would actually look like

* Added numbers to keywords for easier referencing

* Per #963, cleaned up examples and left with the formatting the team chose

* Per #963, try out adding a code block around a sphinx_gallery_thumbnail_path to see if it disappears because remove_config_comments was already set to True in the conf.py file, but this only removes configuration comments from code blocks, not from text blocks.

* Per #963, trying an additonal comment to eliminate sphinx_gallery_thumbnail_path

* Per #963, removing additonal comment to eliminate sphinx_gallery_thumbnail_path because it got rid of the thumbnail image

* Per #963, adding py to code-block to see if it eliminates sphinx_gallery_thumbnail_path

* Per #963, removing the code-block because it does not get rid of sphinx_gallery_thumbnail_path

* first attempt at note update without web links

* updating keywords area

* updating keywords area

* updating keywords area

* adding quick search link

* fixing quick search link

* updating keywords area

* fixing typo

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* fixing typo

* deleting empty spaces

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* fixing typo

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* Changed ASCII2NC to ASCII2NCToolUseCase

* Modified list of keywords

* Fixed typo

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

* Feature 956 develop discussions (#988)

* Per 1833, changing met_help references to Discussions

* Per #1833, changed references to met_help@ucar.edu to Discussions and updated a couple of other links.

* Per #956, Fixed typo

* Per #956, fixed section referring to Known Issues as suggested by John HG.

* Per #956, removed met_help@ucar.edu reference. Checked to ensure author_email was not being used.

* feature 986 TCPairs valid time (#997)

* feature 986 TCPairs allow run all times when LOOP_ORDER = processes (#1013)

* Feature 1002 user script files (#1014)

* Update Blocking.py

Added some comments

* Update Blocking.py

* Added mpr output

* Added MPR output

* Updated documentation

* Fixed a path

* Updates to documentation

* call script to populate file list, output file list to output directory instead of under input base

* added env file so pytests can run easily on seneca

* improved logging readability

* moved functions up to parent class so they can be used by UserScript

* updated logic to match change to subset_input_files function return value

* in run_at_time function loop over custom list and get files for the current run time before running since this function is called only if LOOP_BY=times and does not call the function that handles this -- consider refactoring to move logic for CUSTOM_LOOP_LIST so that it is handled consistently across all wrappers instead of being handled inside each

* updated logic for UserScript to use the input dir/template variables to mimic logic in GridDiag to populate a list of files that are relevant for each run time of the use case

* always return True from get_all_files for UserScript because handling file lists is optional

* modified examples to call a script that checks environment variables and prints out the contents of file lists if they are set -- this better demonstrates how to use UserScript and how to get lists of files into a user's script, ci-run-diff

* don't loop to find files if time info is not set

* rerun use case that failed

* trigger other failing use cases to run

* changed name of config variable because name is now a reserved config variable

* skip use cases that are no longer failing

* Fixed a typo

* add skip times logic to function that finds all files to process

* added logic to put 'missing' for files that are not found for a given run time (for UserScript)

* added an extra lead time to example to demonstrate handling of missing files

* added logic to specify label for each input template file list, changed env var from METPLUS_<label> to METPLUS_FILELIST_<label>, changed user script example to find all keys that start with METPLUS_FILELIST_ to print

* added a label to demonstrate functionality

* added new config variables, ci-run-diff

* added documentation for new functionality for UserScript wrapper to find file paths

* Updated to use USER_SCRIPT text files

* Fixed typo

* Cleanup to .conf file

* Cleanup to UserScript_obsERA_obsOnly_Blocking.conf

* Updates to use the new file listing for UserScript

* Cleanup to old python programs

* Fixed a typo

* change branch for METplotpy to feature branch to test changes

* change METplotpy branch to develop since required change was merged into its develop branch

* changed use cases back to new = false so they don't run every workflow

Co-authored-by: Christina Kalb <kalb@ucar.edu>

* Feature 615 gfdl tc tracking (#1020)

Co-authored-by: George McCabe <mccabe@cheyenne1.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne5.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne4.cheyenne.ucar.edu>

* fixed incorrect length of overline

* error out if ouput data volumes fail to update

* don't fail if no volumes to build

* added error checking to script that updates docker data volumes that contain output truth data

* skip diff for binary index files created from GFDL tracker

* Feature 950 weather regime freq (#1024)

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

* Feature 952 blocking files (#1023)

* Added output MPR file for Blocking

* Cleanup and edits to creating mpr output

* Fixed a typo

* Added mpr output

* Fixed a typo

* Updated to use environment vars

* Updates to blocking documentation

* Delete conf file that was accidentally checked in

* removed unused scripts

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

* Feature 892 rmm omi drivers (#1028)

Co-authored-by: Christina Kalb <kalb@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@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Changes for 4.1.0-beta1 release (#1027)

* changed version for beta1 release

* added release notes for 4.1.0-beta1

* removed unnecessary arguments to run_metplus.py

* removed release notes item that is pushed to next beta

* added line breaks between sections

* added OMI and RMM use cases

* update version to dev 4.1.0-beta2

* support skip times in example wrapper

* Feature 759 fr met py (#1025)

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

* updated list of use cases to run in tests to reflect use case that was removed

* remove log for copying files and modify log output for difference summary so it is easier to find

* bugfix 1021 develop climo mean/stdev field (#1039)

* fixed remove_quotes logic for handling config lists to only remove quotes around each value, not every quotation mark found -- changed logic for reading climo field to remove quotes around item to properly set dictionary items, ci-run-diff

* fixed unit tests to reflect actual values to set for climo field

* save script to update use case data directories on DTC web server

* move step to update version number in develop branch right after creating release to minimize time that development will be done with the incorrect version number

* removed step that is no longer needed after #963

* added step to set up next release data directory on DTC web server

* updated wording to be more clear

* Release Guide updates (#1041)

* added newline after each difference summary item for better readability

* use relative path for image

* added content from the GitHub wiki so I could remove the wiki pages

* feature 931 default wrapped MET config file (#1037)

* updated info for _CONFIG_FILE variables in glossary

* Feature 892 rmm omi tests (#1038)

Co-authored-by: Christina Kalb <kalb@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@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>

* feature 951 add support for setting hss_ec_value (#1048)

* Fix stale URL in GitHub issue and pull request templates.

* changed import to prevent error if location of variable changes when the util directory is refactored

* report error and exit if default metplus config files were somehow removed to prevent confusing errors that will result

* updated error message to list parm directory where default confs are searched to help debugging

* suggest that METPLUS_PARM_BASE may be the cause of the error

* Added note to update information in conf.py file for release

* updated link to instructions to upload data via FTP

* feature 1057 pass directory to tcmpr plot script (#1085)

* Feature 935 release guide (#1098)

* Per #935, made updates to Release Guide

* Per #935, made updates to Release Guide

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

* Changed component installation instructions to download MET as a tar file

* changed key in use case group list from 'new' to 'run' to be more clear

* Added lines to only build documentation for pull requests where only documentation changes have been made

* Added quotes to echo on line 21

* Feature 874 doc (#1115)

* Per #874, added information for the Release Guide and Verification Dataset Guide

* Per #874, change to fix Unexpected indentation warning.

* Added lines to only build documentation for pull requests where only documentation changes have been made

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

* Update task.md

Testing addition of new default labels

* Update task.md

Fixing syntax issue with addition of new default labels

* Update task.md

Reverting to original text before changes made for addition of labels.

* Added additional default labels

* Feature 1062 pcp combine level template (#1118)

* feature 1069 TCPairs write_valid, valid_inc, valid_exc (#1122)

* Feature 1103 PointStat orank output_flag (#1124)

* per comment in #1124, changed order of output flags to group related flags

* Feature 617 gfdl etc (#1121)

* added new use cases to existing use case group

* Feature 1001 blocking statanalysis (#1125)

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

* updated instructions for updating the truth dataset reference branch

* feature_1128_v4.1.0-beta2 (#1129)

* update version for development towards next beta release

* updated release guide instructions

* update instructions to remove references to NCAR/METplus

* Feature release guide (#1132)

* Moved create_release_extra.rst into the release_steps area as all components except for METplus use the same file; Added instructions to update_dtc_website.rst

* Removed text that was not supposed to be there.

* 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>

* Removed specific versions of update_dtc_website since they did not differ from the version in release_steps

* Added variable - otherWebsiteUpdates - and its value.

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

* changed to use PRMSL instead of MSLET for mean sea level pressure

* Committing directly to develop for a minor documentation change. Add a release note step about formatting major/important changes in bold.

* feature 1067 develop install instruct (#1156)

* Per #1067, modified installation instructions and system configuration to point to installation instructions for MET

* removed RTD python package requirements since they are already installed by RTD - fixes issue where bulleted lists bullets disappeared

Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Removing version number from sphinx-gallery and adding one line to the update_release_notes files

* feature 1147 final conf sorting (#1152)

* removed config variable that is no longer used/needed

* cleaned up functions that handle setting CURRENT_[FCST/OBS]_[NAME/LEVEL]

* clean up

* expand path of config argument to run_metplus.py for easier debugging

* removed redundant logic and added comments

* cleanup

* added logic to move config variables that are runtime specific to a [runtime] section in the final conf that is written after the run completes

* changed how config arguments are read so that order that arguments are found is preserved instead of setting explicit overrides at the end

* minor change to trigger build, ci-run-all-cases

* rearranged logic to save list of config inputs with full paths for easier debugging

* move all config vars that start with LOG or end with BASE to runtime section

* remove vars that start with CURRENT from final conf

* removed confusing logic allowing override of parm base and cleaned up logging to be easier to read/understand

* added METPLUS_PARM_BASE env var logic back

* added old vs. new default value mismatch info for pb_report_type in PB2NC config file

* renamed config var name

* use PARM_BASE instead of METPLUS_BASE/parm since it will still be set

* use develop version of METviewer docker image (may need to make this configurable in testing.yml in the future)

* run cyclone plotter use case to test that new conda environment in docker image now contains missing cartopy map files

* added dockerfile to copy cartopy shape files into run image if cartopy is listed as dependencies

* download script used to download cartopy shape files and run it

* added copy of conda environment

* added logic to download cartopy shape files for metplotpy environment

* added cartopy dependency to use cases so the shapefiles are copied into run environment

* trigger 1 use case that uses metplotpy_env to test cartopy shapefiles are found properly

* added instructions to create weatherregime environment that was missing

* cleaned up list of packages used

* removed extra use case group used for testing

* removed netcdf package from env because it is already installed and version number was causing a conflict

* added cartopy shapefile copy to use case that needs it

* download cartopy shape files for weatherregime python environment because files were not found from base env (metplotpy)

* removed debug message that fills up log files with info that is not very useful

* updated input directories to use _WeatherRegime directory instead of _Blocking

* updated location of input data that was not found in UserScript_fcstGFS_obsERA_WeatherRegime

* updated readme with info on how to install metplotpy/metcalcpy in conda environments

* added 3rd group of cartopy shapefiles to download because they are used in weatherregime use cases

* try using cartopy download script from forked repo that has missing shapefile zip file added

* updated input paths to match new data locations

* use master branch of SciTools/cartopy since pull request was merged

* Feature 641 mtd feature relative (#1153)

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

* Feature 1004 usecase ghrsst marine (#1182)

* files for new use case

* added new use case and mod files

* upping verbosity for debug

* more debugging

* spelling fix

* testing for climo issues

* readded climo, changed python3 call in script

* skip docker pull because docker create command will pull if needed, print full name of data volume used for easier debugging, no longer pass docker create command output to /dev/null because logic is no longer called from shell script (previously value was passed to script via std out so any logging info would be added to content)

* moved new use case to its own section for testing

* fixed typo

* added PyEmbedIngest to process fcst/obs/climo data and read files into grid_stat to prevent out-of-memory errors

* refactored script to try to reduce the amount of unnecessary memory the script uses

* created config file to use PyEmbedIngest so use case can run as is on a machine with enough memory and run a modified version to work with the automated tests

* removed use case from test suite because it uses more memory than the docker environment has available

* removed old info

* rearranged variables for readability, removed commented out variables

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

* Upload file for new use case

* removed dependency on metplus function that is not needed

* feature 1089 add distance_map to GridStat (#1190)

* Feature 1187 name update (#1193)

* updated file names for use case

* updated documentation for renaming, changing data

* Update docs/Contributors_Guide/add_use_case.rst

* split section into 2 sections for clarity

* added info about removing old data from sample input data, added info about conda environments used for running use cases and automated tests, added text to make instructions more clear if one of two commands should be run

* added missing parenthesis

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

Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: George McCabe <mccabe@dakota.rap.ucar.edu>
Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>
Co-authored-by: Christina Kalb <kalb@ucar.edu>
Co-authored-by: mrinalbiswas <biswas@ucar.edu>
Co-authored-by: bikegeek <minnawin@ucar.edu>
Co-authored-by: Keith Searight <keith.searight@noaa.gov>
Co-authored-by: Keith Searight <searight@ucar.edu>
Co-authored-by: Molly Smith <molly.b.smith@noaa.gov>
Co-authored-by: Hank Fisher <fisherh@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: Tatiana Burek <tatiana@ucar.edu>
Co-authored-by: Venita Hagerty <38571614+venitahagerty@users.noreply.github.com>
Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: George McCabe <mccabe@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne1.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne5.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne4.cheyenne.ucar.edu>
Co-authored-by: Christina Kalb <kalb@kiowa.rap.ucar.edu>
Co-authored-by: bikegeek <3753118+bikegeek@users.noreply.github.com>
Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@seneca.rap.ucar.edu>
bikegeek added a commit that referenced this pull request Oct 19, 2021
* feature 779 add support for output_flag, nc_pairs_flag, and climo_cdf dictionaries in GridStat (#858)

* Feature 779 compare pdf (#860)

* Feature 857 tc stat met config (2nd attempt) (#862)

* remove quotes around branch items

* only build docs in GHA

* added missing jobs item

* cd back to GITHUB_WORKSPACE

* cd back to github workspace

* removed html theme options needed for version selector that are no longer used

* moved documentation building into script, use sphinx_rtd_theme from pip instead of custom version, added info to contrib guide about CI

* rename jobs and steps

* Feature 767 ext dependencies doc update (#866)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* feature CI documentation (#867)

* Feature 836 rtd release doc (#870)

* Added section for ReadTheDocs, added basic info about the Release Guide and Verification Datasets Guide, but more information on those needs to be added later

* Added information about the various versions available in the documentation

* Updated the ReadTheDocs section with information on hidden branches and how to access them; Modified dtcenter.github.io references

* Added section to add_use_case.rst about Accessing the Documentation and modified documentation.rst to indicate the docs can still be built manually

* Modified format of list

* Modified formatting

* Changed GitHub Pages links to Read the Docs links

* Modified formatting

* Fixed typo

* Updated Release Guide for Read The Docs

* Took out duplicate data and consolidated sections

* Update docs/Contributors_Guide/add_use_case.rst

Removed sentence

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

* Update docs/Contributors_Guide/add_use_case.rst

Fixed typo

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

* Update docs/Contributors_Guide/add_use_case.rst

Removed end of previously removed sentence.

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

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

* Adding NOAA/CPC to the list of requestors. Already ran the script to push this change to all the METplus repos.

* Adding common label for NOAA/OPC. The new label has already been pushed to all the METplus-related repos.

* sort list of files in directory to ensure the same result regardless of OS

* Feature 852 series by same name (#868)

* feature 871 TCGen new MET config variables (#872)

* Feature 728 update python embedding (#876)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* Feature 629 metdbload (#882)

Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: George McCabe <mccabe@dakota.rap.ucar.edu>

* feature_630_UIUC_GDF_TDF (#878)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* moved new use case into another group

* Update MODE_fcstFV3_obsGOES_BrightnessTempObjs.py

* feature 880 improve field info handling (#881)

* Feature 686 hdr tdr (#885)

Co-authored-by: George McCabe <mccabe@ucar.edu>

* removed NEW from newly added use case

* feature 768 fix broken climo stdev (#886)

* Switched order of instructions to merge release branch and updating release notes.  Updating release notes should occur before merging the release branch.

* Feature 551 create pdf user guide (#890)

* Test latex_* settings in conf.py

* Test latex_* settings in conf.py

* Formatting in rst files for PDF

* Formatting in rst files for PDF

* Formatting in rst files for PDF

* Test rst file change for PDF formatting

* Change tocdepth to 3

* Change secnumdepth to 3

* Change secnumdepth/tocdepth to 4

* Change tocdepth to 3

* Change secnumdepth to 3

* Change secnumdepth/tocdepth to 4

* Test TOC settings

* Test TOC settings

* Test TOC settings

* Test reference section

* Test reference section

* Test quick search

* Test quick search

* Test quick search

* Test quick search

* Test quick search

* Test quick search

* Remove local pdf build lines

* Test quick search mods for PDF

* Test quick search mods for PDF

* Update quicksearch.rst

Format HTML and PDF separately

* Update quicksearch.rst

Fix typo in "only" directive

* Update quicksearch.rst

Fix typos in latex formatting

* Fix typo in quicksearch.rst

* Update systemconfiguration.rst

* Update conf.py

Address: WARNING: The config value `latex_show_pagerefs' has type `str', defaults to `bool'.

* Update conf.py

Fix typo, change master_doc variable to address warning

* Update conf.py

* Update conf.py

* Update conf.py

* Update conf.py

Test changing the root doc for PDF

* Update conf.py

Change latex_master_doc back to Users Guide

Co-authored-by: Keith Searight <searight@ucar.edu>

* Feature 779 add support for MODE and PointStat configs (#888)

* removed duplicate entry in glossary

* changed string to boolean to remove warning

* Added identifier to quicksearch.rst ci-docs-only

* Feature 779 pb2nc configs (#893)

* Feature 779 grid stat configs and climo_mean/stdev (#894)

* Changes to release guide steps for MET. Recommend making silimar changes for the other repos. For each release type, after the checkout_[develop|main]_branch.rst step, add a call to the new create_release_feature_branch.rst release step.

* Adding create_release_feature_branch.rst to all the release steps for METcalcpy, METplotpy, METdatadb, METviewer, and METexpress.

* Added argument to code-blocks

* Added release guide for METexpress development releases.

* Delete Regrid_PCP_obsERA_obsOnly_Blocking_orig.conf

Old configuration file

* Feature 626 hovmoeller diagram (#889)

Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Feature 627 coherence spectra (#891)

Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* create 4.0.0-beta5 release (#897)

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

* Update pull_request_template.md

Added entry for completion date for pull request review.

* feature 900 single metplus_config.conf file (#901)

* update version for development towards rc1

* Feature authorship (#912)

* Add a direct link for the user's guide citation and then link to it from the top-level list of authors.

* Add a release_steps/rotate_authorship.rst step and update the official release instructions for MET, METcalcpy, METplotpy, and METplus. The other repos do not include a complete set of release instructions yet.

* Change top-level authorship list to alphabetical order.

* Define author_list in docs/conf.py and reference it in the citation.

* Adding author_list to the variables to be exported.

* Use CIRA and IMSG instead of CIR and IM, respectively.

* do not run documentation workflow on develop-ref branch, only run step to upload warnings artifact if there was a failure

* test sending slack message when a release is published

* tabs to spaces

* fixed multi line command

* removed old Travis-CI content

* clean docs, READMEs, and CI for release

* changed badge for testing workflow to display status of default branch instead of specific branch so users don't see accidental breaks in develop branch and we don't need to update it for each release

* fixed path to version file in docker hook helper script

* updated manage externals stable config and created symbolic link to Externals.cfg to avoid duplicate information

* updated METplus release instructions to isolate release specific changes to release branch to avoid having to change develop branch back to original content

* ci-run-diff

* run all use cases if push to develop or main_v* branches to ensure nothing breaks!

* run ALL use cases if push to develop on main_v*

* cast PosixPath to string to prevent crash when using Python 3.8.10

* feature 681 Modifed wording of regrid dictionary references (#916)

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

* bugfix 914 handle complex _VAR<n>_OPTIONS like MET dictionaries (#915)

* added test to recreate error, then fix it

* ci-run-diff

* Feature 673 metviewer release (#910)

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

* Updated directions per Tara's instructions.

* Added update_dtc_website.rst to metcalcpy and metplotpy subdirectories

* .. include:: release_steps/met/update_dtc_website.rst

* Corrected subdirectories from met to metcalcpy and metplotpy as needed

* Feature 903 update users guide (#919)

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

* Fixes to automation to handle main_vX.Y branches (#920)

* update version to show development towards 4.1.0-beta1

* changes made to main_v4.0 as bugfix to get docker data build to stop reporting a failure

* generate union of sample data with subset to force a successful build to remove failed check

* Added release guide for METexpress production releases.

* Added announcement section to release guide for METexpress production releases.

* Added rotate author section to release guide for METexpress production releases.

* Fixed length of title underlines for METexpress release guide.

* added useful logging messages to script that builds documentation so it is clear why it fails or if is succeeds

* Added new alert: REQUIRED FOR RELEASE label to all the METplus repos.

* modified steps for METplus to include updating release date and creating -ref branch to generate truth data for testing

* Added more content to METdatadb release guides, following model of METcalcpy (#927)

* added script to run on DTCenter web server to create a new input data directory for the next upcoming release and create symbolic links to the correct files from previous releases

* feature 928 PCPCombine option to skip lookback in derive mode (#930)

* Edits to METexpress release guide

* feature 924 support extra options in RegridDataPlane (#929)

* fixed minor bug in usage wrapper

* strip off whitespace from version numbers so they are read correctly when installing as a package

* Migrate issue and PR template changes from PR MET/#1803 into METplus develop branch.

* Update README.md

Adding GitHub Discussions info

* changed non-unicode apostrophe and fixed typo in URL

* feature 749 TCPairs refactor (#937)

* removed file that should have been deleted in merge

* Probability field threshold control in SeriesAnalysis (#942)

* Somehow the required labels weren't present. Adding 2 required: labels as well as one for requestor: NASA/other.

* feature 960 GenVxMask -type (#961)

* feature 926 TCMPRPlotter improvements (#959)

* changed variable name so that it does not overwrite author variable used in copyright

* add missing quick search items (#962)

* run pip freeze before use case commands to see python environment used to run in the logs

* Feature 933 cartopy hpc (#964)

* Modification to use NaturalEarth shapefiles that are already downloaded
and saved to file in location designated by the CARTOPY_DIR environment.

* Github Issue #933 Check for CARTOPY_DIR first, if unset, then proceed as
before.

* updated documentation for offline systems

* Updated docs based on feedback

Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>

* Updated thumbnail path

* Feature 963 quick search (#965)

* Per #963, testing syntax

* Per #963, testing syntax again after error

* Per #963, testing string substitution

* Per #963, trying dot dot slash

* Per #963, found a relative path solution with dot dot slash, modified one line only

* updating quick search from develop to working branch with dot dot slash

* fixing typo

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

* Feature 839 conda envs in automation (#967)

* feature 641 MTD input to ExtractTiles (#968)

Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>

* fixed documentation typos from bad merge

* Feature 834 use case ice cover (#970)

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

* doc updates (#972)

* fixed timing logs to show MM:SS instead of HH:MM

* fixed typo in doc

* feature 936 force MET version used for testing (#977)

* moved logic for creating conda environments for metplus base and py_embed base to a script so it can be called on a local machine to create these environments

* moved logic to update conda to docker file because update cannot be done on conda for a shared version

* updated instructions to include steps to create conda environments on a local machine

* Feature 963 quick search (#981)

* Per #963, testing syntax

* Per #963, testing syntax again after error

* Per #963, testing string substitution

* Per #963, trying dot dot slash

* Per #963, found a relative path solution with dot dot slash, modified one line only

* updating quick search from develop to working branch with dot dot slash

* fixing typo

* Per #963, removed replace directive since it is not being used

* Per #963, testing change to Note section for keywords

* Per #963, Testing return in note

* Per #963, removed note section under keywords and moved down the png name.

* Per #963, trying out various formatting options

* Per #963, trying out various formatting options

* Per #963, added additional keywords headers to get a better feel for what it would actually look like

* Added numbers to keywords for easier referencing

* Per #963, cleaned up examples and left with the formatting the team chose

* Per #963, try out adding a code block around a sphinx_gallery_thumbnail_path to see if it disappears because remove_config_comments was already set to True in the conf.py file, but this only removes configuration comments from code blocks, not from text blocks.

* Per #963, trying an additonal comment to eliminate sphinx_gallery_thumbnail_path

* Per #963, removing additonal comment to eliminate sphinx_gallery_thumbnail_path because it got rid of the thumbnail image

* Per #963, adding py to code-block to see if it eliminates sphinx_gallery_thumbnail_path

* Per #963, removing the code-block because it does not get rid of sphinx_gallery_thumbnail_path

* first attempt at note update without web links

* updating keywords area

* updating keywords area

* updating keywords area

* adding quick search link

* fixing quick search link

* updating keywords area

* fixing typo

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* fixing typo

* deleting empty spaces

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* fixing typo

* updating keywords area

* updating keywords area

* updating keywords area

* updating keywords area

* Changed ASCII2NC to ASCII2NCToolUseCase

* Modified list of keywords

* Fixed typo

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

* Feature 956 develop discussions (#988)

* Per 1833, changing met_help references to Discussions

* Per #1833, changed references to met_help@ucar.edu to Discussions and updated a couple of other links.

* Per #956, Fixed typo

* Per #956, fixed section referring to Known Issues as suggested by John HG.

* Per #956, removed met_help@ucar.edu reference. Checked to ensure author_email was not being used.

* feature 986 TCPairs valid time (#997)

* feature 986 TCPairs allow run all times when LOOP_ORDER = processes (#1013)

* Feature 1002 user script files (#1014)

* Update Blocking.py

Added some comments

* Update Blocking.py

* Added mpr output

* Added MPR output

* Updated documentation

* Fixed a path

* Updates to documentation

* call script to populate file list, output file list to output directory instead of under input base

* added env file so pytests can run easily on seneca

* improved logging readability

* moved functions up to parent class so they can be used by UserScript

* updated logic to match change to subset_input_files function return value

* in run_at_time function loop over custom list and get files for the current run time before running since this function is called only if LOOP_BY=times and does not call the function that handles this -- consider refactoring to move logic for CUSTOM_LOOP_LIST so that it is handled consistently across all wrappers instead of being handled inside each

* updated logic for UserScript to use the input dir/template variables to mimic logic in GridDiag to populate a list of files that are relevant for each run time of the use case

* always return True from get_all_files for UserScript because handling file lists is optional

* modified examples to call a script that checks environment variables and prints out the contents of file lists if they are set -- this better demonstrates how to use UserScript and how to get lists of files into a user's script, ci-run-diff

* don't loop to find files if time info is not set

* rerun use case that failed

* trigger other failing use cases to run

* changed name of config variable because name is now a reserved config variable

* skip use cases that are no longer failing

* Fixed a typo

* add skip times logic to function that finds all files to process

* added logic to put 'missing' for files that are not found for a given run time (for UserScript)

* added an extra lead time to example to demonstrate handling of missing files

* added logic to specify label for each input template file list, changed env var from METPLUS_<label> to METPLUS_FILELIST_<label>, changed user script example to find all keys that start with METPLUS_FILELIST_ to print

* added a label to demonstrate functionality

* added new config variables, ci-run-diff

* added documentation for new functionality for UserScript wrapper to find file paths

* Updated to use USER_SCRIPT text files

* Fixed typo

* Cleanup to .conf file

* Cleanup to UserScript_obsERA_obsOnly_Blocking.conf

* Updates to use the new file listing for UserScript

* Cleanup to old python programs

* Fixed a typo

* change branch for METplotpy to feature branch to test changes

* change METplotpy branch to develop since required change was merged into its develop branch

* changed use cases back to new = false so they don't run every workflow

Co-authored-by: Christina Kalb <kalb@ucar.edu>

* Feature 615 gfdl tc tracking (#1020)

Co-authored-by: George McCabe <mccabe@cheyenne1.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne5.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne4.cheyenne.ucar.edu>

* fixed incorrect length of overline

* error out if ouput data volumes fail to update

* don't fail if no volumes to build

* added error checking to script that updates docker data volumes that contain output truth data

* skip diff for binary index files created from GFDL tracker

* Feature 950 weather regime freq (#1024)

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

* Feature 952 blocking files (#1023)

* Added output MPR file for Blocking

* Cleanup and edits to creating mpr output

* Fixed a typo

* Added mpr output

* Fixed a typo

* Updated to use environment vars

* Updates to blocking documentation

* Delete conf file that was accidentally checked in

* removed unused scripts

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

* Feature 892 rmm omi drivers (#1028)

Co-authored-by: Christina Kalb <kalb@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@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Changes for 4.1.0-beta1 release (#1027)

* changed version for beta1 release

* added release notes for 4.1.0-beta1

* removed unnecessary arguments to run_metplus.py

* removed release notes item that is pushed to next beta

* added line breaks between sections

* added OMI and RMM use cases

* update version to dev 4.1.0-beta2

* support skip times in example wrapper

* Feature 759 fr met py (#1025)

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

* updated list of use cases to run in tests to reflect use case that was removed

* remove log for copying files and modify log output for difference summary so it is easier to find

* bugfix 1021 develop climo mean/stdev field (#1039)

* fixed remove_quotes logic for handling config lists to only remove quotes around each value, not every quotation mark found -- changed logic for reading climo field to remove quotes around item to properly set dictionary items, ci-run-diff

* fixed unit tests to reflect actual values to set for climo field

* save script to update use case data directories on DTC web server

* move step to update version number in develop branch right after creating release to minimize time that development will be done with the incorrect version number

* removed step that is no longer needed after #963

* added step to set up next release data directory on DTC web server

* updated wording to be more clear

* Release Guide updates (#1041)

* added newline after each difference summary item for better readability

* use relative path for image

* added content from the GitHub wiki so I could remove the wiki pages

* feature 931 default wrapped MET config file (#1037)

* updated info for _CONFIG_FILE variables in glossary

* Feature 892 rmm omi tests (#1038)

Co-authored-by: Christina Kalb <kalb@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@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>

* feature 951 add support for setting hss_ec_value (#1048)

* Fix stale URL in GitHub issue and pull request templates.

* changed import to prevent error if location of variable changes when the util directory is refactored

* report error and exit if default metplus config files were somehow removed to prevent confusing errors that will result

* updated error message to list parm directory where default confs are searched to help debugging

* suggest that METPLUS_PARM_BASE may be the cause of the error

* Added note to update information in conf.py file for release

* updated link to instructions to upload data via FTP

* feature 1057 pass directory to tcmpr plot script (#1085)

* Feature 935 release guide (#1098)

* Per #935, made updates to Release Guide

* Per #935, made updates to Release Guide

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

* Changed component installation instructions to download MET as a tar file

* changed key in use case group list from 'new' to 'run' to be more clear

* Added lines to only build documentation for pull requests where only documentation changes have been made

* Added quotes to echo on line 21

* Feature 874 doc (#1115)

* Per #874, added information for the Release Guide and Verification Dataset Guide

* Per #874, change to fix Unexpected indentation warning.

* Added lines to only build documentation for pull requests where only documentation changes have been made

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

* Update task.md

Testing addition of new default labels

* Update task.md

Fixing syntax issue with addition of new default labels

* Update task.md

Reverting to original text before changes made for addition of labels.

* Added additional default labels

* Feature 1062 pcp combine level template (#1118)

* feature 1069 TCPairs write_valid, valid_inc, valid_exc (#1122)

* Feature 1103 PointStat orank output_flag (#1124)

* per comment in #1124, changed order of output flags to group related flags

* Feature 617 gfdl etc (#1121)

* added new use cases to existing use case group

* Feature 1001 blocking statanalysis (#1125)

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

* updated instructions for updating the truth dataset reference branch

* feature_1128_v4.1.0-beta2 (#1129)

* update version for development towards next beta release

* updated release guide instructions

* update instructions to remove references to NCAR/METplus

* Feature release guide (#1132)

* Moved create_release_extra.rst into the release_steps area as all components except for METplus use the same file; Added instructions to update_dtc_website.rst

* Removed text that was not supposed to be there.

* 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>

* Removed specific versions of update_dtc_website since they did not differ from the version in release_steps

* Added variable - otherWebsiteUpdates - and its value.

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

* changed to use PRMSL instead of MSLET for mean sea level pressure

* Committing directly to develop for a minor documentation change. Add a release note step about formatting major/important changes in bold.

* feature 1067 develop install instruct (#1156)

* Per #1067, modified installation instructions and system configuration to point to installation instructions for MET

* removed RTD python package requirements since they are already installed by RTD - fixes issue where bulleted lists bullets disappeared

Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Removing version number from sphinx-gallery and adding one line to the update_release_notes files

* Part of Github issue #1000 METplus: added font size for legend label

* Github Issue #1000: major refactor to accommodate "sanitizing" of longitudes that could cross the International Date Line.

* Correctly returning the track dictionary in the get_points_by_track() method.

* removed extra import of pandas

* Update use_case_groups.json

* Cleaned up unneccessary comments and other things in retrieve_data() method.

* Previous checkin was missing text due to IDE settings.

* Add correction to retrieve_data() to create directory where ASCII csv file will be written

* Clean up logic that writes the csv output file.

* Reinstate saving the png file (final plot), initial checkin had hard-coded filename and location.

* Add support for when no CYCLONE_PLOTTER_MODEL value is set and reindex the subsetted dataframe to avoid array indexing issues.

* Add configuration setting for LOOP_BY

* Added CYCLONE_PLOTTER_ANNOTATION_FONT_SIZE and modified size of the marker sizes to smaller values.

* Updated config file with resolution setting, annotation size setting, and watermark on/off.

* Remove unneccessary debug logging message

* feature 1147 final conf sorting (#1152)

* removed config variable that is no longer used/needed

* cleaned up functions that handle setting CURRENT_[FCST/OBS]_[NAME/LEVEL]

* clean up

* expand path of config argument to run_metplus.py for easier debugging

* removed redundant logic and added comments

* cleanup

* added logic to move config variables that are runtime specific to a [runtime] section in the final conf that is written after the run completes

* changed how config arguments are read so that order that arguments are found is preserved instead of setting explicit overrides at the end

* minor change to trigger build, ci-run-all-cases

* rearranged logic to save list of config inputs with full paths for easier debugging

* move all config vars that start with LOG or end with BASE to runtime section

* remove vars that start with CURRENT from final conf

* removed confusing logic allowing override of parm base and cleaned up logging to be easier to read/understand

* added METPLUS_PARM_BASE env var logic back

* added old vs. new default value mismatch info for pb_report_type in PB2NC config file

* renamed config var name

* use PARM_BASE instead of METPLUS_BASE/parm since it will still be set

* use develop version of METviewer docker image (may need to make this configurable in testing.yml in the future)

* run cyclone plotter use case to test that new conda environment in docker image now contains missing cartopy map files

* added dockerfile to copy cartopy shape files into run image if cartopy is listed as dependencies

* download script used to download cartopy shape files and run it

* added copy of conda environment

* added logic to download cartopy shape files for metplotpy environment

* added cartopy dependency to use cases so the shapefiles are copied into run environment

* trigger 1 use case that uses metplotpy_env to test cartopy shapefiles are found properly

* added instructions to create weatherregime environment that was missing

* cleaned up list of packages used

* removed extra use case group used for testing

* removed netcdf package from env because it is already installed and version number was causing a conflict

* added cartopy shapefile copy to use case that needs it

* download cartopy shape files for weatherregime python environment because files were not found from base env (metplotpy)

* removed debug message that fills up log files with info that is not very useful

* updated input directories to use _WeatherRegime directory instead of _Blocking

* updated location of input data that was not found in UserScript_fcstGFS_obsERA_WeatherRegime

* updated readme with info on how to install metplotpy/metcalcpy in conda environments

* added 3rd group of cartopy shapefiles to download because they are used in weatherregime use cases

* try using cartopy download script from forked repo that has missing shapefile zip file added

* updated input paths to match new data locations

* use master branch of SciTools/cartopy since pull request was merged

* Feature 641 mtd feature relative (#1153)

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

* Feature 1004 usecase ghrsst marine (#1182)

* files for new use case

* added new use case and mod files

* upping verbosity for debug

* more debugging

* spelling fix

* testing for climo issues

* readded climo, changed python3 call in script

* skip docker pull because docker create command will pull if needed, print full name of data volume used for easier debugging, no longer pass docker create command output to /dev/null because logic is no longer called from shell script (previously value was passed to script via std out so any logging info would be added to content)

* moved new use case to its own section for testing

* fixed typo

* added PyEmbedIngest to process fcst/obs/climo data and read files into grid_stat to prevent out-of-memory errors

* refactored script to try to reduce the amount of unnecessary memory the script uses

* created config file to use PyEmbedIngest so use case can run as is on a machine with enough memory and run a modified version to work with the automated tests

* removed use case from test suite because it uses more memory than the docker environment has available

* removed old info

* rearranged variables for readability, removed commented out variables

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

* Upload file for new use case

* removed dependency on metplus function that is not needed

* Github Issue #1000 added legend label fontsize and central longitude to configuration

* Github Issue #1000 fix line plot (now use the Geodesic coordinate reference system), remove unneccessary code and comments, add support to read the central longitude from the config file.

* feature 1089 add distance_map to GridStat (#1190)

* Feature 1187 name update (#1193)

* updated file names for use case

* updated documentation for renaming, changing data

* Update docs/Contributors_Guide/add_use_case.rst

* split section into 2 sections for clarity

* added info about removing old data from sample input data, added info about conda environments used for running use cases and automated tests, added text to make instructions more clear if one of two commands should be run

* added missing parenthesis

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

* v4.1.0-beta3 release (#1195)

* updated version number for next development cycle

* Remove the setting for the central longitude, this should ALWAYS be 180 to center the map over the Pacific Ocean

* Change size of markers and remove setting for central longitude, this will always be set to 180 in the plotting script to center the map on the Pacific Ocean.

* Change class variable names to be more informative, add better commenting, cleaning up code, moving hard-coded values from the plotting method into initialization section.

* Added metplus-internal to list and changed /bin/sh to /bin/bash

* Added metplus-internal

* Removing alert: REQUIRED FOR RELEASE label in favor of already existing required labels for development and official release.

* Add DOI.

* Switch DOI to coordinated release.

* Github issue #1000, using the suggested gridlines command from SciTools/cartopy#1401 and removing the original command of ax.gridlines(draw_labels=False, xlocs=[180, -180]) to prevent overlapping of 180E and 180W for central_longitude=180. Also fixed the sorting so the final ASCII (.csv) representation of the final data frame has been reindexed.

* Update use_case_groups.json

removed extra entry for met_tools to test the cycloneplotter wrapper earlier in the process.

* Update installation.rst

update cartopy version from 0.17 to 0.18 (the 0.18 version "fixes" the issue with overlapping 180/-180 longitude labels when the central longitude is set to 180).

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: George McCabe <mccabe@dakota.rap.ucar.edu>
Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>
Co-authored-by: Christina Kalb <kalb@ucar.edu>
Co-authored-by: mrinalbiswas <biswas@ucar.edu>
Co-authored-by: Keith Searight <keith.searight@noaa.gov>
Co-authored-by: Keith Searight <searight@ucar.edu>
Co-authored-by: Molly Smith <molly.b.smith@noaa.gov>
Co-authored-by: Hank Fisher <fisherh@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: Tatiana Burek <tatiana@ucar.edu>
Co-authored-by: Venita Hagerty <38571614+venitahagerty@users.noreply.github.com>
Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: George McCabe <mccabe@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne1.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne5.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne4.cheyenne.ucar.edu>
Co-authored-by: Christina Kalb <kalb@kiowa.rap.ucar.edu>
Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: Minna Win <minnawin@seneca.rap.ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@seneca.rap.ucar.edu>
Co-authored-by: j-opatz <jopatz@ucar.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Grid-Stat configuration options for distance_map dictionary
2 participants