summaryrefslogtreecommitdiff
path: root/src/python/doc
diff options
context:
space:
mode:
authorHind-M <hind.montassif@gmail.com>2022-05-25 16:53:04 +0200
committerHind-M <hind.montassif@gmail.com>2022-05-25 16:53:04 +0200
commit899fb73b33cb6976c39a42ba26a31cf2acde63ee (patch)
treecd91d41cefa1b4e5218bc9465178120313d02c9a /src/python/doc
parentce34ee3e5c28c48d605f23332cfa3c10e471a047 (diff)
Add info in the doc concerning default data_home and 'GUDHI_DATA' env variable
Diffstat (limited to 'src/python/doc')
-rw-r--r--src/python/doc/datasets.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/python/doc/datasets.rst b/src/python/doc/datasets.rst
index 8b0912c4..2d11a19d 100644
--- a/src/python/doc/datasets.rst
+++ b/src/python/doc/datasets.rst
@@ -112,6 +112,9 @@ Fetching datasets
We provide some ready-to-use datasets that are not available by default when getting GUDHI, and need to be fetched explicitly.
+By **default**, the fetched datasets directory is set to a folder named **'gudhi_data'** in the **user home folder**.
+Alternatively, it can be set using the **'GUDHI_DATA'** environment variable.
+
.. autofunction:: gudhi.datasets.remote.fetch_bunny
.. figure:: ./img/bunny.png