Merge branch 'default-config' into develop

sphere/IFS.py

@@ -393,7 +393,7 @@ class Reduction(object):
     # Constructor
     ##################################################
 
-    def __new__(cls, path, log_level='info', sphere_handler=None):
+    def __new__(cls, path, log_level='info', user_config=None, sphere_handler=None):
         '''
         Custom instantiation for the class
 
@@ -407,9 +407,13 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
         path : str
             Path to the directory containing the dataset
 
-        level : {'debug', 'info', 'warning', 'error', 'critical'}
+        log_level : {'debug', 'info', 'warning', 'error', 'critical'}
             The log level of the handler
 
+        user_config : str
+            Path to a user-provided configuration. Default is None, i.e. the
+            reduction will use the package default configuration parameters
+        
         sphere_handler : log handler
             Higher-level SPHERE.Dataset log handler
         '''
@@ -496,7 +500,6 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
         reduction._default_center = np.array(eval(cfgparser.get('calibration', 'default_center')))
         reduction._orientation_offset = eval(cfgparser.get('calibration', 'orientation_offset'))            
 
-        # reduction parameters
         # reduction parameters
         cfg = {}
         items = dict(cfgparser.items('reduction'))
@@ -508,6 +511,12 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
             cfg[key] = val
         reduction._config = utils.Configuration(reduction._path, reduction._logger, cfg)
 
+        # load user-provided default configuration parameters
+        if user_config:
+            user_config = Path(user_config)
+
+            reduction._config.load_from_file(user_config)
+
         #
         # reduction adn recipes status
         #

sphere/IRDIS/ImagingReduction.py

@@ -52,7 +52,7 @@ class ImagingReduction(object):
     # Constructor
     ##################################################
 
-    def __new__(cls, path, log_level='info', sphere_handler=None):
+    def __new__(cls, path, log_level='info', user_config=None, sphere_handler=None):
         '''Custom instantiation for the class and initialization for the
            instances
 
@@ -66,9 +66,13 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
         path : str
             Path to the directory containing the dataset
 
-        level : {'debug', 'info', 'warning', 'error', 'critical'}
+        log_level : {'debug', 'info', 'warning', 'error', 'critical'}
             The log level of the handler
 
+        user_config : str
+            Path to a user-provided configuration. Default is None, i.e. the
+            reduction will use the package default configuration parameters
+        
         sphere_handler : log handler
             Higher-level SPHERE.Dataset log handler
 
@@ -170,6 +174,12 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
                 cfg[key] = val
         reduction._config = utils.Configuration(reduction._path, reduction._logger, cfg)
 
+        # load user-provided default configuration parameters
+        if user_config:
+            user_config = Path(user_config)
+
+            reduction._config.load_from_file(user_config)
+
         #
         # reduction and recipes status
         #

sphere/IRDIS/SpectroReduction.py

@@ -103,7 +103,7 @@ class SpectroReduction(object):
     # Constructor
     ##################################################
 
-    def __new__(cls, path, log_level='info', sphere_handler=None):
+    def __new__(cls, path, log_level='info', user_config=None, sphere_handler=None):
         '''Custom instantiation for the class and initialization for the
            instances
 
@@ -117,9 +117,13 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
         path : str
             Path to the directory containing the dataset
 
-        level : {'debug', 'info', 'warning', 'error', 'critical'}
+        log_level : {'debug', 'info', 'warning', 'error', 'critical'}
             The log level of the handler
 
+        user_config : str
+            Path to a user-provided configuration. Default is None, i.e. the
+            reduction will use the package default configuration parameters
+        
         sphere_handler : log handler
             Higher-level SPHERE.Dataset log handler
 
@@ -211,7 +215,12 @@ def __new__(cls, path, log_level='info', sphere_handler=None):
                 cfg[key] = val
         reduction._config = utils.Configuration(reduction._path, reduction._logger, cfg)
 
-
+        # load user-provided default configuration parameters
+        if user_config:
+            user_config = Path(user_config)
+
+            reduction._config.load_from_file(user_config)
+
         #
         # reduction and recipes status
         #

sphere/utils/config.py

@@ -93,3 +93,28 @@ def load(self):
                 self._logger.error('An error occured while loading previous configuration file')
         else:
             self.save()
+
+    def load_from_file(self, filepath):
+        '''
+        Load configuration from provided file
+
+        Parameters
+        ----------
+        filepath : str
+            Path of the configuration file
+        '''
+
+        if filepath.exists():
+            try:
+                self._logger.info(f'Load configuration file at path {filepath}')
+
+                cfg = None
+                with open(filepath, 'r') as file:
+                    cfg = json.load(file)
+
+                for key in cfg.keys():
+                    self.data[key] = cfg[key]
+
+                # self.save()
+            except:
+                self._logger.error('An error occured while loading configuration file')