Configuration management: Allow for creating / saving / loading configuration on the fly.

atlite/config.default.yaml

@@ -0,0 +1,19 @@
+# -------------------*DEFAULT SETTINGS*------------------- #
+# --------------------*DO NOT CHANGE*--------------------- #
+# For custom settings, see the 'config.example.yaml' file. #
+# --------------------*DO NOT CHANGE*--------------------- #
+
+# Folder for storing prepared cutout files
+cutout_dir: <ATLITE>/cutouts
+
+# Folder containing raw dataset data
+gebco_path: <ATLITE>/data/gebco
+ncep_dir:   <ATLITE>/data/ncep
+cordex_dir: <ATLITE>/data/cordex
+sarah_dir:  <ATLITE>/data/sarah
+
+# Folder for different wind turbine configuration files
+windturbine_dir: <ATLITE>/resources/windturbine
+
+# Folder for different solar panel configuration files
+solarpanel_dir: <ATLITE>/resources/solarpanel

atlite/config.example.yaml

@@ -0,0 +1,35 @@
+# Exemplary Settings for atlite
+
+
+## How to use this file.
+# 1. Copy this file into your home directory, usually that is
+#    "~" for linux users and "C:\Users\<Your Username>" for windows users.
+# 2. Rename the file to ".atlite.config.yaml" (note the trailing dot).
+# 3. Uncomment any setting you want to differ from the default settings.
+
+## Remarks
+# * Relative paths:
+#   Are relative to the location of the currently loaded config file,
+#   e.g. if the config file is located in your home directory,
+#   then any relative paths are considered relative to the homedirectory.
+#   Exception: Relative paths starting with "ATLITE/" (case-sensitive) are
+#   considered relative to the atlite-package directory.
+# * Custom location:
+#   You can use this configuration file and place it at custom locations with
+#   a custom file name. In this case you need to manually load the configuration
+#   after importing atlite with "atlite.config.read(<path with filename>)".
+
+# Folder for storing prepared cutout files
+# cutout_dir: <ATLITE>/cutouts
+
+# Folder containing raw dataset data
+# gebco_path: <ATLITE>/data/gebco
+# ncep_dir:   <ATLITE>/data/ncep
+# cordex_dir: <ATLITE>/data/cordex
+# sarah_dir:  <ATLITE>/data/sarah
+
+# Folder for different wind turbine configuration files
+# windturbine_dir: <ATLITE>/resources/windturbine
+
+# Folder for different solar panel configuration files
+# solarpanel_dir: <ATLITE>/resources/solarpanel

atlite/config.py

@@ -21,18 +21,10 @@
 logger = logging.getLogger(__name__)
 
 
-_FILE_NAME = "config.yaml"
-_DEFAULT_FILE_NAME = "default.config.yaml"
-
-# Search paths for the yaml-configuration file
-_SEARCH_PATHS = (
-    # User home directory - Custom
-    os.path.join(os.path.expanduser("~"), ".atlite", _FILE_NAME),
-    # Package install directory - Custom
-    pkg_resources.resource_filename(__name__, _FILE_NAME),
-    # Package install directory - Default
-    pkg_resources.resource_filename(__name__, _DEFAULT_FILE_NAME)
-)
+_FILE_NAME = ".atlite.config.yaml"
+_FILE_SEARCH_PATH = os.path.join(os.path.expanduser("~"), _FILE_NAME)
+_DEFAULT_FILE_NAME = "config.default.yaml"
+_DEFAULT_SEARCH_PATH = pkg_resources.resource_filename(__name__, _DEFAULT_FILE_NAME)
 
 # List of all supported attributes for the config
 ATTRS = []
@@ -47,7 +39,7 @@
 
 # Path of the configuration file.
 # Automatically updated when using provided API.
-config_path = None
+config_path = ""
 
 def read(path):
     """Read and set the configuration based on the file in 'path'."""
@@ -97,7 +89,21 @@ def update(config_dict):
 
     globals().update(config_dict)
     _update_variables()
-
+
+def reset():
+    """Reset the configuration to its initial values."""
+
+    # Test for file existence in order to not try to read
+    # non-existing configuration files at this point (do not confuse the user)
+    for path in [_DEFAULT_SEARCH_PATH, _FILE_SEARCH_PATH]:
+        if os.path.isfile(path):
+            read(path)
+
+    # Notify user of empty config
+    if not config_path:
+        logger.warn("No valid configuration file found in default and home directories. "
+                    "No configuration is loaded, manual configuration required.")
+
 def _update_variables():
     """Update list of provided attributes by the module."""
 
@@ -110,15 +116,5 @@ def _update_variables():
                      "logger", "os", "pkg_resources", "yaml"}
 
 
-# Try to load configuration from standard paths
-for path in _SEARCH_PATHS:
-    if os.path.isfile(path):
-        # Don't check if the file is actually what it claims to be
-        # also: consider a read without error a success.
-        read(path)
-        break
-
-# Notify user of empty config
-if not config_path:
-    logger.warn("No valid configuration file found in default paths. "
-                "No configuration is loaded, manual configuration required.")
+# Load the configuration at first module import
+reset()

atlite/utils.py

@@ -29,6 +29,7 @@
 import xarray as xr
 import sys
 import os
+import pkg_resources
 
 from . import config
 
@@ -79,6 +80,8 @@ def construct_filepath(path):
 
     if os.path.isabs(path):
         return path
+    elif path.startswith('<ATLITE>'):
+        return pkg_resources.resource_filename(__name__, path[8:])
     elif config.config_path is None:
         # If config_path is not defined assume the user know what per does
         return path