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

Remove GitLFS and add InstallSupplement #5

Merged
merged 6 commits into from
Jan 28, 2020
Merged

Conversation

crvernon
Copy link
Contributor

@crvernon crvernon commented Jan 28, 2020

The GitLFS dependency for this repository has proven to be problematic for many users. However, CERF still has the need to include larger files as an example directory. To solve this issue I completed the following:

  • Zipped the existing example directory and minted a DOI for it using Zenodo that establishes a supplemental data package for the releases,
  • Built an InstallSupplement class that fetches and unzips the Zenodo example data package into a directory of the users choosing,
  • Removed and replaced any GitLFS archived files that existed within the project.

This can be used in the following way:

from cerf import InstallSupplement

InstallSupplement('<user specified path>')

@crvernon crvernon merged commit 9e1e44b into version-two Jan 28, 2020
@crvernon crvernon deleted the remove-lfs branch January 28, 2020 17:34
@crvernon crvernon mentioned this pull request Jan 28, 2020
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.

1 participant