Changes to ensemble-matrix

ensemble/logger.py

@@ -0,0 +1,99 @@
+import logging
+
+class PetLogger:
+    '''
+    A custom logger that logs messages and key-value pairs in a formatted table.
+
+    Parameters:
+        filename (str): The name of the log file. Defaults to 'PET.log'.
+    '''
+    def __init__(self, filename=None):
+
+        self.filename = filename if filename else 'PET.log'
+        self.ns = 12  # Number of spaces for table formatting
+
+        # Configurate logging
+        logging.basicConfig(
+            level=logging.INFO,
+            format='%(asctime)s : %(message)s',
+            datefmt='%Y-%m-%d│%H:%M:%S',
+            handlers=[
+                logging.FileHandler(self.filename, mode='w'),
+                logging.StreamHandler()
+            ]
+        )
+        self._logger = logging.getLogger(__name__)
+
+
+    def __call__(self, *args, **kwargs):
+        '''
+        Log messages or key-value pairs in a formatted table.
+
+        Parameters:
+            *args: Positional arguments to log as a single message.
+            **kwargs: Keyword arguments to log in a formatted table.
+
+        Example:
+            >>> logger = PetLogger()
+            >>> logger('This is a log message.')
+            2024-06-01│12:00:00 :  This is a log message.
+            >>> 
+            >>> logger(iteration=1, fun=0.5, step_size=0.1)
+            2024-06-01│12:00:00 :
+            2024-06-01│12:00:00 : ┌────────────┬────────────┬────────────┐
+            2024-06-01│12:00:00 : │ iteration  │    fun     │ step_size  │
+            2024-06-01│12:00:00 : ├────────────┼────────────┼────────────┤
+            2024-06-01│12:00:00 : │     1      │  5.000e-01 │  1.000e-01 │
+            2024-06-01│12:00:00 : └────────────┴────────────┴────────────┘
+            2024-06-01│12:00:00 :
+        '''
+
+        if args:
+            # Log message from args
+            msg = ' ' + ' '.join(str(arg) for arg in args)
+            self._logger.info(msg)
+
+        if kwargs:    
+            # Make strings for table logging
+            self._set_ns(**kwargs)
+            header = []
+            values = []
+            for key, value in kwargs.items():
+                header.append(f'{key:^{self.ns}}')
+                try:
+                    if isinstance(value, int) or isinstance(value, str):
+                        values.append(f'{value:^{self.ns}}')
+                    elif '%' in key:
+                        values.append(f'{value:^{self.ns}.1f}')
+                    else:
+                        values.append(f'{value:^{self.ns}.3e}')
+                except: 
+                    values.append(f'{"":^{self.ns}}')
+
+            # Log table
+            seperator = ['─' * self.ns for _ in kwargs.keys()]
+            self._logger.info('')
+            self._logger.info(' ┌' + '┬'.join(seperator) + '┐')
+            self._logger.info(' │' + '│'.join(header)    + '│')
+            self._logger.info(' ├' + '┼'.join(seperator) + '┤')
+            self._logger.info(' │' + '│'.join(values)    + '│')
+            self._logger.info(' └' + '┴'.join(seperator) + '┘')
+            self._logger.info('')
+
+    def info(self, *args, **kwargs):
+        self._logger.info(*args, **kwargs)
+
+    def _set_ns(self, **kwargs):
+        '''
+        Adjust the number of spaces for table formatting based on the length of keys and values.
+
+        Parameters:
+            **kwargs: Keyword arguments to consider for adjusting the space width.
+        '''
+        for key, value in kwargs.items():
+            try:
+                if (len(key) > self.ns) or (len(f'{value:.3e}') > self.ns):
+                    self.ns = max(len(key), len(f'{value:.3e}')) + 2
+            except:
+                if len(key) > self.ns:
+                    self.ns = len(key) + 2

input_output/read_config.py

@@ -9,6 +9,18 @@
 import numpy as np
 
 
+def read(filename: str):
+    ''' Read configuration file. Supported formats are toml, .yaml, .pipt and .popt.'''
+    if filename.endswith('.pipt') or filename.endswith('.popt'):
+        return read_txt(filename)
+    elif filename.endswith('.yaml'):
+        return read_yaml(filename)
+    elif filename.endswith('.toml'):
+        return read_toml(filename)
+    else:
+        raise ValueError('File format not supported. Supported formats are toml, .yaml, .pipt, .popt')
+
+
 def convert_txt_to_yaml(init_file):
     # Read .pipt or .popt file
     pr, fwd = read_txt(init_file)
@@ -46,30 +58,31 @@ def ndarray_constructor(loader, node):
     # Add constructor to yaml with tag !ndarray
     yaml.add_constructor('!ndarray', ndarray_constructor)
 
-    # Read
+    # Read yaml file
     with open(init_file, 'rb') as fid:
         y = yaml.load(fid, Loader=FullLoader)
 
-    # Check for dataassim and fwdsim
+    # Check for ensemble
     if 'ensemble' in y.keys():
         keys_en = y['ensemble']
         check_mand_keywords_en(keys_en)
     else:
         keys_en = {}
 
-    if 'optim' in y.keys():
-        keys_pr = y['optim']
-        check_mand_keywords_opt(keys_pr)
-    elif 'dataassim' in y.keys():
+    # Check for dataassim
+    if 'dataassim' in y.keys():
         keys_pr = y['dataassim']
         check_mand_keywords_da(keys_pr)
+    elif 'optim' in y.keys():
+        keys_pr = y['optim']
+        check_mand_keywords_opt(keys_pr)
     else:
-        raise KeyError
+        keys_pr = {}
 
     if 'fwdsim' in y.keys():
         keys_fwd = y['fwdsim']
     else:
-        raise KeyError
+        keys_fwd = {}
 
     # Organize keywords
     org = Organize_input(keys_pr, keys_fwd, keys_en)
@@ -379,7 +392,7 @@ def check_mand_keywords_en(keys_en):
 
     # Mandatory keywords in ENSEMBLE
     assert 'ne' in keys_en, 'NE not in ENSEMBLE!'
-    assert 'state' in keys_en, 'STATE not in ENSEMBLE!'
+    assert ('state' in keys_en) or ('controls' in keys_en), 'STATE or CONTROLS not in ENSEMBLE!'
     if 'importstaticvar' not in keys_en:
         assert filter(list(keys_en.keys()),
                       'prior_*') != [], 'No PRIOR_<STATICVAR> in DATAASSIM'

misc/ecl.py

@@ -426,8 +426,8 @@ def __init__(self, root):
             self.ni = grid_head[1]  # pylint: disable=invalid-name
             self.nj = grid_head[2]  # pylint: disable=invalid-name
             self.nk = grid_head[3]  # pylint: disable=invalid-name
-            log.info("Grid dimension is %d x %d x %d",
-                     self.ni, self.nj, self.nk)
+            #log.info("Grid dimension is %d x %d x %d",
+            #         self.ni, self.nj, self.nk)
 
             # also store a shape tuple which describes the grid cube
             self.shape = (self.nk, self.nj, self.ni)
@@ -460,7 +460,7 @@ def __init__(self, root):
             # restart properties are only saved for the active elements,
             # so we can cache this number to compare
             self.num_active = numpy.sum(self.actnum)
-            log.info("Grid has %d active cells", self.num_active)
+            #log.info("Grid has %d active cells", self.num_active)
 
     def grid(self):
         """