Skip to content

Commit cd03383

Browse files
Replace DVC database section with openlifu-sample-database instructions (#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.
1 parent 683855f commit cd03383

1 file changed

Lines changed: 12 additions & 27 deletions

File tree

README.rst

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -121,37 +121,22 @@ To ensure Meshroom uses your NVIDIA GPU:
121121
5. Under **Select the preferred graphics processor for this program**, choose **High-performance NVIDIA processor**.
122122
6. Click **Apply**.
123123

124-
Version control of database using DVC (Data Version Control)
125-
-------------------------------------------------------------
126-
127-
Data Version Control (DVC) is a data management tool that is meant to be run alongside Git.
128-
In this project, DVC is used to link changes in the code to specific versions of a sample database containing example project files.
129-
DVC can be used when this project is installed in Dev mode. You can read more about DVC and how to use it `here <https://dvc.org/doc/start>`_.
130-
**Note:** Remote access to the sample database stored on google drive is currently restricted. Access requires a :code:`gdrive_client_secret`
131-
for user access authentication to be shared by developers.
132-
133-
DVC usage
134-
~~~~~~~~~
135-
136-
To download the sample database:
137-
138-
.. code:: sh
139-
140-
git pull
141-
dvc remote modify --local shared_gdrive gdrive_client_secret <client_secret_here> # Contact developers for grive_client_secret
142-
dvc pull # Requires access to remote storage
124+
Getting Sample Data
125+
-------------------
143126

144-
This will download a directory 'db_dvc' in the repo directory that
145-
contains the corresponding version of example database files.
127+
A sample database for testing and examples is maintained in the
128+
`openlifu-sample-database <https://github.com/OpenwaterHealth/openlifu-sample-database>`_
129+
repository. Its files are tracked with Git LFS, so first `install Git LFS
130+
<https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage>`_.
146131

147-
To commit updates to the sample database:
132+
Then check out the tagged version of the sample database that is compatible
133+
with this version of ``openlifu``:
148134

149-
.. code:: sh
135+
.. code:: bash
150136
151-
dvc add db_dvc
152-
git commit -m "Describe updates to database"
153-
git push
154-
dvc push #Requires access to remote storage
137+
git clone --depth 1 --branch openlifu-v0.20.0 https://github.com/OpenwaterHealth/openlifu-sample-database.git
138+
cd openlifu-sample-database
139+
git lfs pull
155140
156141
Disclaimer
157142
----------

0 commit comments

Comments
 (0)