diff --git a/README.md b/README.md index 7d18793..1105eca 100644 --- 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 deleted file mode 100644 index 75ab9f1..0000000 --- a/docs/usage/configuration.md +++ /dev/null @@ -1,30 +0,0 @@ -# Configuration - -Default values for HDXMS Datasets configuration are stored as a .yaml file in `~/.hdxms_datasets/config.yaml`. -The values there can be modified to update default settings. - -The default configuration is as follows: - -```yaml -database_dir: $home/.hdxms_datasets/datasets -database_url: https://raw.githubusercontent.com/Jhsmit/HDX-MS-datasets/master/datasets/ -time_unit: s - -dynamx: - time_unit: min - -``` - -Here `time_unit` defines the time unit in returned datasets. The `time_unit` in the `dynamx` section sets the time unit -of the source datasets in the DynamX format. - -Configuration settings can also be changed from within python: - -```python -from hdxms_datasets import cfg - -cfg.time_unit = 'min' - -``` - -This will change the time unit to minutes for all datasets loaded from then on. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 480a738..06f3399 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,7 +19,6 @@ nav: - install.md - Usage: - usage/loading.md - - usage/configuration.md - API Reference: reference/ watch: