Merge branch 'develop' into calibrate-impact-functions

Author: peanutfun

.jenkins_ci.sh

@@ -28,7 +28,7 @@ Removed:
 - `climada.util.coordinates.match_centroids` method for matching (hazard) centroids to GeoDataFrames [#602](https://github.com/CLIMADA-project/climada_python/pull/602)
 - 'Extra' requirements `doc`, `test`, and `dev` for Python package [#712](https://github.com/CLIMADA-project/climada_python/pull/712)
 - 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. 
+- 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))
 
 ### Changed
@@ -51,11 +51,20 @@ Removed:
 - Users can opt-out of the climada specific logging definitions and freely configure logging to their will, by setting the config value `logging.managed` to `false`. [#724](https://github.com/CLIMADA-project/climada_python/pull/724)
 - Add option to read additional variables from IBTrACS when using `TCTracks.from_ibtracs_netcdf` [#728](https://github.com/CLIMADA-project/climada_python/pull/728)
 - The `haz_type` attribute has been moved from `climada.hazard.tag.Tag` to `climada.hazard.Hazard` itself. [#736](https://github.com/CLIMADA-project/climada_python/pull/736)
+- New file format for `TCTracks` I/O with better performance. This change is not backwards compatible: If you stored `TCTracks` objects with `TCTracks.write_hdf5`, reload the original data and store them again. [#735](https://github.com/CLIMADA-project/climada_python/pull/735)
+- Add option to load only a subset when reading TC tracks using `TCTracks.from_simulations_emanuel`. [#741](https://github.com/CLIMADA-project/climada_python/pull/741)
+- Set `save_mat` to `False` in the `unsequa` module [#746](https://github.com/CLIMADA-project/climada_python/pull/746)
+- `list_dataset_infos` from `climada.util.api_client.Client`: the `properties` argument, a `dict`, can now have `None` as values. Before, only strings and lists of strings were allowed. Setting a particular property to `None` triggers a search for datasets where this property is not assigned. [#752](https://github.com/CLIMADA-project/climada_python/pull/752)
+- Reduce memory requirements of `TropCyclone.from_tracks` [#749](https://github.com/CLIMADA-project/climada_python/pull/749)
+- Support for different wind speed and pressure units in `TCTracks` when running `TropCyclone.from_tracks` [#749](https://github.com/CLIMADA-project/climada_python/pull/749)
 
 ### Fixed
 
 - `util.lines_polys_handler` solve polygon disaggregation issue in metre-based projection [#666](https://github.com/CLIMADA-project/climada_python/pull/666)
 - Problem with `pyproj.CRS` as `Impact` attribute, [#706](https://github.com/CLIMADA-project/climada_python/issues/706). Now CRS is always stored as `str` in WKT format.
+- Correctly handle assertion errors in `Centroids.values_from_vector_files` and fix the associated test [#768](https://github.com/CLIMADA-project/climada_python/pull/768/)
+- Text in `Forecast` class plots can now be adjusted [#769](https://github.com/CLIMADA-project/climada_python/issues/769)
+- `Impact.impact_at_reg` now supports impact matrices where all entries are zero [#773](https://github.com/CLIMADA-project/climada_python/pull/773)
 
 ### Deprecated
 
@@ -66,8 +75,8 @@ Removed:
 ### Removed
 
 - `Centroids.set_raster_from_pix_bounds` [#721](https://github.com/CLIMADA-project/climada_python/pull/721)
-
 - `requirements/env_developer.yml` environment specs. Use 'extra' requirements when installing the Python package instead [#712](https://github.com/CLIMADA-project/climada_python/pull/712)
+- `Impact.tag` attribute. This change is not backwards-compatible with respect to the files written and read by the `Impact` class [#743](https://github.com/CLIMADA-project/climada_python/pull/743)
 
 ## v3.3.2
 

.jenkins_ci_night.sh

@@ -24,8 +24,8 @@ unit_test : ## Unit tests execution with coverage and xml reports
 
 .PHONY : install_test
 install_test : ## Test installation was successful
-	pytest $(PYTEST_JUNIT_ARGS) climada/engine/test/test_cost_benefit.py \
-	climada/engine/test/test_impact.py
+	pytest $(PYTEST_JUNIT_ARGS) --pyargs climada.engine.test.test_cost_benefit \
+	climada.engine.test.test_impact
 
 .PHONY : data_test
 data_test : ## Test data APIs

.jenkins_data.sh

@@ -313,6 +313,7 @@ def calc(self, force_reassign=False):
     def plot_imp_map(
         self,
         run_datetime=None,
+        explain_str=None,
         save_fig=True,
         close_fig=False,
         polygon_file=None,
@@ -321,13 +322,17 @@ def plot_imp_map(
         figsize=(9, 13),
         adapt_fontsize=True,
     ):
-        """plot a map of the impacts
+        """ plot a map of the impacts
 
         Parameters
         ----------
         run_datetime : datetime.datetime, optional
             Select the used hazard by the run_datetime,
             default is first element of attribute run_datetime.
+        explain_str : str, optional
+            Short str which explains type of impact, explain_str is included
+            in the title of the figure.
+            default is 'mean building damage caused by wind'
         save_fig : bool, optional
             Figure is saved if True, folder is within your configurable
             save_dir and filename is derived from the method summary_str()
@@ -372,7 +377,7 @@ def plot_imp_map(
             "run_start": (
                 run_datetime.strftime("%d.%m.%Y %HUTC +") + lead_time_str + "d"
             ),
-            "explain_text": ("mean building damage caused by wind"),
+            "explain_text": "mean building damage caused by wind" if explain_str is None else explain_str,
             "model_text": "CLIMADA IMPACT",
         }
         fig, axes = self._plot_imp_map(
@@ -526,15 +531,24 @@ def _plot_imp_map(
         return fig, axis_sub
 
     def plot_hist(
-        self, run_datetime=None, save_fig=True, close_fig=False, figsize=(9, 8)
+        self,
+        run_datetime=None,
+        explain_str=None,
+        save_fig=True,
+        close_fig=False,
+        figsize=(9, 8),
     ):
-        """plot histogram of the forecasted impacts all ensemble members
+        """ plot histogram of the forecasted impacts all ensemble members
 
         Parameters
         ----------
         run_datetime : datetime.datetime, optional
             Select the used hazard by the run_datetime,
             default is first element of attribute run_datetime.
+        explain_str : str, optional
+            Short str which explains type of impact, explain_str is included
+            in the title of the figure.
+            default is 'total building damage'
         save_fig : bool, optional
             Figure is saved if True, folder is within your configurable
             save_dir and filename is derived from the method summary_str()
@@ -603,7 +617,7 @@ def plot_hist(
         axes.xaxis.set_ticks(x_ticks)
         axes.xaxis.set_ticklabels(x_ticklabels)
         plt.xticks(rotation=15, horizontalalignment="right")
-        plt.xlim([(10**-0.25) * bins[0], (10**0.25) * bins[-1]])
+        plt.xlim([(10 ** -0.25) * bins[0], (10 ** 0.25) * bins[-1]])
 
         lead_time_str = "{:.0f}".format(
             self.lead_time(run_datetime).days
@@ -614,7 +628,7 @@ def plot_hist(
             "run_start": (
                 run_datetime.strftime("%d.%m.%Y %HUTC +") + lead_time_str + "d"
             ),
-            "explain_text": ("total building damage"),
+            "explain_text": ("total building damage") if explain_str is None else explain_str,
             "model_text": "CLIMADA IMPACT",
         }
         title_position = {
@@ -656,8 +670,9 @@ def plot_hist(
         plt.text(
             0.75,
             0.85,
-            "mean damage:\nCHF "
-            + self._number_to_str(self._impact[haz_ind].at_event.mean()),
+            "mean impact:\n "
+            + self._number_to_str(self._impact[haz_ind].at_event.mean())
+            + ' ' + self._impact[haz_ind].unit,
             horizontalalignment="center",
             verticalalignment="center",
             transform=axes.transAxes,
@@ -740,7 +755,7 @@ def plot_exceedence_prob(
             The default is (9, 13)
         adapt_fontsize : bool, optional
             If set to true, the size of the fonts will be adapted to the size of the figure.
-            Otherwise the default matplotlib font size is used. Default is True.
+            Otherwise, the default matplotlib font size is used. Default is True.
 
         Returns
         -------
@@ -750,10 +765,10 @@ def plot_exceedence_prob(
         if run_datetime is None:
             run_datetime = self.run_datetime[0]
         haz_ind = np.argwhere(np.isin(self.run_datetime, run_datetime))[0][0]
-        wind_map_file_name = (
+        exceedence_map_file_name = (
             self.summary_str(run_datetime) + "_exceed_" + str(threshold) + "_map.jpeg"
         )
-        wind_map_file_name_full = FORECAST_PLOT_DIR / wind_map_file_name
+        exceedence_map_file_name_full = FORECAST_PLOT_DIR / exceedence_map_file_name
         lead_time_str = "{:.0f}".format(
             self.lead_time(run_datetime).days
             + self.lead_time(run_datetime).seconds / 60 / 60 / 24
@@ -783,7 +798,7 @@ def plot_exceedence_prob(
             adapt_fontsize=adapt_fontsize,
         )
         if save_fig:
-            plt.savefig(wind_map_file_name_full)
+            plt.savefig(exceedence_map_file_name_full)
         if close_fig:
             plt.clf()
             plt.close(fig)
@@ -974,7 +989,7 @@ def plot_warn_map(
             Figure is not drawn if True. The default is False.
         adapt_fontsize : bool, optional
             If set to true, the size of the fonts will be adapted to the size of the figure.
-            Otherwise the default matplotlib font size is used. Default is True.
+            Otherwise, the default matplotlib font size is used. Default is True.
 
         Returns
         -------
@@ -1086,7 +1101,7 @@ def _plot_warn(
                 decision_dict_functions[aggregation] = np.mean
             else:
                 raise ValueError(
-                    "Parameter area_aggregation of "
+                    "Parameter " + aggregation + " of "
                     + "Forecast.plot_warn_map() must eiter be "
                     + "a float between [0..1], which "
                     + "specifys a quantile. or 'sum' or 'mean'."