Merge branch 'develop' into feature/basins-bounds

NicolasColombi · NicolasColombi · commit 5a5c128c46bc · 2025-04-08T16:01:11.000+02:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,7 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, they will
+# be requested for review when someone opens a pull request.
+*       @emanuel-schmid @chahank @peanutfun
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -16,7 +16,7 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
       -
         name: Checkout target commit
-        run: git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin ${{ github.event.pull_request.base.ref }}
+        run: git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=50 origin ${{ github.event.pull_request.base.ref }}
       -
         name: Set up Python 3.11
         uses: actions/setup-python@v5
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ Code freeze date: YYYY-MM-DD
 ### Changed
 - `Hazard.local_exceedance_intensity`, `Hazard.local_return_period` and `Impact.local_exceedance_impact`, `Impact.local_return_period`, using the `climada.util.interpolation` module: New default (no binning), binning on decimals, and faster implementation [#1012](https://github.com/CLIMADA-project/climada_python/pull/1012)
 ### Fixed
+- NaN plotting issues in `geo_im_from_array`[#1038](https://github.com/CLIMADA-project/climada_python/pull/1038)
 
 ### Deprecated
 
@@ -190,6 +191,7 @@ CLIMADA tutorials. [#872](https://github.com/CLIMADA-project/climada_python/pull
 - `Impact.from_hdf5` now calls `str` on `event_name` data that is not strings, and issue a warning then [#894](https://github.com/CLIMADA-project/climada_python/pull/894)
 - `Impact.write_hdf5` now throws an error if `event_name` is does not contain strings exclusively [#894](https://github.com/CLIMADA-project/climada_python/pull/894)
 - Split `climada.hazard.trop_cyclone` module into smaller submodules without affecting module usage [#911](https://github.com/CLIMADA-project/climada_python/pull/911)
+- `yearly_steps` parameter of `TropCyclone.apply_climate_scenario_knu` has been made explicit [#991](https://github.com/CLIMADA-project/climada_python/pull/991)
 
 ### Fixed
 
diff --git a/climada/hazard/trop_cyclone/trop_cyclone.py b/climada/hazard/trop_cyclone/trop_cyclone.py
@@ -391,7 +391,7 @@ def apply_climate_scenario_knu(
         percentile: str = "50",
         scenario: str = "4.5",
         target_year: int = 2050,
-        **kwargs,
+        yearly_steps: int = 5,
     ):
         """
         From current TC hazard instance, return new hazard set with future events
@@ -437,6 +437,9 @@ def apply_climate_scenario_knu(
 
         target_year : int
             future year to be simulated, between 2000 and 2100. Default: 2050.
+        yearly_steps : int
+            yearly resolution at which projections are provided. Default is 5 years.
+
         Returns
         -------
         haz_cc : climada.hazard.TropCyclone
@@ -465,11 +468,11 @@ def apply_climate_scenario_knu(
         for basin in np.unique(tc_cc.basin):
             scale_year_rcp_05, scale_year_rcp_45 = [
                 get_knutson_scaling_factor(
-                    percentile=percentile,
                     variable=variable,
+                    percentile=percentile,
                     basin=basin,
                     baseline=(np.min(years), np.max(years)),
-                    **kwargs,
+                    yearly_steps=yearly_steps,
                 ).loc[target_year, scenario]
                 for variable in ["cat05", "cat45"]
             ]
diff --git a/climada/util/earth_engine.py b/climada/util/earth_engine.py
@@ -26,148 +26,159 @@
 # That's why `earthengine-api` is not in the CLIMADA requirements.
 # See tutorial: climada_util_earth_engine.ipynb
 # pylint: disable=import-error
-import ee
-
 LOGGER = logging.getLogger(__name__)
-ee.Initialize()
-
-
-def obtain_image_landsat_composite(landsat_collection, time_range, area):
-    """Selection of Landsat cloud-free composites in the Earth Engine library
-    See also: https://developers.google.com/earth-engine/landsat
-
-    Parameters
-    ----------
-    collection :
-        name of the collection
-    time_range : ['YYYY-MT-DY','YYYY-MT-DY']
-        must be inside the available data
-    area : ee.geometry.Geometry
-        area of interest
-
-    Returns
-    -------
-    image_composite : ee.image.Image
-    """
-    collection = ee.ImageCollection(landsat_collection)
-
-    # Filter by time range and location
-    collection_time = collection.filterDate(time_range[0], time_range[1])
-    image_area = collection_time.filterBounds(area)
-    image_composite = ee.Algorithms.Landsat.simpleComposite(image_area, 75, 3)
-    return image_composite
-
-
-def obtain_image_median(collection, time_range, area):
-    """Selection of median from a collection of images in the Earth Engine library
-    See also: https://developers.google.com/earth-engine/reducers_image_collection
-
-    Parameters
-    ----------
-    collection :
-        name of the collection
-    time_range : ['YYYY-MT-DY','YYYY-MT-DY']
-        must be inside the available data
-    area : ee.geometry.Geometry
-        area of interest
-
-    Returns
-    -------
-    image_median : ee.image.Image
-    """
-    collection = ee.ImageCollection(collection)
-
-    # Filter by time range and location
-    collection_time = collection.filterDate(time_range[0], time_range[1])
-    image_area = collection_time.filterBounds(area)
-    image_median = image_area.median()
-    return image_median
-
-
-def obtain_image_sentinel(sentinel_collection, time_range, area):
-    """Selection of median, cloud-free image from a collection of images in the Sentinel 2 dataset
-    See also: https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_S2
-
-    Parameters
-    ----------
-    collection :
-        name of the collection
-    time_range : ['YYYY-MT-DY','YYYY-MT-DY']
-        must be inside the available data
-    area : ee.geometry.Geometry
-        area of interest
-
-    Returns
-    -------
-    sentinel_median : ee.image.Image
-    """
-
-    # First, method to remove cloud from the image
-    def maskclouds(image):
-        band_qa = image.select("QA60")
-        cloud_mask = ee.Number(2).pow(10).int()
-        cirrus_mask = ee.Number(2).pow(11).int()
-        mask = band_qa.bitwiseAnd(cloud_mask).eq(0) and (
-            band_qa.bitwiseAnd(cirrus_mask).eq(0)
-        )
-        return image.updateMask(mask).divide(10000)
-
-    sentinel_filtered = (
-        ee.ImageCollection(sentinel_collection)
-        .filterBounds(area)
-        .filterDate(time_range[0], time_range[1])
-        .filter(ee.Filter.lt("CLOUDY_PIXEL_PERCENTAGE", 20))
-        .map(maskclouds)
+
+try:
+    import ee
+
+    LOGGER.info("Google Earth Engine API successfully imported.")
+    EE_AVAILABLE = True
+except ImportError:
+    LOGGER.error(
+        "Google Earth Engine API not found. Please install it using 'pip install earthengine-api'."
+    )
+    EE_AVAILABLE = False
+
+if not EE_AVAILABLE:
+    LOGGER.error(
+        "Google Earth Engine API not found. Skipping the init of `earth_engine.py`."
     )
+else:
+    ee.Initialize()
+
+    def obtain_image_landsat_composite(landsat_collection, time_range, area):
+        """Selection of Landsat cloud-free composites in the Earth Engine library
+        See also: https://developers.google.com/earth-engine/landsat
+
+        Parameters
+        ----------
+        collection :
+            name of the collection
+        time_range : ['YYYY-MT-DY','YYYY-MT-DY']
+            must be inside the available data
+        area : ee.geometry.Geometry
+            area of interest
+
+        Returns
+        -------
+        image_composite : ee.image.Image
+        """
+        collection = ee.ImageCollection(landsat_collection)
+
+        # Filter by time range and location
+        collection_time = collection.filterDate(time_range[0], time_range[1])
+        image_area = collection_time.filterBounds(area)
+        image_composite = ee.Algorithms.Landsat.simpleComposite(image_area, 75, 3)
+        return image_composite
+
+    def obtain_image_median(collection, time_range, area):
+        """Selection of median from a collection of images in the Earth Engine library
+        See also: https://developers.google.com/earth-engine/reducers_image_collection
+
+        Parameters
+        ----------
+        collection :
+            name of the collection
+        time_range : ['YYYY-MT-DY','YYYY-MT-DY']
+            must be inside the available data
+        area : ee.geometry.Geometry
+            area of interest
+
+        Returns
+        -------
+        image_median : ee.image.Image
+        """
+        collection = ee.ImageCollection(collection)
+
+        # Filter by time range and location
+        collection_time = collection.filterDate(time_range[0], time_range[1])
+        image_area = collection_time.filterBounds(area)
+        image_median = image_area.median()
+        return image_median
+
+    def obtain_image_sentinel(sentinel_collection, time_range, area):
+        """Selection of median, cloud-free image from a collection of images in the Sentinel 2
+        dataset.
+        See also: https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_S2
+
+        Parameters
+        ----------
+        collection :
+            name of the collection
+        time_range : ['YYYY-MT-DY','YYYY-MT-DY']
+            must be inside the available data
+        area : ee.geometry.Geometry
+            area of interest
+
+        Returns
+        -------
+        sentinel_median : ee.image.Image
+        """
+
+        # First, method to remove cloud from the image
+        def maskclouds(image):
+            band_qa = image.select("QA60")
+            cloud_mask = ee.Number(2).pow(10).int()
+            cirrus_mask = ee.Number(2).pow(11).int()
+            mask = band_qa.bitwiseAnd(cloud_mask).eq(0) and (
+                band_qa.bitwiseAnd(cirrus_mask).eq(0)
+            )
+            return image.updateMask(mask).divide(10000)
+
+        sentinel_filtered = (
+            ee.ImageCollection(sentinel_collection)
+            .filterBounds(area)
+            .filterDate(time_range[0], time_range[1])
+            .filter(ee.Filter.lt("CLOUDY_PIXEL_PERCENTAGE", 20))
+            .map(maskclouds)
+        )
+
+        sentinel_median = sentinel_filtered.median()
+        return sentinel_median
+
+    def get_region(geom):
+        """Get the region of a given geometry, needed for exporting tasks.
+
+        Parameters
+        ----------
+        geom : ee.Geometry, ee.Feature, ee.Image
+            region of interest
+
+        Returns
+        -------
+        region : list
+        """
+        if isinstance(geom, ee.Geometry):
+            return geom.getInfo()["coordinates"]
+        if isinstance(geom, (ee.Feature, ee.Image)):
+            return geom.geometry().getInfo()["coordinates"]
+        raise ValueError(
+            "parameter must be one of `ee.Geometry`, `ee.Feature`, `ee.Image`"
+        )
+
+    def get_url(name, image, scale, region):
+        """It will open and download automatically a zip folder containing Geotiff data of 'image'.
+        If additional parameters are needed, see also:
+        https://github.com/google/earthengine-api/blob/master/python/ee/image.py
+
+        Parameters
+        ----------
+        name : str
+            name of the created folder
+        image : ee.image.Image
+            image to export
+        scale : int
+            resolution of export in meters (e.g: 30 for Landsat)
+        region : list
+            region of interest
+
+        Returns
+        -------
+        path : str
+        """
+        path = image.getDownloadURL(
+            {"name": (name), "scale": scale, "region": (region)}
+        )
 
-    sentinel_median = sentinel_filtered.median()
-    return sentinel_median
-
-
-def get_region(geom):
-    """Get the region of a given geometry, needed for exporting tasks.
-
-    Parameters
-    ----------
-    geom : ee.Geometry, ee.Feature, ee.Image
-        region of interest
-
-    Returns
-    -------
-    region : list
-    """
-    if isinstance(geom, ee.Geometry):
-        region = geom.getInfo()["coordinates"]
-    elif isinstance(geom, ee.Feature, ee.Image):
-        region = geom.geometry().getInfo()["coordinates"]
-    elif isinstance(geom, list):
-        condition = all([isinstance(item) == list for item in geom])
-        if condition:
-            region = geom
-    return region
-
-
-def get_url(name, image, scale, region):
-    """It will open and download automatically a zip folder containing Geotiff data of 'image'.
-    If additional parameters are needed, see also:
-    https://github.com/google/earthengine-api/blob/master/python/ee/image.py
-
-    Parameters
-    ----------
-    name : str
-        name of the created folder
-    image : ee.image.Image
-        image to export
-    scale : int
-        resolution of export in meters (e.g: 30 for Landsat)
-    region : list
-        region of interest
-
-    Returns
-    -------
-    path : str
-    """
-    path = image.getDownloadURL({"name": (name), "scale": scale, "region": (region)})
-
-    webbrowser.open_new_tab(path)
-    return path
+        webbrowser.open_new_tab(path)
+        return path
diff --git a/climada/util/plot.py b/climada/util/plot.py
diff --git a/doc/index.rst b/doc/index.rst

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ jobs:`
`16`	`16`	`ref: ${{ github.event.pull_request.head.sha }}`
`17`	`17`	`-`
`18`	`18`	`name: Checkout target commit`
`19`		`- run: git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin ${{ github.event.pull_request.base.ref }}`
	`19`	`+ run: git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=50 origin ${{ github.event.pull_request.base.ref }}`
`20`	`20`	`-`
`21`	`21`	`name: Set up Python 3.11`
`22`	`22`	`uses: actions/setup-python@v5`