Merge branch 'develop'

emanuel-schmid · emanuel-schmid · commit 8bb10110a93e · 2025-03-03T11:37:15.000+01:00
diff --git a/climada/engine/unsequa/calc_base.py b/climada/engine/unsequa/calc_base.py
@@ -207,7 +207,7 @@ def make_sample(self, N, sampling_method="saltelli", sampling_kwargs=None):
         sampling_method : str, optional
             The sampling method as defined in SALib. Possible choices:
             'saltelli', 'latin', 'morris', 'dgsm', 'fast_sampler', 'ff', 'finite_diff',
-             https://salib.readthedocs.io/en/latest/api.html
+            https://salib.readthedocs.io/en/latest/api.html
             The default is 'saltelli'.
         sampling_kwargs : kwargs, optional
             Optional keyword arguments passed on to the SALib sampling_method.
@@ -228,7 +228,6 @@ def make_sample(self, N, sampling_method="saltelli", sampling_kwargs=None):
         requirement. Please refer to https://salib.readthedocs.io/en/latest/api.html
         for more details.
 
-
         See Also
         --------
         SALib.sample: sampling methods from SALib SALib.sample
diff --git a/climada/engine/unsequa/calc_cost_benefit.py b/climada/engine/unsequa/calc_cost_benefit.py
@@ -77,8 +77,7 @@ class CalcCostBenefit(Calc):
     _metric_names : tuple(str)
         Names of the cost benefit output metrics
         ('tot_climate_risk', 'benefit', 'cost_ben_ratio',
-         'imp_meas_present', 'imp_meas_future')
-
+        'imp_meas_present', 'imp_meas_future')
     """
 
     _input_var_names = (
diff --git a/climada/engine/unsequa/calc_delta_climate.py b/climada/engine/unsequa/calc_delta_climate.py
@@ -81,7 +81,7 @@ class CalcDeltaImpact(Calc):
     _input_var_names : tuple(str)
         Names of the required uncertainty input variables
         ('exp_initial_input_var', 'impf_initial_input_var', 'haz_initial_input_var',
-         'exp_final_input_var', 'impf_final_input_var', 'haz_final_input_var'')
+        'exp_final_input_var', 'impf_final_input_var', 'haz_final_input_var'')
     _metric_names : tuple(str)
         Names of the impact output metrics
         ('aai_agg', 'freq_curve', 'at_event', 'eai_exp')
diff --git a/climada/entity/exposures/base.py b/climada/entity/exposures/base.py
@@ -549,10 +549,10 @@ def get_impf_column(self, haz_type=""):
         str
             a column name, the first of the following that is present in the exposures' dataframe:
 
-            - ``impf_[haz_type]``
-            - ``if_[haz_type]``
-            - ``impf_``
-            - ``if_``
+            * ``impf_[haz_type]``
+            * ``if_[haz_type]``
+            * ``impf_``
+            * ``if_``
 
         Raises
         ------
diff --git a/climada/hazard/base.py b/climada/hazard/base.py
@@ -225,15 +225,12 @@ def check_matrices(self):
         --------
         :py:func:`climada.util.checker.prune_csr_matrix`
 
-        Todo
-        -----
-        * Check consistency with centroids
-
         Raises
         ------
         ValueError
             If matrices are ill-formed or ill-shaped in relation to each other
         """
+        # TODO:  Check consistency with centroids
         u_check.prune_csr_matrix(self.intensity)
         u_check.prune_csr_matrix(self.fraction)
         if self.fraction.nnz > 0:
diff --git a/climada/hazard/io.py b/climada/hazard/io.py
@@ -398,6 +398,7 @@ def from_xarray_raster(
             * ``event_name``: String representation of the event date or empty strings
               if that fails (which will issue a warning).
             * ``event_id``: Consecutive integers starting at 1 and increasing with time
+
         crs : str, optional
             Identifier for the coordinate reference system of the coordinates. Defaults
             to ``EPSG:4326`` (WGS 84), defined by ``climada.util.constants.DEF_CRS``.
diff --git a/climada/hazard/storm_europe.py b/climada/hazard/storm_europe.py
@@ -836,10 +836,10 @@ def generate_prob_storms(
         levels are shifted by n raster pixels into each direction (N/S/E/W).
 
         Caveats:
-            - Memory safety is an issue; trial with the entire dataset resulted
+            * Memory safety is an issue; trial with the entire dataset resulted
               in 60GB of swap memory being used...
-            - Can only use numeric region_id for country selection
-            - Drops event names as provided by WISC
+            * Can only use numeric region_id for country selection
+            * Drops event names as provided by WISC
 
         Parameters
         ----------
diff --git a/climada/hazard/tc_clim_change.py b/climada/hazard/tc_clim_change.py
@@ -71,14 +71,15 @@ def get_knutson_scaling_factor(
     in Jewson et al., (2021).
 
     Related publications:
-    -   Knutson et al., (2020): Tropical cyclones and climate
-        change assessment. Part II: Projected response to anthropogenic warming.
-        Bull. Amer. Meteor. Soc., 101 (3), E303–E322,
-        https://doi.org/10.1175/BAMS-D-18-0194.1.
 
-    -   Jewson (2021): Conversion of the Knutson et al. (2020) Tropical Cyclone
-        Climate Change Projections to Risk Model Baselines,
-        https://doi.org/10.1175/JAMC-D-21-0102.1
+    - Knutson et al., (2020): Tropical cyclones and climate
+      change assessment. Part II: Projected response to anthropogenic warming.
+      Bull. Amer. Meteor. Soc., 101 (3), E303–E322,
+      https://doi.org/10.1175/BAMS-D-18-0194.1.
+
+    - Jewson (2021): Conversion of the Knutson et al. (2020) Tropical Cyclone
+      Climate Change Projections to Risk Model Baselines,
+      https://doi.org/10.1175/JAMC-D-21-0102.1
 
     Parameters
     ----------
@@ -94,21 +95,24 @@ def get_knutson_scaling_factor(
         the provided percentiles are the 10th, 25th, 50th, 75th and 90th. Please refer to the
         mentioned publications for more details.
         possible percentiles:
-            '5/10' either the 5th or 10th percentile depending on variable (see text above)
-            '25' for the 25th percentile
-            '50' for the 50th percentile
-            '75' for the 75th percentile
-            '90/95' either the 90th or 95th percentile depending on variable  (see text above)
+
+        * '5/10' either the 5th or 10th percentile depending on variable (see text above)
+        * '25' for the 25th percentile
+        * '50' for the 50th percentile
+        * '75' for the 75th percentile
+        * '90/95' either the 90th or 95th percentile depending on variable  (see text above)
+
         Default: '50'
     basin : str
         region of interest, possible choices are:
-            'NA', 'WP', 'EP', 'NI', 'SI', 'SP'
+        'NA', 'WP', 'EP', 'NI', 'SI', 'SP'
     baseline : tuple of int
         the starting and ending years that define the historical
         baseline. The historical baseline period must fall within
         the GSMT data period, i.e., 1880-2100. Default is 1982-2022.
     yearly_steps : int
         yearly resolution at which projections are provided. Default is 5 years.
+
     Returns
     -------
     future_change_variable : pd.DataFrame
@@ -207,10 +211,11 @@ def get_gmst_info():
     -------
     gmst_info : dict
         dictionary with four keys, which are:
-        - rcps: list of strings referring to RCPs 2.6, 4.5, 6.0 and 8.5
-        - gmst_start_year: integer with the GMST data starting year, 1880
-        - gmst_end_year: integer with the GMST data ending year, 2100
-        - gmst_data: array with GMST data across RCPs (first dim) and years (second dim)
+
+        * rcps: list of strings referring to RCPs 2.6, 4.5, 6.0 and 8.5
+        * gmst_start_year: integer with the GMST data starting year, 1880
+        * gmst_end_year: integer with the GMST data ending year, 2100
+        * gmst_data: array with GMST data across RCPs (first dim) and years (second dim)
     """
 
     gmst_data = np.array(
diff --git a/climada/hazard/tc_tracks.py b/climada/hazard/tc_tracks.py
@@ -199,27 +199,31 @@ class TCTracks:
     ----------
     data : list(xarray.Dataset)
         List of tropical cyclone tracks. Each track contains following attributes:
-            - time (coords)
-            - lat (coords)
-            - lon (coords)
-            - time_step (in hours)
-            - radius_max_wind (in nautical miles)
-            - radius_oci (in nautical miles)
-            - max_sustained_wind (in knots)
-            - central_pressure (in hPa/mbar)
-            - environmental_pressure (in hPa/mbar)
-            - basin (for each track position)
-            - max_sustained_wind_unit (attrs)
-            - central_pressure_unit (attrs)
-            - name (attrs)
-            - sid (attrs)
-            - orig_event_flag (attrs)
-            - data_provider (attrs)
-            - id_no (attrs)
-            - category (attrs)
+
+            * time (coords)
+            * lat (coords)
+            * lon (coords)
+            * time_step (in hours)
+            * radius_max_wind (in nautical miles)
+            * radius_oci (in nautical miles)
+            * max_sustained_wind (in knots)
+            * central_pressure (in hPa/mbar)
+            * environmental_pressure (in hPa/mbar)
+            * basin (for each track position)
+            * max_sustained_wind_unit (attrs)
+            * central_pressure_unit (attrs)
+            * name (attrs)
+            * sid (attrs)
+            * orig_event_flag (attrs)
+            * data_provider (attrs)
+            * id_no (attrs)
+            * category (attrs)
+
         Computed during processing:
-            - on_land (bool for each track position)
-            - dist_since_lf (in km)
+
+            * on_land (bool for each track position)
+            * dist_since_lf (in km)
+
         Additional data variables such as "nature" (specifiying, for each track position, whether a
         system is a disturbance, tropical storm, post-transition extratropical storm etc.) might be
         included, depending on the data source and on use cases.
@@ -1626,18 +1630,20 @@ def from_FAST(cls, folder_name: str):
         the xr.array structure to ensure compatibility with CLIMADA, and calculating the central
         pressure and radius of maximum wind.
 
-        Model GitHub Repository: https://github.com/linjonathan/tropical_cyclone_risk?
-                            tab=readme-ov-file
-        Model Publication: https://agupubs.onlinelibrary.wiley.com/doi/epdf/10.1029/2023MS003686
+        Model GitHub Repository:
+            https://github.com/linjonathan/tropical_cyclone_risk?tab=readme-ov-file
+
+        Model Publication:
+            https://agupubs.onlinelibrary.wiley.com/doi/epdf/10.1029/2023MS003686
 
-        Parameters:
+        Parameters
         ----------
         folder_name : str
             Folder name from where to read files.
         storm_id : int
             Number of the simulated storm
 
-        Returns:
+        Returns
         -------
         tracks : TCTracks
             TCTracks object with tracks data from the given directory of NetCDF files.
@@ -2947,13 +2953,15 @@ def set_category(max_sus_wind, wind_unit="kn", saffir_scale=None):
     -------
     category : int
         Intensity of given track according to the Saffir-Simpson hurricane scale:
-          * -1 : tropical depression
-          *  0 : tropical storm
-          *  1 : Hurricane category 1
-          *  2 : Hurricane category 2
-          *  3 : Hurricane category 3
-          *  4 : Hurricane category 4
-          *  5 : Hurricane category 5
+
+        * -1 : tropical depression
+        *  0 : tropical storm
+        *  1 : Hurricane category 1
+        *  2 : Hurricane category 2
+        *  3 : Hurricane category 3
+        *  4 : Hurricane category 4
+        *  5 : Hurricane category 5
+
     """
     if saffir_scale is None:
         saffir_scale = SAFFIR_SIM_CAT
diff --git a/climada/hazard/tc_tracks_synth.py b/climada/hazard/tc_tracks_synth.py
@@ -628,8 +628,8 @@ def _calc_land_decay(hist_tracks, land_geom, s_rel=True, check_plot=False, pool=
 
     Decay is calculated for every TC category according to the formulas:
 
-        - wind decay = exp(-x*A)
-        - pressure decay = S-(S-1)*exp(-x*B)
+        * wind decay = exp(-x*A)
+        * pressure decay = S-(S-1)*exp(-x*B)
 
     Parameters
     ----------
diff --git a/climada/hazard/trop_cyclone/trop_cyclone.py b/climada/hazard/trop_cyclone/trop_cyclone.py
@@ -72,6 +72,7 @@ class TropCyclone(Hazard):
         *  3 Hurrican category 3
         *  4 Hurrican category 4
         *  5 Hurrican category 5
+
     basin : list of str
         Basin where every event starts:
 
@@ -82,6 +83,7 @@ class TropCyclone(Hazard):
         * 'SI' South Indian
         * 'SP' Southern Pacific
         * 'SA' South Atlantic
+
     windfields : list of csr_matrix
         For each event, the full velocity vectors at each centroid and track position in a sparse
         matrix of shape (npositions, ncentroids * 2) that can be reshaped to a full ndarray of
@@ -107,22 +109,26 @@ def __init__(
         ----------
         category : np.ndarray of int, optional
             For every event, the TC category using the Saffir-Simpson scale:
-                -1 tropical depression
-                0 tropical storm
-                1 Hurrican category 1
-                2 Hurrican category 2
-                3 Hurrican category 3
-                4 Hurrican category 4
-                5 Hurrican category 5
+
+            * '-1 tropical depression
+            * '0 tropical storm
+            * '1 Hurrican category 1
+            * '2 Hurrican category 2
+            * '3 Hurrican category 3
+            * '4 Hurrican category 4
+            * '5 Hurrican category 5
+
         basin : list of str, optional
             Basin where every event starts:
-                'NA' North Atlantic
-                'EP' Eastern North Pacific
-                'WP' Western North Pacific
-                'NI' North Indian
-                'SI' South Indian
-                'SP' Southern Pacific
-                'SA' South Atlantic
+
+            * 'NA' North Atlantic
+            * 'EP' Eastern North Pacific
+            * 'WP' Western North Pacific
+            * 'NI' North Indian
+            * 'SI' South Indian
+            * 'SP' Southern Pacific
+            * 'SA' South Atlantic
+
         windfields : list of csr_matrix, optional
             For each event, the full velocity vectors at each centroid and track position in a
             sparse matrix of shape (npositions,  ncentroids * 2) that can be reshaped to a full
@@ -213,6 +219,7 @@ def from_tracks(
                     Cyclone Outflow. Part I: Implications for Storm Structure. Journal
                     of the Atmospheric Sciences 68(10): 2236–2249.
                     https://dx.doi.org/10.1175/JAS-D-10-05024.1
+
         model_kwargs : dict, optional
             If given, forward these kwargs to the selected wind model. None of the
             parameters is currently supported by the ER11 model. Default: None.
@@ -412,18 +419,22 @@ def apply_climate_scenario_knu(
             are the 10th, 25th, 50th, 75th and 90th. Please refer to the mentioned publications
             for more details.
             possible percentiles:
-                '5/10' either the 5th or 10th percentile depending on variable (see text above)
-                '25' for the 25th percentile
-                '50' for the 50th percentile
-                '75' for the 75th percentile
-                '90/95' either the 90th or 95th percentile depending on variable  (see text above)
+
+            * '5/10' either the 5th or 10th percentile depending on variable (see text above)
+            * '25' for the 25th percentile
+            * '50' for the 50th percentile
+            * '75' for the 75th percentile
+            * '90/95' either the 90th or 95th percentile depending on variable  (see text above)
+
             Default: '50'
         scenario : str
             possible scenarios:
-                '2.6' for RCP 2.6
-                '4.5' for RCP 4.5
-                '6.0' for RCP 6.0
-                '8.5' for RCP 8.5
+
+            * '2.6' for RCP 2.6
+            * '4.5' for RCP 4.5
+            * '6.0' for RCP 6.0
+            * '8.5' for RCP 8.5
+
         target_year : int
             future year to be simulated, between 2000 and 2100. Default: 2050.
         Returns
diff --git a/climada/util/api_client.py b/climada/util/api_client.py
@@ -1143,9 +1143,10 @@ def purge_cache(self, target_dir=SYSTEM_DIR, keep_testfiles=True):
         """Removes downloaded dataset files from the given directory if they have been downloaded
         with the API client, if they are beneath the given directory and if one of the following
         is the case:
-        - there status is neither 'active' nor 'test_dataset'
-        - their status is 'test_dataset' and keep_testfiles is set to False
-        - their status is 'active' and they are outdated, i.e., there is a dataset with the same
+
+        * there status is neither 'active' nor 'test_dataset'
+        * their status is 'test_dataset' and keep_testfiles is set to False
+        * their status is 'active' and they are outdated, i.e., there is a dataset with the same
           data_type and name but a newer version.
 
         Parameters
diff --git a/climada/util/coordinates.py b/climada/util/coordinates.py
@@ -3029,9 +3029,11 @@ def set_df_geometry_points(df_val, scheduler=None, crs=None):
         contains latitude and longitude columns
     scheduler : str, optional
         Scheduler type for dask map_partitions.
+
         .. deprecated:: 5.0
            This function does not use dask features anymore. The parameter has no effect
            and will be removed in a future version.
+
     crs : object (anything readable by pyproj4.CRS.from_user_input), optional
         Coordinate Reference System, if omitted or None: df_val.geometry.crs
     """
diff --git a/climada/util/files_handler.py b/climada/util/files_handler.py
diff --git a/climada/util/finance.py b/climada/util/finance.py
diff --git a/climada/util/interpolation.py b/climada/util/interpolation.py
