Set repository basepath to '~/.cache/skyllh' by default

skyllh/core/config.py

@@ -5,6 +5,7 @@
 import copy
 import os.path
 import sys
+from pathlib import Path
 from typing import (
     Any,
 )
@@ -51,7 +52,7 @@
     },
     'repository': {
         # A base path of repository datasets.
-        'base_path': None,
+        'base_path': str(Path('~/.cache/skyllh').expanduser()),
         'download_from_origin': True,
     },
     'units': {

skyllh/core/dataset.py

@@ -802,8 +802,8 @@ def __init__(
         base_path : str | None
             The user-defined base path of the data set.
             Usually, this is the path of the location of the data directory.
-            If set to ``None`` the configured repository base path
-            ``Config['repository']['base_path']`` is used.
+            If set to ``None``, the dataset configuration's repository ``base_path``
+            setting is used, which defaults to ``~/.cache/skyllh``.
         sub_path_fmt : str | None
             The user-defined format of the sub path of the data set.
             If set to ``None``, the ``default_sub_path_fmt`` will be used.

skyllh/datasets/i3/PublicData_10y_ps.py

@@ -26,7 +26,8 @@ def create_dataset_collection(
     base_path : str | None
         The base path of the data files. The actual path of a data file is
         assumed to be of the structure <base_path>/<sub_path>/<file_name>.
-        If None, use the default path ``cfg['repository']['base_path']``.
+        If ``None``, ``cfg['repository']['base_path']`` is used, which
+        defaults to ``~/.cache/skyllh``.
     sub_path_fmt : str | None
         The sub path format of the data files of the public data sample.
         If None, use the default sub path format

skyllh/datasets/i3/PublicData_10y_ps_wMC.py

@@ -22,7 +22,8 @@ def create_dataset_collection(
     base_path : str | None
         The base path of the data files. The actual path of a data file is
         assumed to be of the structure <base_path>/<sub_path>/<file_name>.
-        If None, use the default path ``cfg['repository']['base_path']``.
+        If ``None``, ``cfg['repository']['base_path']`` is used, which
+        defaults to ``~/.cache/skyllh``.
     sub_path_fmt : str | None
         The sub path format of the data files of the public data sample.
         If None, use the default sub path format

skyllh/datasets/i3/PublicData_14y_ps.py

@@ -27,7 +27,8 @@ def create_dataset_collection(
     base_path : str | None
         The base path of the data files. The actual path of a data file is
         assumed to be of the structure <base_path>/<sub_path>/<file_name>.
-        If None, use the default path ``cfg['repository']['base_path']``.
+        If ``None``, ``cfg['repository']['base_path']`` is used, which
+        defaults to ``~/.cache/skyllh``.
     sub_path_fmt : str | None
         The sub path format of the data files of the public data sample.
         If None, use the default sub path format

skyllh/datasets/i3/TestData.py

@@ -20,7 +20,8 @@ def create_dataset_collection(
     base_path : str | None
         The base path of the data files. The actual path of a data file is
         assumed to be of the structure <base_path>/<sub_path>/<file_name>.
-        If None, use the default path ``cfg['repository']['base_path']``.
+        If ``None``, ``cfg['repository']['base_path']`` is used, which
+        defaults to ``~/.cache/skyllh``.
     sub_path_fmt : str | None
         The sub path format of the data files of the public data sample.
         If None, use the default sub path format