Feature/order samples unsequa

CHANGELOG.md

@@ -30,6 +30,7 @@ Removed:
 - Added method `Exposures.centroids_total_value` to replace the functionality of `Exposures.affected_total_value`. This method is temporary and deprecated. [#702](https://github.com/CLIMADA-project/climada_python/pull/702)
 - New method `climada.util.api_client.Client.purge_cache`: utility function to remove outdated files from the local file system to free disk space.
   ([#737](https://github.com/CLIMADA-project/climada_python/pull/737))
+- Added advanced examples in unsequa tutorial for coupled input variables and for handling efficiently the loading of multiple large files [#766](https://github.com/CLIMADA-project/climada_python/pull/766)
 
 ### Changed
 

climada/engine/unsequa/calc_base.py

@@ -371,7 +371,10 @@ def _sample_parallel_iterator(self, samples, chunksize, **kwargs):
             suitable for methods _map_impact_calc and _map_costben_calc
 
         """
-        return zip(_chunker(samples, chunksize), *(itertools.repeat(item) for item in kwargs.values()))
+        return zip(
+            _chunker(samples, chunksize),
+            *(itertools.repeat(item) for item in kwargs.values())
+            )
 
 def _chunker(seq, size):
     for pos in range(0, len(seq), size):

climada/engine/unsequa/calc_cost_benefit.py

@@ -53,13 +53,13 @@ class CalcCostBenefit(Calc):
     ----------
     value_unit : str
         Unit of the exposures value
-    haz_input_var : climada.engine.uncertainty.input_var.InputVar
+    haz_input_var : InputVar or Hazard
         Present Hazard uncertainty variable
-    ent_input_var : climada.engine.uncertainty.input_var.InputVar
+    ent_input_var : InputVar or Entity
         Present Entity uncertainty variable
-    haz_unc_fut_Var: climada.engine.uncertainty.input_var.InputVar
+    haz_unc_fut_Var: InputVar or Hazard
         Future Hazard uncertainty variable
-    ent_fut_input_var : climada.engine.uncertainty.input_var.InputVar
+    ent_fut_input_var : InputVar or Entity
         Future Entity uncertainty variable
     _input_var_names : tuple(str)
         Names of the required uncertainty variables
@@ -179,15 +179,17 @@ def uncertainty(self,
         See Also
         --------
         climada.engine.cost_benefit:
-            Compute risk and adptation option cost benefits.
+            compute risk and adptation option cost benefits.
 
         """
 
         if unc_sample.samples_df.empty:
             raise ValueError("No sample was found. Please create one first" +
                         "using UncImpact.make_sample(N)")
 
-        chunksize = np.ceil(unc_sample.samples_df.shape[0] / processes).astype(int) if chunksize is None else chunksize
+        chunksize = np.ceil(
+            unc_sample.samples_df.shape[0] / processes
+            ).astype(int) if chunksize is None else chunksize
 
         samples_df = unc_sample.samples_df.copy(deep=True)
         unit = self.value_unit

climada/engine/unsequa/calc_impact.py

@@ -39,7 +39,6 @@
 
 LOGGER = logging.getLogger(__name__)
 
-
 class CalcImpact(Calc):
     """
     Impact uncertainty caclulation class.
@@ -57,11 +56,11 @@ class CalcImpact(Calc):
         Compute eai_exp or not
     value_unit : str
         Unit of the exposures value
-    exp_input_var : climada.engine.uncertainty.input_var.InputVar
+    exp_input_var : InputVar or Exposures
         Exposure uncertainty variable
-    impf_input_var : climada.engine.uncertainty.input_var.InputVar
+    impf_input_var : InputVar if ImpactFuncSet
         Impact function set uncertainty variable
-    haz_input_var: climada.engine.uncertainty.input_var.InputVar
+    haz_input_var: InputVar or Hazard
         Hazard uncertainty variable
     _input_var_names : tuple(str)
         Names of the required uncertainty input variables
@@ -180,15 +179,18 @@ def uncertainty(self,
 
         See Also
         --------
-        climada.engine.impact: Compute risk.
+        climada.engine.impact:
+            compute impact and risk.
 
         """
 
         if unc_sample.samples_df.empty:
             raise ValueError("No sample was found. Please create one first"
                              "using UncImpact.make_sample(N)")
 
-        chunksize = np.ceil(unc_sample.samples_df.shape[0] / processes).astype(int) if chunksize is None else chunksize
+        chunksize = np.ceil(
+            unc_sample.samples_df.shape[0] / processes
+            ).astype(int) if chunksize is None else chunksize
 
         samples_df = unc_sample.samples_df.copy(deep=True)
 

climada/engine/unsequa/unc_output.py

@@ -112,6 +112,24 @@ def __init__(self, samples_df, unit=None):
         self.samples_df = samples_df
         self.unit = unit
 
+    def order_samples(self, by_parameters):
+        """
+        Function to sort the samples dataframe.
+
+        Note: the unc_output.samples_df is ordered inplace.
+
+        Parameters
+        ----------
+        by_parameters : list[string]
+            List of the uncertainty parameters to sort by (ordering in list is kept)
+
+        Returns
+        -------
+        None.
+
+        """
+        self.samples_df.sort_values(by=by_parameters, inplace=True, axis=0)
+
     def get_samples_df(self):
         return getattr(self, 'samples_df')