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

add new --freq flag in mdtf-test-data to docs and tests #734

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

jtmims
Copy link
Collaborator

@jtmims jtmims commented Jan 23, 2025

Description
In the latest mdtf-test-data (1.0.9), the user is given a flag to set the frequency of the generated data. It also allows for the user to easily throw custom yml's into a direct install for more freq options for each data type. This PR adds the flag into the CI tests and documentation.

Associated issue # (replace this phrase and parentheses with the issue number)

How Has This Been Tested?
Please describe the tests that you ran to verify your changes in enough detail that
someone can reproduce them. Include any relevant details for your test configuration
such as the Python version, package versions, expected POD wallclock time, and the
operating system(s) you ran your tests on.

Checklist:

  • My branch is up-to-date with the NOAA-GFDL main branch, and all merge conflicts are resolved
  • The scripts are written in Python 3.12 or above (preferred; required if funded by a CPO grant), NCL, or R
  • All of my scripts are in the diagnostics/[POD short name] subdirectory, and include a main_driver script, template html, and settings.jsonc file
  • I have made corresponding changes to the documentation in the POD's doc/ subdirectory
  • I have requested that the framework developers add packages required by my POD to the python3, NCL, or R environment yaml file if necessary, and my environment builds with conda_env_setup.sh
  • I have added any necessary data to input_data/obs_data/[pod short name] and/or input_data/model/[pod short name]
  • My code is portable; it uses MDTF environment variables, and does not contain hard-coded file or directory paths
  • I have provided the code to generate digested data files from raw data files
  • Each digested data file generated by the script contains numerical data (no figures), and is 3 GB or less in size
  • I have included copies of the figures generated by the POD in the pull request
  • The repository contains no extra test scripts or data files

@wrongkindofdoctor wrongkindofdoctor self-assigned this Jan 23, 2025
@wrongkindofdoctor wrongkindofdoctor added testing-CI Issues related to testing. (Bugs found via testing should get the "bug" tag instead.) documentation Update, clarify, or add to the documentation tool Scripts or features that assist with data or code management that are not part of the framework src labels Jan 23, 2025
@wrongkindofdoctor wrongkindofdoctor merged commit 26a4c69 into NOAA-GFDL:main Jan 23, 2025
5 checks passed
@jtmims jtmims deleted the testdocs branch January 23, 2025 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Update, clarify, or add to the documentation testing-CI Issues related to testing. (Bugs found via testing should get the "bug" tag instead.) tool Scripts or features that assist with data or code management that are not part of the framework src
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants