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 external script into example_notebook #731

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

jtmims
Copy link
Collaborator

@jtmims jtmims commented Jan 8, 2025

Description
As notebooks become a feature that may be available to POD devs in the near future, I though it would be a good idea to update the example to showcase how external scripts would have to be called from the notebook in the MDTF-framework.

How Has This Been Tested?
Ran on GFDL workstation using synthetic data

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 added the tool Scripts or features that assist with data or code management that are not part of the framework src label Jan 8, 2025
@wrongkindofdoctor wrongkindofdoctor self-assigned this Jan 8, 2025
@wrongkindofdoctor wrongkindofdoctor merged commit 865c8dd into NOAA-GFDL:main Jan 8, 2025
5 checks passed
@jtmims jtmims deleted the external branch January 16, 2025 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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