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

Archive the experiment directory along with git status/diff output #3105

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

DavidHuber-NOAA
Copy link
Contributor

@DavidHuber-NOAA DavidHuber-NOAA commented Nov 15, 2024

Description

This adds the capability to archive the experiment directory. Additionally, this adds options to run git status and git diff on the HOMEgfs global workflow (but not the submodules) and store that information within the experiment directory's archive. These options are specified in config.base with the following defaults:

export ARCH_EXPDIR='YES'     # Archive the EXPDIR configs, XML, and database
export ARCH_EXPDIR_FREQ=0    # How often to archive the EXPDIR in hours or 0 for first and last cycle only
export ARCH_HASHES='YES'     # Archive the hashes of the GW and submodules and 'git status' for each; requires ARCH_EXPDIR
export ARCH_DIFFS='NO'       # Archive the output of 'git diff' for the GW; requires ARCH_EXPDIR

Resolves #2994

Type of change

  • New feature (adds functionality)

Change characteristics

  • Is this a breaking change (a change in existing functionality)? NO
  • Does this change require a documentation update? YES
  • Does this change require an update to any of the following submodules? YES (If YES, please add a link to any PRs that are pending.)

How has this been tested?

  • Local archiving on Hercules for a C48_ATM case
  • Cycled testing on Hercules with ARCH_DIFFS=YES and ARCH_EXPDIR_FREQ=6,12
  • Testing with ARCH_EXPDIR=NO or ARCH_HASHES=NO

Checklist

  • Any dependent changes have been merged and published
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have documented my code, including function, input, and output descriptions
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • This change is covered by an existing CI test or a new one has been added
  • Any new scripts have been added to the .github/CODEOWNERS file with owners
  • I have made corresponding changes to the system documentation if necessary

@DavidHuber-NOAA
Copy link
Contributor Author

FYI @AndrewEichmann-NOAA

@DavidHuber-NOAA DavidHuber-NOAA marked this pull request as ready for review November 18, 2024 16:23
@DavidHuber-NOAA
Copy link
Contributor Author

Tests were performed on Hercules and the experiment directory tarballs for both cycled and forecast-only modes were found to have been created as expected. Opening for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ability to save experiment directory (EXPDIR)
1 participant