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

initial submodule (TempestExtremes) support #526

Merged
merged 5 commits into from
Apr 4, 2024

Conversation

jtmims
Copy link
Collaborator

@jtmims jtmims commented Apr 4, 2024

Description
Adds initial support for launching submodules (e.g. TempestExtremes) that have a python wrapper. It also adds an example json file on how to define what functions one would like to call from the submodule.

Associated issue #516

How Has This Been Tested?
This was built using the entire MDTF on my thin client and demoed to @wrongkindofdoctor, while the TempestExtremes wrapper was built and ran on both my thin client and PPAN.

Checklist:

  • [ x] My branch is up-to-date with the NOAA-GFDL main branch, and all merge conflicts are resolved
  • [ x] The scripts are written in Python 3.11 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

Copy link
Collaborator

@wrongkindofdoctor wrongkindofdoctor left a comment

Choose a reason for hiding this comment

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

Just a minor change request for module_config template. Would it be possible to add a module_config yaml template as well?

Comment on lines 94 to 100
"conda_root": "/home/jacob.mims/miniconda3",

// Directory containing the framework-specific conda environments. This should
// be equal to the "--env_dir" flag passed to conda_env_setup.sh. If left
// blank, the framework will look for its environments in conda_root/envs
//"conda_env_root": "/net/jml/miniconda3/envs",
"conda_env_root": "/home/jacob.mims/miniconda3/envs",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove home directories from template

@wrongkindofdoctor wrongkindofdoctor self-assigned this Apr 4, 2024
@wrongkindofdoctor wrongkindofdoctor added feature-request New feature or request framework Issue pertains to the framework code tool Scripts or features that assist with data or code management that are not part of the framework src labels Apr 4, 2024
@wrongkindofdoctor wrongkindofdoctor merged commit b57ebb9 into NOAA-GFDL:refactor_pp Apr 4, 2024
0 of 3 checks passed
@jtmims jtmims deleted the add_submodules branch May 21, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or request framework Issue pertains to the framework code 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