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

Incorporate listed diagnostic to MDTF and submit pull request #81

Open
11 tasks
csyhuang opened this issue Jul 1, 2023 · 0 comments
Open
11 tasks

Incorporate listed diagnostic to MDTF and submit pull request #81

csyhuang opened this issue Jul 1, 2023 · 0 comments
Labels
contributions welcome MDTF Preparation work to deploy the package onto anaconda and integrate it into MDTF

Comments

@csyhuang
Copy link
Owner

csyhuang commented Jul 1, 2023

Submit the first pull request to MDTF repository:

  • Use the short name finite_amplitude_wave_diag as branch name and diagnostic abbreviation. Full name would be Finite-amplitude Rossby wave diagnostics
  • Incorporate diagnostics listed in Diagnostics (+ interpretations) to incorporate into MDTF #79
  • Specify a reasonable time window in .jsonc and fieldlist such that local test can finish in reasonable amount of time
  • Make sure the code runs both on Mac and Linux (currently, conda install is only available on Linux. Research into Scikit-build solution for F2PY #80 and potentially some new tickets are to solve the anaconda package deployment issues on Mac.

This ticket can be split to smaller ones depending on the capacity of the contributor.

The checklist for submitting pull request to MDTF repo:

  • I have reviewed my own code to ensure that if follows the POD development guidelines
  • My branch is up-to-date with the NOAA-GFDL develop branch, and all merge conflicts are resolved
  • The script are written in Python 3.6 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
  • If applicable, I've added a .yml file to src/conda, 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
  • The repository contains no extra test scripts or data files
@csyhuang csyhuang added the MDTF Preparation work to deploy the package onto anaconda and integrate it into MDTF label Jul 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributions welcome MDTF Preparation work to deploy the package onto anaconda and integrate it into MDTF
Projects
Status: No status
Development

No branches or pull requests

1 participant