From e1b77899d3a5836cdf3ac11ffb8482c7d9ff583c Mon Sep 17 00:00:00 2001 From: Jochem Smit Date: Thu, 25 Apr 2024 13:13:34 +0200 Subject: [PATCH] Delete docs/usage/configuration.md --- docs/usage/configuration.md | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 docs/usage/configuration.md 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