Skip to content

Commit 151513a

Browse files
Add docs on PYTHIA_DATASET_DIR (#19)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 8d83a4d commit 151513a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,18 @@ To add a new dataset file, please follow these steps:
6565
In [6]: df = pd.read_csv(filepath)
6666
```
6767

68+
## Changing the default data cache location
69+
70+
The default cache location (where the data are saved on your local system) is dependent on the operating system. You can use the `locate()` method to identify it:
71+
72+
```python
73+
from pythia_datasets import locate
74+
locate()
75+
```
76+
77+
The location can be overwritten by the `PYTHIA_DATASETS_DIR` environment
78+
variable to the desired destination.
79+
6880
[github-ci-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/CI?label=CI&logo=github&style=for-the-badge
6981
[github-lint-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/linting?label=linting&logo=github&style=for-the-badge
7082
[github-ci-link]: https://github.com/ProjectPythia/pythia-datasets/actions?query=workflow%3ACI

0 commit comments

Comments
 (0)