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

Update docs about --env_dir flag #715

Merged
merged 2 commits into from
Nov 22, 2024
Merged

Conversation

jtmims
Copy link
Collaborator

@jtmims jtmims commented Nov 20, 2024

Description
Removes documentation that states the --env_dir is an optional flag

Associated issue #712

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

@jtmims jtmims marked this pull request as ready for review November 21, 2024 19:41
@jtmims
Copy link
Collaborator Author

jtmims commented Nov 21, 2024

@wrongkindofdoctor I think I found all the instances where this was mentioned!

@wrongkindofdoctor wrongkindofdoctor merged commit e808181 into NOAA-GFDL:main Nov 22, 2024
5 checks passed
@wrongkindofdoctor wrongkindofdoctor self-assigned this Nov 22, 2024
@wrongkindofdoctor wrongkindofdoctor added the documentation Update, clarify, or add to the documentation label Nov 22, 2024
@wrongkindofdoctor wrongkindofdoctor linked an issue Nov 22, 2024 that may be closed by this pull request
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.

Update env_dir instructions in documentation
2 participants