updated docstrings and variable frequency unit

climada/hazard/base.py

@@ -458,19 +458,29 @@ def local_return_period(self, threshold_intensities):
         Parameters
         ----------
         threshold_intensities : np.array
-            Hazard intensities to consider.
+            User-specified hazard intensities for which the return period should be calculated 
+            locally (at each centroid)
     
         Returns
         -------
         gdf : gpd.GeoDataFrame
-            GeoDataFrame containing return periods for given threshold intensity
-            description of units of values and threshold intensities in gdf.columns.name
+            GeoDataFrame containing return periods for given threshold intensities. Each column 
+            corresponds to a threshold_intensity value, each row corresponds to a centroid. Values
+            in the gdf correspond to the return period for the given centroid and threshold_intensity value
+        gdf_meta : climada.util.plot.GdfMeta
+            named tuple providing meta data of which quantities (and their units) are written the gdf
         """
         #check frequency unit
-        if self.frequency_unit not in ['1/year', 'annual', '1/y', '1/a']:
-            LOGGER.warning("The Hazard's frequency unit is %s and not %s which "
-                "most likely leads to incorrect results",
-                self.frequency_unit, u_const.DEF_FREQ_UNIT)
+        if self.frequency_unit in ['1/year', 'annual', '1/y', '1/a']:
+            rp_unit = 'Years'
+        elif self.frequency_unit in ['1/month', 'monthly', '1/m']:
+            rp_unit = 'Months'
+        elif self.frequency_unit in ['1/week', 'weekly', '1/w']:
+            rp_unit = 'Weeks'
+        else:
+            LOGGER.warning(f"Hazard's frequency unit {self.frequency_unit} is not known, "
+                           "years will be used as return period unit.")
+            rp_unit = 'Years'
 
         # Ensure threshold_intensities is a numpy array
         threshold_intensities = np.array(threshold_intensities)
@@ -499,7 +509,7 @@ def local_return_period(self, threshold_intensities):
         #create gdf meta data
         gdf_meta = GdfMeta(
             name = 'Return Period',
-            unit = 'Years',
+            unit = rp_unit,
             col_name = 'Threshold Intensity',
             col_unit = self.units
         )
@@ -676,9 +686,10 @@ def _loc_return_period(self, threshold_intensities, inten):
         Parameters
         ----------
         threshold_intensities: np.array
-            Given hazard intensities for which to calculate return periods.
+            Test hazard intensities for which to calculate return periods at each centroid.
         inten: np.array
-            The intensity array for a specific chunk of data.
+            subarray of full hazard intensities corresponding to a subset of the centroids (rows corresponds to
+            events, columns correspond to centroids)
 
         Returns
         -------

climada/hazard/test/test_io.py

@@ -21,10 +21,8 @@
 import unittest
 from unittest.mock import patch
 import datetime as dt
-import os
 from pathlib import Path
 from tempfile import TemporaryDirectory
-import rasterio
 
 from pyproj import CRS
 import numpy as np

climada/test/test_plot.py

@@ -105,14 +105,6 @@ def test_hazard_rp_intensity(self):
         (axis1, axis2), _ = hazard.plot_rp_intensity([25, 50])
         self.assertEqual('Return period: 25 years', axis1.get_title())
         self.assertEqual('Return period: 50 years', axis2.get_title())
-
-    # def test_plot_local_rp(self):
-    #     """"Plot local return period maps for different hazard intensities"""
-    #     hazard = Hazard.from_hdf5(HAZ_TEST_TC)
-    #     (axis1, axis2), return_stats = hazard.plot_local_rp([10., 20.])
-    #     self.assertEqual('Intensity: 10.0 m/s', axis1.get_title())
-    #     self.assertEqual('Intensity: 20.0 m/s', axis2.get_title())
-    #     np.testing.assert_array_equal(return_stats.shape, (2, 100))
 
     def test_exposures_value_pass(self):
         """Plot exposures values."""

climada/util/plot.py

@@ -887,8 +887,7 @@ def subplots_from_gdf(gdf: GeoDataFrame, gdf_meta: GdfMeta = None, smooth=True,
         ----------
         gdf: gpd.GeoDataFrame
             return periods per threshold intensity
-        gdf_meta: 
-            climada.util.plot.GdfMeta
+        gdf_meta: climada.util.plot.GdfMeta
             gdf meta data in named tuple with attributes 'name' (quantity in gdf), 'unit', (unit thereof)
             'col_name' (quantity in column labels), 'col_unit' (unit thereof)
         smooth: bool, optional

climada/util/test/test_plot.py

@@ -25,7 +25,7 @@
 import matplotlib.pyplot as plt
 from matplotlib import colormaps as cm
 import cartopy.crs as ccrs
-from geopandas import GeoDataFrame
+import geopandas as gpd
 from shapely import Point
 
 import climada.util.plot as u_plot
@@ -153,7 +153,7 @@ def test_geo_im_from_array(self):
         plt.close()
 
     def test_subplots_from_gdf(self):
-        return_periods = GeoDataFrame(
+        return_periods = gpd.GeoDataFrame(
             data = ((2., 5.), (3., 6.), (None, 2.), (1., 7.)),
             columns = ('10.0', '20.0')
         )