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 variable table tool and put output into docs #706

Merged
merged 3 commits into from
Nov 1, 2024

Conversation

jtmims
Copy link
Collaborator

@jtmims jtmims commented Nov 1, 2024

Description
This PR adds @Wen-hao-Dong's script to the tools dir of the MDTF repo. It also adds its output to the documentation.

Associated issue #704

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

tools/get_POD_varname/get_POD_varname.py Dismissed Show dismissed Hide dismissed
tools/get_POD_varname/get_POD_varname.py Dismissed Show dismissed Hide dismissed
@wrongkindofdoctor wrongkindofdoctor self-assigned this Nov 1, 2024
@wrongkindofdoctor wrongkindofdoctor added the documentation Update, clarify, or add to the documentation label Nov 1, 2024
@wrongkindofdoctor wrongkindofdoctor linked an issue Nov 1, 2024 that may be closed by this pull request
@wrongkindofdoctor wrongkindofdoctor merged commit fb9c0b2 into NOAA-GFDL:main Nov 1, 2024
5 checks passed
@jtmims jtmims deleted the var_table branch November 4, 2024 17:48
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add table of required POD variables to documentaiton
2 participants