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

Switch LFS to DVC #25

Merged
merged 6 commits into from
Mar 7, 2022
Merged

Switch LFS to DVC #25

merged 6 commits into from
Mar 7, 2022

Conversation

ErinWeisbart
Copy link
Member

Update README.md and environment.yaml so that large file storage uses DVC not Git LFS.

README.md Show resolved Hide resolved
README.md Outdated
If using a data repository, push the newly created profiles to DVC and the .dvc files and other files to GitHub as follows

```bash
dvc add profiles/${BATCH}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can send files or folders to DVC but whatever unit you send is tracked as that full unit. So, if you add profiles/BATCH then you can only download that whole folder from DVC. So options for DVC usage are:

  • dvc add all the profiles in a batch as one unit. This is the simplest and least error prone, but it means that anyone using the profiles will have to download them all as one large unit.
  • dvc add in more granular units. Makes it a bit more complicated to give explicit instructions, but means that profilers can access just that granular unit.

@shntnu @bethac07 Do you have opinions on whether we should do bulk or granular? (And if granular, how granular?)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for thinking this through.

Do you oppose --recursive and just tracking them all?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shntnu I think --recursive is a great solution for both granular and easy :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Thanks @niranjchandrasekaran

Co-authored-by: Niranj Chandrasekaran <[email protected]>
@ErinWeisbart ErinWeisbart marked this pull request as ready for review February 2, 2022 22:16
@ErinWeisbart
Copy link
Member Author

I believe this is good to go @shntnu.
I could ask for the next person in the Cimini lab who uses the profiling recipe to follow these steps as a final test? (I haven't followed the instructions from start to finish on a new repo since making the few changes in this PR).

@shntnu shntnu self-requested a review February 3, 2022 23:10
Copy link
Member

@shntnu shntnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

README.md Outdated Show resolved Hide resolved
@shntnu
Copy link
Member

shntnu commented Mar 4, 2022

@ErinWeisbart would you like to go ahead and merge?

@ErinWeisbart
Copy link
Member Author

@shntnu I think it's fine to merge. As I mentioned, I haven't run through my instructions start to finish since all the final edits, but I suppose if someone finds something unclear/wrong with a run-through, they can always start a new issue/PR.
(I don't have write access so you'll have to be the one to pull the trigger).

@shntnu
Copy link
Member

shntnu commented Mar 7, 2022

Thanks, Erin!

I've made you a maintainer now FWIW

@shntnu shntnu merged commit d852df5 into cytomining:master Mar 7, 2022
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.

3 participants