Skip to content

Commit c19d85c

Browse files
authored
Add tip about authenticating with DVC (#64)
1 parent f3d2cf3 commit c19d85c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,17 @@ ds = open_virtual_dataset(
7171
3. Run the test suite using `pixi run -e test run-tests` WARNING: Some tests will fail due to incomplete status of the implementation.
7272
4. Start a shell if needed in the development environment using `pixi run -e test zsh`.
7373

74+
!!! tip "DVC authentication"
75+
If you see errors like `Missing cache files` or `401 Unauthorized` when pulling test data, you may need to configure DVC credentials for the DagsHub remote. Create a `.dvc/config.local` file (which is gitignored) with your DagsHub credentials:
76+
77+
```bash
78+
dvc remote modify origin --local auth basic
79+
dvc remote modify origin --local user <your-dagshub-username>
80+
dvc remote modify origin --local password <your-dagshub-token>
81+
```
82+
83+
You can generate a token from your [DagsHub account settings](https://dagshub.com/user/settings/tokens).
84+
7485
## TIFF structure support
7586

7687
| TIFF Structure/Feature | Supported | Notes |

0 commit comments

Comments
 (0)