Re-organize README and update citation metadata #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mridulk97
approved these changes
Dec 18, 2025
Collaborator
mridulk97
left a comment
mridulk97
left a comment
There was a problem hiding this comment.
Readme re-structuring looks good to me.
I have updated the release dates on .zenodo.json and CITATION.cff to 2025-12-18
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I restructured the README in this commit to reduce redundancy (I scoped it so it can easily be reverted if you want). I also updated the resizing script so that it's easier for a downstream user to set their own base directories.
For the metadata, I updated the citation for a release tomorrow (can still be changed if needed). I also added the Zenodo metadata tracking file and the workflow that tests its format.