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 2388 update tci #2550

Merged
merged 32 commits into from
Apr 17, 2024
Merged

Feature 2388 update tci #2550

merged 32 commits into from
Apr 17, 2024

Conversation

DanielAdriaansen
Copy link
Contributor

@DanielAdriaansen DanielAdriaansen commented Apr 11, 2024

Closes #2388.

Includes:

  1. New table of contents at top of use case docs file
  2. Updated FCST python embedding script
  3. Updated OBS Python embedding script
  4. New station metadata file required for the OBS data
  5. Reorganized and updated use case conf file
  6. New OBS sample data
  • Describe testing already performed for these changes:

    I ran the use case locally and it succeeds, and it also succeds in GHA.

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

  1. Try running the use case locally
  2. @anewman89, since I am not using pre-computed TCI and using raw FLUXNET, we should probably verify that the TCI values are correct somehow. However we can't use the old TCI values because we can't guarantee that the same data filtering was applied that we are applying to the raw data. I suppose that since FCST and OBS use the same function, and the FCST input data didn't change, we could take a difference between the new FCST TCI grid and the old FCST TCI grid values- then we'd at least know the function produces the correct values.
  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes or No]
    Yes

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

  • Will this PR result in changes to the test suite? [Yes or No]
    If yes, describe the new output and/or changes to the existing output:

    Yes, the OBS input data are different and therefore the OBS values being used by MET are also different, which will result in differences in the test data. After the PR is merged, the test data will need to be updated.

  • Do these changes introduce new SonarQube findings? [Yes or No]

    If yes, please describe:
    Yes, but I resolved 3 code smells in the Python embedding script before SonarQube licensing issues cropped up, so ultimately there should be no new SonarQube findings.

  • Please complete this pull request review by [Fill in date].

    At your earliest convenience.

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • 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 the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • 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.

…puting the index for the season requested instead of all seasons all the time, which also fixes a bug selecting which season the user requested. Results are identical for all seasons for the test data for the use case.
…for pandas the only dimension is time (but it is un-named). Therefore the numerator for the covariance term had to be split out between the fcst and obs case.
… case, to compute TCI from raw observations rather than read pre-computed TCI.
…g of params, and also switches the fluxnet metadata file to a command line argument instead of an environment variable.
…d filename patterns, DEBUG mode added and set to False by default, adjustment of print statements for logging, and refactoring filtering of stations to ensure we don't process a file that we shouldn't by better coupling of filenames and stations.
@DanielAdriaansen DanielAdriaansen marked this pull request as ready for review April 15, 2024 21:35
@DanielAdriaansen DanielAdriaansen linked an issue Apr 15, 2024 that may be closed by this pull request
25 tasks
@georgemccabe
Copy link
Collaborator

@DanielAdriaansen, could you fill out the pull request template? It would be useful to know what testing is expected of the reviewers and if the differences in the use case output are expected.

@DanielAdriaansen
Copy link
Contributor Author

@DanielAdriaansen, could you fill out the pull request template? It would be useful to know what testing is expected of the reviewers and if the differences in the use case output are expected.

Done, sorry about that. I had this in draft and converted it as ready but forgot to go back and add the details.

@georgemccabe
Copy link
Collaborator

Documentation changes from this PR

@DanielAdriaansen
Copy link
Contributor Author

DanielAdriaansen commented Apr 16, 2024

Looking closer at the difference tests from CI, I note that there were unexpected differences in the FCST data. However, way back I fixed a bug here: #2388 (comment), and the differences were only in MAM and JJA so that is reassuring and DJF and SON show zero differences. Thus, the formulation of TCI remains the same, and is being called correctly for the FCST.

I spot checked a few OBS sites. From the point_stat MPR files for DJF, I see:

Truth:
Borgo Cioffi         40.52375   14.95744      10       0   4.62984    0.42177
Tonzi Ranch        38.4316  -120.96598      10       0  -2.23139    1.7888
Grignon               48.84422    1.95191      10       0  -1.09105    1.2232

Output:
IT-BCi    40.5237   14.9574       10       0   4.62984    0.95305
US-Ton    38.4309 -120.966        10       0  -2.23139    2.91969
FR-Gri    48.8442    1.9519       10       0  -1.09105    0.717

What we can see is that:

  1. FCST values match
  2. OBS values do not match, but the sign is the same and the new values are higher for these three sites
  3. The station metadata (lat/lon) matches

The OBS values being different here is almost certainly driven by differences in decisions about what quality of raw FLUXNET data to include in the TCI calculation, compared to whatever data the previous TCI provider chose to use. I'm not sure there's a way to quantify this, but rather just be confident in our data filtering and take the matching FCST values as an indicator the actual math for computing TCI remains unchanged.

…ESM_obsFLUXNET2015_TCI.py

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

@georgemccabe georgemccabe left a comment

Choose a reason for hiding this comment

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

I added the new data for the v6.0 and develop branches, then confirmed that I could run the use case on seneca using the new data.

I approve, pending @anewman89's review

@anewman89
Copy link

@DanielAdriaansen Thanks for the testing and explanation of the results. I agree it seems like we're ok with the TCI computation. I also approve the PR.

@DanielAdriaansen DanielAdriaansen merged commit 4b000c4 into develop Apr 17, 2024
67 of 69 checks passed
DanielAdriaansen added a commit that referenced this pull request Apr 17, 2024
* added release notes for other items completed for rc1 release

* Feature #1626 TCDiag Wrapper (#2201)

* Feature #1610 first round of SonarQube fixes (#2200)

* Feature #2195 create v5.1.0-rc1 release (#2204)

* Update version for development towards official release

* updated script to use metplotpy as base and install pygrib because conda was failing trying to install matplotlib in Docker for some strange reason

* Feature 2188 use case panda c (#2202)

* added first use case, need to finish docs and add to list

* added documentation files, 3 new cases

* added 5th use case, docs

* final use case, corrected paths for output

* Update GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.py

* removed chars, added space to last section

* turn off 5/6 new air quality and comp use cases because they are causing the disk to fill up in the automated tests and only 1 is needed to test the new behavior. Reordered use case groups to be alphabetical

* disabled other new air quality use case because the disk is still filling up from this case

* Feature 2136 cross spectra (#2208)

* per #2212, continue instead of return so other forecast leads will not be skipped

* Feature #2210 MODE multi-variate variable rename (#2211)

* Bugfix diff tests (#2217)

* added change from NCEP produtil that was somehow not included in the changes pulled from their repo before starting SonarQube work

* Feature #2228 v5.1.0-rc2 release (#2229)

* update version after rc2 release to note development towards official 5.1.0 release

* Feature #2188 move PANDA-C cases to clouds category and fix automated tests (#2237)

Co-authored-by: j-opatz <jopatz@ucar.edu>

* Feature 2198 use case amdar pbl (#2206)

Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>

* Bugfix #2235 rename multivar_itensity to multivar_intensity_flag (#2236)

* Feature #2230 MvMODE usecase doc updates (#2239)

This updates the use-case documentation to go along with the multivariate MODE enhancements.

* combine release notes from development releases for 5.1.0 release

* fix indentation to prevent incorrect nesting of drop down menus

* Bugfix #2241 Create directory containing -out_stat file (#2242)

* Enhance diff logic to control decimal precision to prevent failures (#2243)

* Bugfix #2245 use unique run ID to name logger instance (#2247)

* per #2245, add METplusConfig class function that is called when object is deleted to close log handlers. This prevents OSError: [Errno 24] Too many open files from running all pytests

* Feature #1626 TCDiag updates to wrapper and basic use case (#2248)

Co-authored-by: Jonathan Vigh <jvigh@ucar.edu>

* move new use case into another group

* Bugfix #2244 develop fix diff tests (#2254)

* skip diff for specific png images that produce diffs occasionally but look the same visually

* add 2 more keywords for use cases that occasionally flag small, unnoticeable diffs in png images

* Feature #2253 update tests for diff_util (#2256)

Co-authored-by: root <root@localhost>

* Feature #1974 Documentation: update coding standards section (#2260)

* Feature #2253 conftest fixture to set pytest tmpdir (#2261)

* Feature #2151 Documentation: Add quick search keywords METplotpy/calcpy use cases (#2259)

* Feature #2138 CI enhance MET Docker tag override (#2258)

* Updating development instructions.

* fixed typo

* fixed another typo

* Feature #2207 Documentation - Updates to Contributor's Guide (#2263)

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

* Feature develop update install files (#2266)

* Updating installation files

* Removing run_commands.sh

* Updated the file to add a MINICONDA_PATH

* Adding files for jet

* Adding orion file

* Removing beta references

* Corrected met version

* Adding files for WCOSS2 machines

* Removing rc1 from acorn file

* Removing beta1

* Bugfix #1853 develop - PointStat don't require mask variables to be set (#2262)

* update version of certifi to match auto-generated dependabot PR #2267

* feature #2253 more tests for diff_util.py (#2264)

* update versions of METplus components for the next official release

* updated release notes for 5.1.0 release

* removed duplicate entries in release notes

* Added EC2 instance recipee with S3 mounting ability (#2269)

* Updating the Subsetting Tests by Marker section (#2272)

* update release date for 5.1.0 release (#2276)

* update version for development towards 6.0.0-beta1 release

* added new use case that was missing

* Bugfix #2279 develop - buoy station file from 2022 (#2280)

* Feature 2253 series analysis tests (#2277)

* Fix typo in pull_request_template.md

* Make code coverage report available (#2287)

* Use updated dtcenter/metplus-action-data-update tag that fixes bug that causes GHA disk to exceed capacity when too many data volumes are created. Use specific commit of coveralls python action to ensure it will not change

* removed climatology keyword from use cases that aren't relevant that were accidentally added with PR #1984

* update readme with current information

* Feature #2282 coord_release_docs (#2288)

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

* continue workflow if coveralls step fails -- this typically happens on a pull request from a fork because the authentication fails

* Feature 2253 system util tests (#2297)

* Feature #2294 LSR use case (#2295)

* Feature 2253 run util tests (#2307)

* Release Guide - remove beta/rc tags/releases (#2309)

* Add 'component: repository maintenance' label. Already ran the script to push this change and the NOAA OAR reporting label to all the METplus repos.

* Hotfix for labels, adding a new one for 'component: input data' and also fixing the get_lablels.sh to search for up to 200 existing labels. Also work on the log messages.

* Fix typo in comment

* Feature #2283 time looping consolidation (#2311)

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

* New issue template: Update Truth (#2332)

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

* feature #2253 tests for run_util, 'Usage' bugfix (#2313)

* Feature #2338 Debian 12 Conda environments (#2341)

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

* Feature 1488 usecase satwinds (#2324)

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

* Feature #2283 include times (#2345)

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

* feature #2253 tests for config_validate, mock logger in conftest (#2320)

* Feature #2299 / #2310 Remove deprecated MET config env vars and TCMPRPlotter (#2347)

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

* remove MODEL and OBTYPE to use defaults from MET config

* Feature #2348 v6.0.0-beta1 release (#2351)

* update version for development towards 6.0.0-beta2 release

* copy libGL and libEGL files into docker image to prevent errors with geovista python package

* run use that uses geovista to test

* Feature #2156 release_acceptance_testing (#2352)

* feature #2253 print error logs from conftest (#2358)

* feature #2253 met_db_load tests (#2355)

* Rename 5.1.0.lua_wcoss2 to 6.0.0.lua_wcoss2

* Update and rename 5.1.0_acorn to 6.0.0_acorn

* Update 6.0.0_acorn

* feature #2253 add tests for gfdl_tracker (#2354)

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

* Create 6.0.0_gaea

* Update and rename 5.1.0_hera to 6.0.0_hera

* Feature #2156 release_acceptance_testing take2 (#2361)

Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>

* Feature #2329 Docker info in Installation Chapter (#2366)

* feature_2253_extract_tiles_tests (#2368)

* Feature 2253 tc pairs tests (#2369)

* Feature 2253 tc csv writer (#2373)

* update requirements for building docs to get around build failure where python packages required to build RTD have disappeared from the automatically generated commands from RTD

* fix ReadTheDocs requirements to include pillow which is a dependency of sphinx-gallery: see https://blog.readthedocs.com/defaulting-latest-build-tools/ for more info on why this was necessary

* Feature #2340 TCDiag one_time_per_file_flag (#2374)

* Update and rename 5.1.0_jet to 6.0.0_jet

* Added libssh

* prune docker files before running use cases to prevent running out of disk space when running use cases, ci-run-all-diff

* Feature 2253 command builder tests (#2378)

* Feature 2253 series analysis test (#2380)

* Feature 2253 py embed test (#2379)

* ignore cyclone plotter from code coverage report because it will be replaced with METplotpy logic

* Feature 898 headers (#2389)

* changing _ to - for header consistency

* changing _ to - for header consistency

* updating all headers for consistency

* updating all headers for consistency and adding spacing

The spacing doesn't seem to be required but it is the convention that we follow for headers.

* updating all headers for consistency

* updating headers for consistency and adding capital letters to  headers

* Using the overline ### to keep index consistent with other indexes

* updating all headers for consistency

* update requirements for building docs to get around build failure where python packages required to build RTD have disappeared from the automatically generated commands from RTD

* updating all headers and some spacing for consistency

* updating headers for consistency

* changing to ### for consistency

* Per #898, fixed the headers for the Release Guide part, chapters, and sections.

* Duplicating changes in develop branch for requirements.txt file

* updating headers

* Per #2669, updated header formatting to resolve errors

* Per #2669, udpating header

* Per #2669, udpating headers

* Per #2669, udpating header

* Per #2669, updated header formatting

* Per #2669, update header formatting

* updating headers

* Per #898, removed space in front of title

* Capitalizing Please

* changing to just italics to match standard formatting

* indenting for consistent formatting

* fixing italics again

* changing from note to warning for consistency

* updating headers, adding some capitalizing to the headers

* fixing typo

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

* This file was committed but never updated or used

Per Minna, ok to delete.

* Restructuring table of contents to make it more clear which guides are for users and which are for contributors

* fixing formatting for clairity

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

---------

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

* Feature #2349 upgrade instructions for deprecated MET config files (#2386)

* Feature 2123 di doc update (#2392)

Co-authored-by: Tracy <tracy.hertneky@noaa.gov>

* change log to list name of config variable , e.g. GRID_STAT_CONFIG_FILE, to easily see which variable should be removed

* Major refactor including elimination of unnecessary imports, only computing the index for the season requested instead of all seasons all the time, which also fixes a bug selecting which season the user requested. Results are identical for all seasons for the test data for the use case.

* Feature 1667 doc conventions (#2397)

* New additions based on the old branch feature_1667_updating_overview

* Moving the release-notes reference label

* Added label for METplus_glossary for use in Documentation conentions section.

* Adding images for the Documentation Conventions section

* Modifying wording and testing formatting in Internal Links section

* Second take on formatting

* Third attempt at formatting

* Fourth attempt at formatting

* Modified wording, sections, and formatting

* Minor modifications

* Added period

* Changed Pretty Table to PrettyTable

* Modify informationg about converting an existing table and adding images

* Resolving errors

* Reformatting

* Moving placement of reference label

* Attempting to fix table title

* Fixed incorrect alignment

* Made changes based on Lisa's suggestions

* Made changes based on Lisa's suggestions

* Made corrections

* Made corrections

* Per #1667, fixing typos

* Per #1667, corrected text

---------

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

* Feature #2377 Log to terminal only (#2398)

* Update conda envs to use conda-forge only (#2402)

* rearrange MET config env var tables for GridStat so they are in the order that they appear in the wrapped MET config file

* use mamba instead of conda and update version of netcdf python package used to 1.6.2

* skip s2s_mid_lat WeatherRegime use case that produces different results often

* updated version of xesmf because <0.7.1 does not work with mamba

* per #2412, fix bug in GenVxMask to put quotes around argument so a grid specification string with spaces will be an accepted value

* downgrade version of esmf package to fix bug described in pangeo-data/xESMF#246

* Feature #2219 SeriesAnalysis multiple input files (#2408)

* Adding 3 new requestors to the list of common_labels.txt for NOAA/NHC, CSU/CIRA, and Australian BOM ci-skip-all

* Feature 2405 match tables2wrapper (#2416)

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

* per #2423, follow symbolic links when traversing directories to find files within a time window, ci-run-all-diff

* Feature #2252 WaveletStat wrapper (#2427)

Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>

* add WaveletStat use case to group and temporarily disable TCDiag use case because changes to the wrapper are needed to fix it after changes to the MET tool were merged

* update version number for beta2 release (#2431)

* update version for dev towards beta3

* Feature #2371 Embed use case upgrade demo video into upgrade instructions (#2444)

* fix failing use case tests -- install python packages dateutil and requests via apk instead of pip because the pip commands began failing -- see PEP668 https://peps.python.org/pep-0668/ -- also changed scripts to create conda environments for use case tests to install all packages in a single call to mamba instead of individual calls

* remove commands to install geovista from source because it is now installed from conda

* Feature #1989: Add OMI use case (#2457)

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

* Feature #2432 TCDiag new config changes (#2453)

* move medium range 10 use case into group with 3-5 to speed up runs

* Feature #2334 land_mask (and topo_mask) in PointStat (#2456)

* added use cases with pygrib

* Feature #2430 TCPairs consensus.diag_required and consensus.diag_min_req (#2439)

* Quickfix cloud use case desc imgs (#2464)

* added pics, updated desc

* add last two imgs

* Fixing spelling and capitalization

* Feature 2454 doc overview conv (#2471)

* adding documentation in different sections

* adding grid table section

* fixing links

* grammar updates

* Per #2454, updated sections and wording.

* Per #2454, added a period to the end of a sentence.

* Per #2454, fixing formatting

* Per #2454, updating wording

* adding a section for line breaks in a table

* adding :code: information

* trying to fix warning

* take 2

* take 3 or 4

* maybe fixed

* updating link

* fixing web link again

* web link saga continues

* Changed "ReadTheDocs" to "Read the Docs"

* Updated "main_v" references to be "main_v12.0"

* Removed references to main_v*, replacing with raw RST 

It is not maintainable to have links to branches which will become old.  Since we can avoid it by adding the raw RST in the documentation, I have removed all references to main_v* in favor of placing the raw RST in the documentation.

* Modified the "Code in a Paragraph" section

* Reworded for consistency within the document

* Added back the link for Sphinx code blocks

---------

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

* add argument to workflow dispatch event so that MET DockerHub repo used for tests can be easily overridden to test changes in a MET PR before merging

* Feature dtcenter/MET#2796 GHA Node20 deprecation warnings (#2473)

* per dtcenter/MET#2796, update versions of actions to prevent deprecated node warnings in GHA runs

* change arguments to workflow dispatch so they are no longer required -- these are not needed to be set when triggering by hand through the web interface

* Feature dtcenter/MET#2796 develop - Fix error log artifact creation (#2475)

* updated version of pillow to fix security vulnerability alerted by dependabot in PR #2477

* remove docker image after runtime image is created from metplus image and conda env image

* turn on use case to test image removal

* prune images if image tag doesn't exist -- it appears that if the image is built on the fly (when PR is coming from fork) then the tag exists, but if not, the image tag is set to <none>

* support commands that must run in the shell to see if || will work in docker image pruning step

* try to fix image removal

* Feature 2383 use case sat alt (#2480)

* new docs, files for use case

* new files

* updating to run use case

* updated python libraries, changed test env

* trying new point logic

* added to script for nan removal

* redid Python script to take adv of new MET ability for nans

* Update run status

* removed unused settings

* run image prune commands separately

* changed shell back to false

* split up use case groups so the same envs are used by a group to see if that resolves the disk space issues

* turn off use cases

* feature 2253 fix empty pytest logs (#2485)

* added more commands to free up disk space as suggested in https://github.com/apache/flink/blob/master/tools/azure-pipelines/free_disk_space.sh, ci-run-all-cases

* Feature 2406 redo usecase rrfs (#2488)

* issue #2406 RRFS use case files

* issue #2406 added usecase to tests

* Issue #2406 added metplotpy and metcalcpy as dependencies

* Feature #2460 allow missing input (#2493)

* changed template to use datetime format that works on MacOS

* update logic to only write a file list file if there are more than 1 files, updated unit tests to match new behavior, added exception handling to series analysis to prevent crash if file does not exist

* use getraw instead of getstr to prevent crash if providing a filename template tag to override a config variable on the command line

* Add optional argument to subset file function to always write a file list text file even if there is only 1 file found. Use this argument in UserScript wrapper so that the environment variables that contain paths to file list files are consistent in format for use in user scripts

* enhanced function to support different output variable types

* removed the need for overriding clear function in specific wrappers and added optional argument to skip clearing input file list

* clean up formatting

* per #2460, start to implement logic to prevent errors when some input files are not found

* isolate logic to find input files into find_input_files functions. clean up those functions to return boolean instead of sometimes returning None or a list of files to be consistent

* remove python embedding checks because MET is now smart enough to determine if a python script is used with always setting file_type

* turn on use cases to test error handling

* merge artifacts

* run only failed cases

* always run merge step

* run on a case that will succeed to test error log merge step

* only run error log merge step if there were 'Save error logs' jobs that succeeded

* run cases that will fail

* fix condition to merge error logs

* run group that will succeed but have diffs - check error logs doesn't fail

* testing - add use case group that will succeed but will cause diffs becaus there is no truth data - to confirm that the error log merge step behaves properly in this case

* run 3 jobs, 2 should error, to confirm that error_logs is created properly

* repeat diff no error test but with

* per dtcenter/MET#2796, fix error log artifact creation by merging error logs if any of the 'Save error logs' steps ran successfully

* run test to confirm diff does not cause merge error logs to fail

* Revert "run test to confirm diff does not cause merge error logs to fail"

This reverts commit ff2d1ca.

* run test to confirm error logs are merged properly when 2 use case groups have errors

* try checking output variable as string instead of boolean

* Revert "run test to confirm error logs are merged properly when 2 use case groups have errors"

This reverts commit 8106666.

* run test again

* test again

* move check for error logs for shell script and use github env vars

* Revert "run test again"

This reverts commit 7a0a99c.

* break 2 use cases to test that error logs are still created properly

* checkout repo to get script used to merge error logs

* Revert "break 2 use cases to test that error logs are still created properly"

This reverts commit cb6d0b4.

* test merge error log again on no error diff run

* fix script

* move merge error logic back to workflow

* break 2 use cases to test that error logs are still created properly

* Revert "break 2 use cases to test that error logs are still created properly"

This reverts commit 82aa0e1.

* remove testing use case group

* Revert "remove python embedding checks because MET is now smart enough to determine if a python script is used with always setting file_type"

This reverts commit de3b4b0.

* clean up lines

* update logic to check that python embedding is set up properly to only try to set file_type automatically if it is not already set and if the wrapper is a tool that supports multiple input files via python embedding (which require file_type to be set). also changed error if not set properly to warning and use PYTHON_NUMPY as a default

* remove run_count increment before run_at_time_once - set closer to find_input_files so run count and missing input count are consistent

* return boolean from find_input_files function to be consistent with other functions

* per #2460, warn instead of error if missing inputs are allowed, track counters for number of runs and missing inputs

* per #2460, added check to report error if allowed missing input threshold is met

* run clear before running plot_data_plane

* removed test group

* report warning instead of error if ALLOW_MISSING_INPUTS is True

* cleanup

* change function to pytest fixture so it can be used by other test scripts

* update ascii2nc test to process more than 1 time to ensure commands are built properly for each run

* add unit tests to ensure missing input file logic works properly for ascii2nc and grid_stat

* set variable to skip RuntimeFreq logic to find input files to prevent duplicate increment of run_count -- these will be removed when the wrapper has been updated to find files using RuntimeFreq logic

* remove unneccesary error checking

* cleanup

* call function to handle input templates that need to be handled separately for each item in the comma-separated list (for UserScript and GridDiag only)

* add time_info to ALL_FILES dictionaries to be consistent with other wrappers

* clean up logging for reporting error when missing inputs exceeds threshold

* added function to get files for a single run time to be consistent with other functions

* skip increment of run_count when FIND_FILES=True and RuntimeFreq input file logic is skipped to prevent duplicate increments

* added empty test files

* remove redundant variables

* view warnings on a failed test run

* add more empty test files

* added unit tests for missing input logic

* remove MANDATORY setting for EnsembleStat and GenEnsProd and instead pass mandatory argument to call to find model files so warnings/errors are properly displayed for other inputs

* cleanup

* remove allow missing input logic from ExtractTiles wrapper

* added functions to parse template/dir variables from config, removed explicit calls to read those variables from GridStat

* remove error if more labels than inputs are provided (for UserScript and GridDiag only) -- extra labels will just be ignored

* added required boolean for input templates

* per #2460, change warning messages to debug when checking a list of DA offsets since it is common that a given offset will not always be found in the files

* added tests for missing input logic for many wrappers

* cleanup

* fix increment of number of runs

* skip missing input logic

* change how required is handled for input templates

* warn instead of error if missing input is allowed

* remove increment of missing input counters because it is handled in RuntimeFreq

* check status of input files and increment counters in overridden run_once_per_lead. remove increment of missing input counters because it is handled in run_once_per_lead

* added unit tests for missing input logic

* skip missing input logic

* cleanup

* cleanup, use fixture for tests, add unit tests for missing input, bypass missing input logic on wrappers that don't need it

* removed file that is not needed

* added unit tests for pb2nc to test -valid_beg/end arguments and changes to properly support any runtime frequencies

* warn instead of error if allowing missing inputs

* cleanup

* implement changes to properly support all runtime frequencies for pb2nc. previously all files that match a wildcard will be used instead of selecting only files that fall within the specified time range. some functions moved into pb2nc wrapper will eventually be moved up so that they are used by all wrappers to be consistent

* added unit tests that will fail until wrapper is updated

* replace functions in RuntimeFreq wrapper used to find input files so they can be used by all wrappers, updated ioda2nc wrapper to find input files properly to fix tests

* cleanup

* removed mtd version of get_input_templates and added logic to RuntimeFreq's version to get the same behavior

* added unit tests for MTD missing input checks

* per #2491, add release notes for beta3

* Feature #2491 v6.0.0 beta3 (#2495)

* update version for beta3 release

* fixed typos in release notes

* update version to note development towards beta4 release

* Per suggestion from @JohnHalleyGotway, create intermediate branch for updating truth data to avoid branch protection rules. I added a step to delete the intermediate branch locally if it exists to prevent conflicts with the update

* added quotes to prevent error in echo caused by parenthesis

* fix incorrect command

* Revert "fix incorrect command"

This reverts commit e7dffb6.

* Revert "added quotes to prevent error in echo caused by parenthesis"

This reverts commit c1cb3c4.

* Revert "Per suggestion from @JohnHalleyGotway, create intermediate branch for updating truth data to avoid branch protection rules. I added a step to delete the intermediate branch locally if it exists to prevent conflicts with the update"

This reverts commit 525809d.

* Hotfix: Allow symbolic link to run_metplus.py to run (#2500)

* Adding use case tests

* Changing test environment

* Testing environment changes

* Documentation update

* Updating Documentation

* Updating documentation for disk space failure

* Added new use case category

* Fixing use case test

* Fixing bug in use case file

* Testing s2s after data removal

* add back use cases that were accidentally removed

* fix incorrect use case added

* Setting tests to false for merge

* Removes extraneous imports.

* Switches to function call for the coupling index.

* Correct number of args in comment.

* Testing for old use cases

* Setting tests to false for merge

* update tests to update develop data -- modified commands to create new use case category directory if it does not already exist, move step to remove old data to be completed just after new data is copied to vX.Y

* Summation has to have a dimension supplied for the gridded data, but for pandas the only dimension is time (but it is un-named). Therefore the numerator for the covariance term had to be split out between the fcst and obs case.

* Feature 2463 modify table (#2508)

* creating test dropdown menus

* fixing warnings

* fixing warnings

* fixing warnings 3

* fixing warnings 4

* Attempt to fix documentation errors

* adding 2 more test dropdowns

please note.  There is still a message about 
WARNING: Duplicate explicit target name: "gridstat: cloud fractions with neighborhood and probabilities (pygrib)".
John O will fix this.  I should not touch it.

* fixing spacing

* trying to fix link

* take 2

* Removing double underscores added earlier

* moving dropdown menus

* Adding version to dropdown menu title

* fixing spacing

* dropdowns date util, eofs, h5py

* fixing formatting

* fixing formatting

* Per #2463, adding template for future entries

* adding imageio, lxml & matplotlib

* dropdown up to nc-time-axis

* fixing spacing problems

* Fixing broken s2s links and other incorrect links

* Fixing spelling and capitalization

* Removing the dash in front of 1.4 for nc-time-axis

* Modifying formatting

* adding dropdowns thru pylab

* fixing problems

* dropdowns thru scikit-learn

* fixing spacing

* final dropdowns thru yaml

* fixing spacing

* fixing loose ends

* Per #2463, moving information to an Appendix and adding text and links in an overview

* Per #2463, adding to index.rst

* Per #2463, reworded language and updated Python 3.8 reference

* Per #2463, fixing errors

* Per #2463, made updates based on feedback at the METplus Engineering meeting.

* removing tables, changing most METplus wrappers, version numbers.

* trying to fix met_version

* Per #2463, adding necessary code for substitutions

* Per #2463, fixing syntax error

* adding period

* removing section 1.5

* Per #2463, replace old label reference with new label reference and updated text to reflect the move to drop down menus

* read python version from file to replace in docs

* fixed typo in variable name

* adding python_version to the overview.

---------

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

* per #2509, automate MET version used in documentation to be X+6.Y.0 of METplus version

* Bugfix #2520 ASCII2NC file window issue and redundant wrapper initialization (#2522)

* per PyCharm documentation, only ignore workspace.xml idea file and commit the rest of the .idea files to version control

* per #2520, create function to get METplus wrapper class without initializing it and use that function to read list of deprecated env vars to prevent redundant initialization of wrappers that can cause unintended side effects

* handle file_window variables consistently by using CommandBuilder function

* comment out optional config variables that previously caused a failure when unset

* Update update_truth.md

Fix typo in the update_truth issue template in the develop branch.

* Update update_truth.md

Update wording in the update_truth issue template.

* Feature #2530 dev timeline (#2532)

* Per #2530, add a development timeline to the METplus Release Information section of the User's Guide. Also update the Release Guide instructions.

* Per #2530, tweak the wording.

* Update docs/Release_Guide/release_steps/update_release_notes_development.rst

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

---------

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

* Adds static station lookup file for use with Python embedding for FLUXNET observations.

* Major overhaul to forecast Python embedding script for the TCI use case.

* Major overhaul to observation Python embedding script for the TCI use case, to compute TCI from raw observations rather than read pre-computed TCI.

* Updates documentation file for TCI use case.

* Adds METcalcpy version number.

* Refactors wording and fixes typo.

* Fixes RST formatting.

* Finally fixed RST error.

* Adds support to remove leap days if requested.

* Updates command line args for Python embedding scripts.

* Feature #2537 develop sonarqube_gha (#2541)

* Per #2537, add SonarQube workflow for METplus

* Per #2537, update nightly build email list.

* Per #2537, fix cut/paste error configure_sonarqube.sh

* Per #2537, exclude test code from code coverage statistics.

* Updated conf file for use case.

* Removes new TCI function because it is in METcalcpy now.

* Removes old code, somsome reorganization and clarification and setting of params, and also switches the fluxnet metadata file to a command line argument instead of an environment variable.

* Update the 6.0.0 Coordinated Release development timeline in release-notes.rst

* Support for environment variables or default options for filtering and filename patterns, DEBUG mode added and set to False by default, adjustment of print statements for logging, and refactoring filtering of stations to ensure we don't process a file that we shouldn't by better coupling of filenames and stations.

* Makes DEBUG an env var for config via metplus wrappers.

* Reorganization of config file, adds environment variables, and updates comments for use case changes.

* Updates to documentation.

* Fixes tables.

* Adds table of contents to the top for users to click on.

* Updates use case documentation file.

* Updated config file with obs and fcst subirectories in the path.

* Added optional key/value to use_case_groups.json to prevent a use case group from running to easily disable it temporarily. Disable short_range:14 use case until it can be fixed with #2551

* update pillow version based on recommendation from dependabot: https://github.com/dtcenter/METplus/security/dependabot/5

* Switches to using metplotpy_env to get metcalcpy dependency.

* Adds filtering based on missing data values.

* Finishing touches to debug statements for testing.

* Fixing a few minor code smells from last week.

* update link to METplus Components Python Requirements table in PR template

* Update docs/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI.py

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

---------

Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>
Co-authored-by: metplus-bot <97135045+metplus-bot@users.noreply.github.com>
Co-authored-by: Christina Kalb <kalb@ucar.edu>
Co-authored-by: j-opatz <jopatz@ucar.edu>
Co-authored-by: jason-english <73247785+jason-english@users.noreply.github.com>
Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>
Co-authored-by: Tracy Hertneky <39317287+hertneky@users.noreply.github.com>
Co-authored-by: Jonathan Vigh <jvigh@ucar.edu>
Co-authored-by: John Sharples <41682323+John-Sharples@users.noreply.github.com>
Co-authored-by: root <root@localhost>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@ucar.edu>
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: reza-armuei <144857501+reza-armuei@users.noreply.github.com>
Co-authored-by: Tracy <tracy.hertneky@noaa.gov>
Co-authored-by: Mallory Row <mallory.row@noaa.gov>
Co-authored-by: bikegeek <3753118+bikegeek@users.noreply.github.com>
@DanielAdriaansen DanielAdriaansen deleted the feature_2388_Update_TCI branch April 17, 2024 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Enhancement: Enhance Terrestrial Coupling Index (TCI) Use Case
3 participants