Improve Parameters syntax

Author: patnr

ensemble/ensemble.py

@@ -499,14 +499,14 @@ def calc_prediction(self, input_state=None, save_prediction=None):
 
         Parameters
         ----------
-        input_state:
+        input_state :
             Use an input state instead of internal state (stored in self) to run predictions
-        save_prediction:
+        save_prediction :
             Save the predictions as a <save_prediction>.npz file (numpy compressed file)
 
         Returns
         -------
-        prediction:
+        prediction :
             List of dictionaries with keys equal to data types (in DATATYPE),
             containing the responses at each time step given in PREDICTION.
 

input_output/read_config.py

@@ -130,7 +130,7 @@ def read_txt(init_file):
 
     Parameters
     ----------
-    init_file: str
+    init_file : str
         PIPT init. file containing info. to run the inversion algorithm
 
     Returns
@@ -197,12 +197,12 @@ def read_clean_file(init_file):
 
     Parameters
     ----------
-    init_file: str
+    init_file : str
         Name of file to remove all comments. WHOLE filename needed (with suffix!)
 
     Returns
     -------
-    lines: list
+    lines : list
         Lines from init. file converted to list entries
     """
     # Read file except lines starting with an octothorpe (#) and return the python variable
@@ -219,12 +219,12 @@ def remove_empty_lines(lines):
 
     Parameters
     ----------
-    lines: list
+    lines : list
         List of lines from a file
 
     Returns
     -------
-    lines_clean: list
+    lines_clean : list
         List of clean lines (without empty entries)
     """
     # Loop over lines to find '\n'
@@ -254,12 +254,12 @@ def parse_keywords(lines):
 
     Parameters
     ----------
-    lines: list
+    lines : list
         List of (clean) lines from the PIPT init. file.
 
     Returns
     -------
-    keys: dict
+    keys : dict
         Dictionary with all info. from the init. file.
     """
     # Init. the dictionary

pipt/loop/assimilation.py

@@ -44,7 +44,7 @@ def __init__(self, ensemble: Ensemble):
 
         Parameters
         ----------
-        init_file: str
+        init_file : str
             PIPT init. filename
         """
         # Internalize ensemble and simulator class instances
@@ -292,6 +292,7 @@ def _ext_max_iter(self):
         ----------
         keys_da : dict
             A dictionary containing all keywords from DATAASSIM part.
+
             - 'iteration' : object
                 Information for iterative methods.
 
@@ -368,7 +369,7 @@ def _save_during_iteration(self, tempsave):
 
         Parameters
         ----------
-        tempsave: list
+        tempsave : list
             Info. from the TEMPSAVE keyword
         """
         self.ensemble.logger.info(
@@ -444,7 +445,7 @@ def calc_forecast(self):
         Parameters
         ----------
         assim_step : int
-                     Current assimilation step.
+            Current assimilation step.
 
         Notes
         -----

pipt/loop/ensemble.py

@@ -672,12 +672,12 @@ def compress(self, data=None, vintage=0, aug_coeff=None):
 
         Parameters
         ----------
-        data:
+        data : 
             data to be compressed
             If data is `None`, all data (true and simulated) is re-compressed (used if leading indices are updated)
-        vintage: int
+        vintage : int
             the time index for the data
-        aug_coeff: bool
+        aug_coeff : bool
             - False: in this case the leading indices for wavelet coefficients are computed
             - True: in this case the leading indices are augmented using information from the ensemble
             - None: in this case simulated data is compressed