Add sample data instructions#451
Merged
ebrahimebrahim merged 2 commits intoOpenwaterHealth:mainfrom Apr 28, 2026
Merged
Conversation
…ns (OpenwaterHealth#338) The sample database is now in its own repository (openlifu-sample-database) with some files tracked with Git LFS. The DVC-based flow, which was intended for developers during the early days of the project, is not the way for general users to get sample data.
ebrahimebrahim
force-pushed
the
add-sample-data-instructions
branch
from
f964d9c to
bab0fd5
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Replacing DVC by the openlifu-sample-database as a source of sample data to direct new users to.
I will push tags to openlifu-sample-database that we can reference in the git clone command in the README here. Right now there is just one tag openlifu-v0.20.0 indicating which version of the sample data should be used with openlifu v0.20.0.
Once this is merged, I will updated our release notes for our latest releases to point to this new section in the readme, rather than pointing to dvc data.
For review: Just look at the updated readme and see that the formatting and instructions are sensible.