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 git commit hash to metadata.yaml #852

Closed
BenWibking opened this issue Jan 15, 2025 · 0 comments · Fixed by #888
Closed

add git commit hash to metadata.yaml #852

BenWibking opened this issue Jan 15, 2025 · 0 comments · Fixed by #888
Labels
bug: usability enhancement New feature or request

Comments

@BenWibking
Copy link
Collaborator

Describe the proposal
We need a way to keep track of what version of Quokka produced a given simulation output. The easiest way to do this is to save the git commit that was used to compile the code in metadata.yaml in all of the output files (both snapshots and checkpoints).

Describe alternatives you've considered
Alternatively, we could save this in a jobinfo file like Castro and WarpX do: #358

Additional context
N/A

@BenWibking BenWibking added bug: usability enhancement New feature or request labels Jan 15, 2025
github-merge-queue bot pushed a commit that referenced this issue Feb 11, 2025
### Description
This adds the git commit hash to `metadata.yaml` for plotfiles and
checkpoints. This allows users to track the exact provenance of
simulation outputs.

### Related issues
Closes #852.

### Checklist
_Before this pull request can be reviewed, all of these tasks should be
completed. Denote completed tasks with an `x` inside the square brackets
`[ ]` in the Markdown source below:_
- [x] I have added a description (see above).
- [x] I have added a link to any related issues (if applicable; see
above).
- [x] I have read the [Contributing
Guide](https://github.com/quokka-astro/quokka/blob/development/CONTRIBUTING.md).
- [ ] I have added tests for any new physics that this PR adds to the
code.
- [ ] *(For quokka-astro org members)* I have manually triggered the GPU
tests with the magic comment `/azp run`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug: usability enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant