Merge branch 'master' into uv_actions

Jhsmit · Nov 27, 2024 · 87bd05f · 87bd05f
2 parents ef88888 + 4eb8949
commit 87bd05f
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -9,13 +9,23 @@
 $ pip install hdxms-datasets
 ```
 
+### HDX-MS database
+
+Currently a beta test database is set up at:
+https://github.com/Jhsmit/HDX-MS-datasets
+
 ### Example code
 
 
 ```python
+from pathlib import Path
 from hdxms_datasets import DataVault
 
-vault = DataVault()
+# local path the download datasets to
+cache_dir = Path('.cache')
+
+# create a vault with local cache dir, set `remote_url` to connect to a different database
+vault = DataVault(cache_dir=cache_dir)
 
 # Download a specific HDX dataset
 vault.fetch_dataset("20221007_1530_SecA_Krishnamurthy")

diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,7 +19,6 @@ nav:
   - install.md
   - Usage:
     - usage/loading.md
-    - usage/configuration.md
   - API Reference: reference/
 
 watch: