cryoswath 0.2.1.post4__tar.gz → 0.2.2.dev0__tar.gz

{cryoswath-0.2.1.post4 → cryoswath-0.2.2.dev0}/.gitignore

@@ -9,6 +9,7 @@ tests/reports/*.pdf
 tests/reports/0-*
 tmp_*
 paper_ESSD
+tox.ini
 
 # below follows a generated list of files one typically wants to exclude
 

cryoswath-0.2.2.dev0/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .
+        

{cryoswath-0.2.1.post4 → cryoswath-0.2.2.dev0}/LICENSE.txt

@@ -1,5 +1,6 @@
 The MIT License (MIT)
-Copyright (c) 2023 Delft University of Technology
+Copyright (c) 2023-2024 Delft University of Technology
+Copyright (c) 2024-2025 Jan Haacker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{cryoswath-0.2.1.post4 → cryoswath-0.2.2.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cryoswath
-Version: 0.2.1.post4
+Version: 0.2.2.dev0
 Summary: Swath processing toolbox for CryoSat-2
 Keywords: glacier,altimetry,swath,cryosat
 Author-email: Jan Haacker <j.m.haacker@tudelft.nl>
@@ -9,9 +9,10 @@ Description-Content-Type: text/markdown
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: Bottleneck
 Requires-Dist: dask
 Requires-Dist: defusedxml
-Requires-Dist: geopandas
+Requires-Dist: geopandas>=1.0.1
 Requires-Dist: gitpython
 Requires-Dist: h5netcdf
 Requires-Dist: h5py
@@ -33,20 +34,21 @@ Requires-Dist: statsmodels
 Requires-Dist: tqdm
 Requires-Dist: xarray
 Requires-Dist: zarr
-Requires-Dist: sphinx ; extra == "doc"
+Requires-Dist: black ; extra == "dev"
+Requires-Dist: sphinx ; extra == "dev"
+Requires-Dist: sphinx-rtd-theme ; extra == "dev"
 Requires-Dist: ipykernel ; extra == "notebooks"
-Project-URL: Documentation, https://j-haacker.github.io/cryoswath
-Project-URL: Homepage, https://github.com/j-haacker/cryoswath
+Project-URL: Documentation, https://cryoswath.readthedocs.io/
 Project-URL: Issues, https://github.com/j-haacker/cryoswath/issues
 Project-URL: Repository, https://github.com/j-haacker/cryoswath.git
-Provides-Extra: doc
+Provides-Extra: dev
 Provides-Extra: notebooks
 
 # cryoswath
 
 ![GitHub top language](https://img.shields.io/github/languages/top/j-haacker/cryoswath)
-![PyPI - Version](https://img.shields.io/pypi/v/cryoswath)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14837018.svg)](https://doi.org/10.5281/zenodo.14837018)
+![Conda Version](https://img.shields.io/conda/vn/conda-forge/cryoswath)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825358.svg)](https://doi.org/10.5281/zenodo.14825358)
 ![GitHub License](https://img.shields.io/github/license/j-haacker/cryoswath)
 
 cryoswath is a python package containing processing pipelines, a tool
@@ -59,11 +61,11 @@ changing the concerned function or adding a new one.
 
 ## 🌱 state
 
-cryoswath is being developed. Branch `main` contains the
-"pip"-installable package, `scripts` contains tutorials, and `data`
-contains auxiliary data and the required directory structure. You can
-have everything setup automatically (see "getting started"). Other
-branches are for development.
+cryoswath is being developed. Branch `main` is the release branch,
+`scripts` contains tutorials, and `data` contains auxiliary data and the
+required directory structure. You can have everything setup
+automatically (see "getting started"). Other branches are for
+development.
 
 ## ✨ features
 
@@ -81,16 +83,26 @@ instructions for UNIX systems. Make sure to use python 3.11 or higher.
 Further, I recommend to use a virtual environment and will involve
 python-venv in the instructions (however, conda works similar).
 
+All of the following instructions consist of three main steps:
+
+1. making cryoswath available
+2. setting up a project directory
+3. initializing cryoswath
+
+The instructions will use the variable `$proj_dir` for the project
+directory. Please set it to a path that suits you like
+`proj_dir=altimetry-project`.
+
+In all cases, consider to download the data dependencies ArcticDEM and
+the RGI glacier and complex shape files into the
+`$proj_dir/data/auxiliary/DEM` and `$proj_dir/data/auxiliary/RGI`
+directories (more in the [docs](https://j-haacker.github.io/cryoswath/prerequisites.html)).
+
 ### with git 🐙
 
 advantage: easy pulling bugfixes
 
-Set up a project directory, pull this repo, create virtual
-environment, initialize, and download ArcticDEM and the RGI glacier and complex
-shape files into the `data/auxiliary/DEM` and -`RGI` directories.
-
 ```sh
-proj_dir=altimetry-project
 git clone https://github.com/j-haacker/cryoswath.git $proj_dir
 cd $proj_dir
 python3.11 -m venv .venv
@@ -103,13 +115,7 @@ cryoswath-init
 
 advantage: easy installation
 
-Set up a project directory, create virtual environment, install
-cryoswath, initialize, and download ArcticDEM and the RGI glacier and
-complex shape files into the `data/auxiliary/DEM` and -`RGI`
-directories.
-
 ```sh
-proj_dir=altimetry-project
 mkdir $proj_dir
 cd $proj_dir
 python3.11 -m venv .venv
@@ -118,30 +124,40 @@ pip install cryoswath
 cryoswath-init
 ```
 
+### with conda 🐍
+
+advantage: most stable dependency resolution
+
+First, choose an environment name and either define `$env_name`, e.g.,
+`env_name=cryoswath`, or adapt the create and activate commands
+accordingly.
+
+```sh
+conda create -n $env_name conda-forge::cryoswath
+conda activate $env_name
+mkdir $proj_dir
+cd $proj_dir
+cryoswath-init
+```
+
 ### with Docker 🐳
 
 advantage: will almost always work
 
 *note*: the first time running the docker image require to download ~ 1 Gb
 
-1. If you don't yet have a designated project directory, make one. I will assume its relative path is `pro/ject`
-2. Then execute `docker run -it -p 8888:8888 -v pro/ject:/home/jovyan cryoswath/jupyterlab:v0.2.1`
-3. You will receive an address including a token with which you can connect to the jupyterlab using your browser
-4. Open a regular shell and execute `cryoswath-init`
-5. Open the scripts folder in the explorer and select one of the notebooks or create your own (inside the scripts folder)
-
-### conda
-
-New setup instructions coming soon.
+1. `docker run -it -p 8888:8888 -v $proj_dir$:/home/jovyan cryoswath/jupyterlab:v0.2.1`
+2. You will receive an address including a token with which you can connect to the jupyterlab using your browser
+3. In jupyterlab, open a regular shell and execute `cryoswath-init`
+4. Open the scripts folder in the explorer and select one of the notebooks or create your own (inside the scripts folder)
 
 ### multiple projects
 
-Similar to the above, set up a virtual environment but rather locate it
-in a neutral directory. For each project, run `cryoswath-init`.
+For each project, run `cryoswath-init` from the project directory.
 
 ## 📖 documentation
 
-[j-haacker.github.io/cryoswath](https://j-haacker.github.io/cryoswath/)
+[j-haacker.github.io/cryoswath](https://cryoswath.readthedocs.io/)
 
 ## dependencies
 
@@ -153,6 +169,7 @@ cryoswath will point you to the required resources.
 
 ## 🐛 known issues
 
+- ESA's data server is not available from all internet service providers
 - projected RGI basins sometimes "invalid"
     -> add `.make_valid()` if it is missing somewhere
 - it has mostly been tested for the Arctic
@@ -166,11 +183,11 @@ You can cite this package using bibtex:
 ```bibtex
 @software{cryoswath,
   author       = {Haacker, Jan},
-  title        = {cryoswath: v0.2.1},
+  title        = {cryoswath: v0.2.2},
   month        = feb,
   year         = 2025,
   publisher    = {Zenodo},
-  version      = {v0.2.1},
+  version      = {v0.2.2},
   doi          = {10.5281/zenodo.14837018}
 }
 ```

{cryoswath-0.2.1.post4 → cryoswath-0.2.2.dev0}/README.md

@@ -1,8 +1,8 @@
 # cryoswath
 
 ![GitHub top language](https://img.shields.io/github/languages/top/j-haacker/cryoswath)
-![PyPI - Version](https://img.shields.io/pypi/v/cryoswath)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14837018.svg)](https://doi.org/10.5281/zenodo.14837018)
+![Conda Version](https://img.shields.io/conda/vn/conda-forge/cryoswath)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825358.svg)](https://doi.org/10.5281/zenodo.14825358)
 ![GitHub License](https://img.shields.io/github/license/j-haacker/cryoswath)
 
 cryoswath is a python package containing processing pipelines, a tool
@@ -15,11 +15,11 @@ changing the concerned function or adding a new one.
 
 ## 🌱 state
 
-cryoswath is being developed. Branch `main` contains the
-"pip"-installable package, `scripts` contains tutorials, and `data`
-contains auxiliary data and the required directory structure. You can
-have everything setup automatically (see "getting started"). Other
-branches are for development.
+cryoswath is being developed. Branch `main` is the release branch,
+`scripts` contains tutorials, and `data` contains auxiliary data and the
+required directory structure. You can have everything setup
+automatically (see "getting started"). Other branches are for
+development.
 
 ## ✨ features
 
@@ -37,16 +37,26 @@ instructions for UNIX systems. Make sure to use python 3.11 or higher.
 Further, I recommend to use a virtual environment and will involve
 python-venv in the instructions (however, conda works similar).
 
+All of the following instructions consist of three main steps:
+
+1. making cryoswath available
+2. setting up a project directory
+3. initializing cryoswath
+
+The instructions will use the variable `$proj_dir` for the project
+directory. Please set it to a path that suits you like
+`proj_dir=altimetry-project`.
+
+In all cases, consider to download the data dependencies ArcticDEM and
+the RGI glacier and complex shape files into the
+`$proj_dir/data/auxiliary/DEM` and `$proj_dir/data/auxiliary/RGI`
+directories (more in the [docs](https://j-haacker.github.io/cryoswath/prerequisites.html)).
+
 ### with git 🐙
 
 advantage: easy pulling bugfixes
 
-Set up a project directory, pull this repo, create virtual
-environment, initialize, and download ArcticDEM and the RGI glacier and complex
-shape files into the `data/auxiliary/DEM` and -`RGI` directories.
-
 ```sh
-proj_dir=altimetry-project
 git clone https://github.com/j-haacker/cryoswath.git $proj_dir
 cd $proj_dir
 python3.11 -m venv .venv
@@ -59,13 +69,7 @@ cryoswath-init
 
 advantage: easy installation
 
-Set up a project directory, create virtual environment, install
-cryoswath, initialize, and download ArcticDEM and the RGI glacier and
-complex shape files into the `data/auxiliary/DEM` and -`RGI`
-directories.
-
 ```sh
-proj_dir=altimetry-project
 mkdir $proj_dir
 cd $proj_dir
 python3.11 -m venv .venv
@@ -74,30 +78,40 @@ pip install cryoswath
 cryoswath-init
 ```
 
+### with conda 🐍
+
+advantage: most stable dependency resolution
+
+First, choose an environment name and either define `$env_name`, e.g.,
+`env_name=cryoswath`, or adapt the create and activate commands
+accordingly.
+
+```sh
+conda create -n $env_name conda-forge::cryoswath
+conda activate $env_name
+mkdir $proj_dir
+cd $proj_dir
+cryoswath-init
+```
+
 ### with Docker 🐳
 
 advantage: will almost always work
 
 *note*: the first time running the docker image require to download ~ 1 Gb
 
-1. If you don't yet have a designated project directory, make one. I will assume its relative path is `pro/ject`
-2. Then execute `docker run -it -p 8888:8888 -v pro/ject:/home/jovyan cryoswath/jupyterlab:v0.2.1`
-3. You will receive an address including a token with which you can connect to the jupyterlab using your browser
-4. Open a regular shell and execute `cryoswath-init`
-5. Open the scripts folder in the explorer and select one of the notebooks or create your own (inside the scripts folder)
-
-### conda
-
-New setup instructions coming soon.
+1. `docker run -it -p 8888:8888 -v $proj_dir$:/home/jovyan cryoswath/jupyterlab:v0.2.1`
+2. You will receive an address including a token with which you can connect to the jupyterlab using your browser
+3. In jupyterlab, open a regular shell and execute `cryoswath-init`
+4. Open the scripts folder in the explorer and select one of the notebooks or create your own (inside the scripts folder)
 
 ### multiple projects
 
-Similar to the above, set up a virtual environment but rather locate it
-in a neutral directory. For each project, run `cryoswath-init`.
+For each project, run `cryoswath-init` from the project directory.
 
 ## 📖 documentation
 
-[j-haacker.github.io/cryoswath](https://j-haacker.github.io/cryoswath/)
+[j-haacker.github.io/cryoswath](https://cryoswath.readthedocs.io/)
 
 ## dependencies
 
@@ -109,6 +123,7 @@ cryoswath will point you to the required resources.
 
 ## 🐛 known issues
 
+- ESA's data server is not available from all internet service providers
 - projected RGI basins sometimes "invalid"
     -> add `.make_valid()` if it is missing somewhere
 - it has mostly been tested for the Arctic
@@ -122,11 +137,11 @@ You can cite this package using bibtex:
 ```bibtex
 @software{cryoswath,
   author       = {Haacker, Jan},
-  title        = {cryoswath: v0.2.1},
+  title        = {cryoswath: v0.2.2},
   month        = feb,
   year         = 2025,
   publisher    = {Zenodo},
-  version      = {v0.2.1},
+  version      = {v0.2.2},
   doi          = {10.5281/zenodo.14837018}
 }
 ```

cryoswath-0.2.2.dev0/cryoswath/__init__.py

@@ -0,0 +1,22 @@
+__all__ = [
+    "__version__",
+    "misc",
+    "gis",
+    "l1b",
+    "l2",
+    "l3",
+    "l4",
+    "test_plots",  # subpackage
+]
+
+from importlib.metadata import version as _version
+from . import gis, misc, l1b, l2, l3, l4, test_plots
+
+
+# copied from xarray
+try:
+    __version__ = _version("cryoswath")
+except Exception:
+    # Local copy or not installed with setuptools.
+    # Disable minimum version checks on downstream libraries.
+    __version__ = "9999"

{cryoswath-0.2.1.post4 → cryoswath-0.2.2.dev0}/cryoswath/gis.py

@@ -1,3 +1,17 @@
+"""Geospatial processing focused helper functions"""
+
+__all__ = [
+    "find_planar_crs",
+    "buffer_4326_shp",
+    "simplify_4326_shp",
+    "get_4326_to_dem_Transformer",
+    "ensure_pyproj_crs",
+    "points_on_glacier",
+    "subdivide_region",
+    "esri_to_feather",
+    "get_lon_origin",
+]
+
 import geopandas as gpd
 import numpy as np
 import os
@@ -8,27 +22,37 @@ import rasterio
 import shapely
 import warnings
 
-from .misc import *
-
-__all__ = list()
+from .misc import (
+    load_glacier_outlines,
+    rgi_path,
+)
 
 # ! tbi:
 rgi_o1_epsg_dict = dict()
 
 
-def buffer_4326_shp(shp: shapely.Geometry, radius: float, simplify: bool = True) -> shapely.MultiPolygon:
+def buffer_4326_shp(
+    shp: shapely.Geometry, radius: float, simplify: bool = True
+) -> shapely.MultiPolygon:
     # the algorithm splits a multi-geomerty like MultiPolygon into its
     # parts, simplifies them if requested, buffers them, and joins them
     # finally.
     # the splitting is necessary to work around issue #13
-    if shp is None: # this will occasionally fail, as it will be 'GEOMETRYCOLLECTION EMPTY'
-        warnings.warn("shp=None passed to buffer_4326_shp, returning empty MultiPolygon.")
+    if (
+        shp is None
+    ):  # this will occasionally fail, as it will be 'GEOMETRYCOLLECTION EMPTY'
+        warnings.warn(
+            "shp=None passed to buffer_4326_shp, returning empty MultiPolygon."
+        )
         return shapely.MultiPolygon()
     # # below does not take the geopandas detour. while more straight forward,
     # # geopandas used to be more stable. however the below was improved and
     # # may be equally good now.
     # transformer = Transformer.from_crs("EPSG:4326", planar_crs)
-    # shp = shapely.ops.transform(transformer.invert().transform, shapely.ops.transform(transformer.transform, shp).simplify(100).buffer(radius)).make_valid()
+    # shp = shapely.ops.transform(transformer.invert().transform,
+    #                             shapely.ops.transform(
+    #       transformer.transform, shp
+    # ).simplify(100).buffer(radius)).make_valid()
     if isinstance(shp, shapely.geometry.base.BaseMultipartGeometry):
         shp = list(shp.geoms)
     elif isinstance(shp, shapely.geometry.base.BaseGeometry):
@@ -45,13 +69,17 @@ def buffer_4326_shp(shp: shapely.Geometry, radius: float, simplify: bool = True)
     buffered_planar = []
     for poly in shp:
         buffered_planar.append(
-            gpd.GeoSeries(poly, crs=4326).to_crs(planar_crs).make_valid().simplify(100).buffer(radius))
+            gpd.GeoSeries(poly, crs=4326)
+            .to_crs(planar_crs)
+            .make_valid()
+            .simplify(100)
+            .buffer(radius)
+        )
     buffered_planar = pd.concat(buffered_planar)
     if simplify:
-        buffered_planar = buffered_planar.simplify(radius/3)
+        buffered_planar = buffered_planar.simplify(radius / 3)
     buffered_planar = buffered_planar.to_crs(4326)
     return shapely.make_valid(buffered_planar.union_all(method="unary"))
-__all__.append("buffer_4326_shp")
 
 
 def ensure_pyproj_crs(crs: CRS) -> CRS:
@@ -64,17 +92,21 @@ def ensure_pyproj_crs(crs: CRS) -> CRS:
             epsg = crs
         crs = CRS.from_epsg(epsg)
     return crs
-__all__.append("ensure_pyproj_crs")
 
 
 def esri_to_feather(file_path: str = None) -> None:
     if file_path.split(os.path.extsep)[-1].lower() == "shp":
         basename = os.path.extsep.join(file_path.split(os.path.extsep)[:-1])
-    gpd.read_file(file_path).to_feather(basename+os.path.extsep+"feather")
-__all__.append("esri_to_feather")
+    gpd.read_file(file_path).to_feather(basename + os.path.extsep + "feather")
 
 
-def find_planar_crs(*, shp: shapely.Geometry = None, lat: float = None, lon: float = None, region_id: str = None):
+def find_planar_crs(
+    *,
+    shp: shapely.Geometry = None,
+    lat: float = None,
+    lon: float = None,
+    region_id: str = None,
+):
     if region_id is not None:
         with warnings.catch_warnings(action="ignore"):
             shp = load_glacier_outlines(region_id)
@@ -87,57 +119,74 @@ def find_planar_crs(*, shp: shapely.Geometry = None, lat: float = None, lon: flo
         return CRS.from_epsg(3976)
     else:
         return gpd.GeoSeries(shp, crs=4326).to_frame().estimate_utm_crs()
-__all__.append("find_planar_crs")
+
 
 def get_lon_origin(crs):
     # Extract Longitude of origin
     # May turn out not to be very robust.
     return ensure_pyproj_crs(crs).coordinate_operation.params[1].value
-__all__.append("get_lon_origin")
-    
+
 
 def get_4326_to_dem_Transformer(dem_reader: rasterio.DatasetReader) -> Transformer:
     return Transformer.from_crs("EPSG:4326", ensure_pyproj_crs(dem_reader.crs))
-__all__.append("get_4326_to_dem_Transformer")
 
 
 def points_on_glacier(points: gpd.GeoSeries) -> pd.Index:
-    o2regions = gpd.read_feather(os.path.join(rgi_path, "RGI2000-v7.0-o2regions.feather"))
-    o2code = o2regions[o2regions.geometry.contains(shapely.box(*points.total_bounds))]["o2region"].values[0]
-    buffered_glaciered_area_polygon = load_o2region(o2code)
+    o2regions = gpd.read_feather(
+        os.path.join(rgi_path, "RGI2000-v7.0-o2regions.feather")
+    )
+    o2code = o2regions[o2regions.geometry.contains(shapely.box(*points.total_bounds))][
+        "o2region"
+    ].values[0]
+    buffered_glaciered_area_polygon = load_glacier_outlines(o2code)
     import time
+
     print(time.time(), "building union")
     union = buffered_glaciered_area_polygon.unary_union
     print(time.time(), "building geoseries")
-    buffered_glaciered_area_polygon = gpd.GeoSeries(union,
-                                                     # ! the buffering below works only for the arctic
-                                                     crs=buffered_glaciered_area_polygon.crs)
+    buffered_glaciered_area_polygon = gpd.GeoSeries(
+        union,
+        # ! the buffering below works only for the arctic
+        crs=buffered_glaciered_area_polygon.crs,
+    )
     print(time.time(), "buffering")
-    buffered_glaciered_area_polygon = buffered_glaciered_area_polygon.to_crs(3413).buffer(30_000)
+    buffered_glaciered_area_polygon = buffered_glaciered_area_polygon.to_crs(
+        3413
+    ).buffer(30_000)
     print(time.time(), "simplifying")
-    buffered_glaciered_area_polygon = buffered_glaciered_area_polygon.simplify(1000).to_crs(4326)
+    buffered_glaciered_area_polygon = buffered_glaciered_area_polygon.simplify(
+        1000
+    ).to_crs(4326)
     return points[points.within(buffered_glaciered_area_polygon[0])].index
-__all__.append("points_on_glacier")
 
 
-def simplify_4326_shp(shp: shapely.Geometry, tolerance: float = None) -> shapely.Geometry:
+def simplify_4326_shp(
+    shp: shapely.Geometry, tolerance: float = None
+) -> shapely.Geometry:
     if tolerance is None:
-        if shp.length >= 20_000: # 5 x 5 km
+        if shp.length >= 20_000:  # 5 x 5 km
             tolerance = 1000
         else:
             tolerance = 300
     planar_crs = find_planar_crs(shp=shp)
-    # simplify can create holes outside of the polygon. this is fixed by buffer(0) or make_valid()
+    # simplify can create holes outside of the polygon. this is fixed by
+    # buffer(0) or make_valid()
     if isinstance(shp, shapely.Geometry):
         shp = gpd.GeoSeries(shp, crs=4326)
-    return shp.to_crs(planar_crs).simplify(tolerance).to_crs(4326).make_valid().union_all(method="unary")
-__all__.append("simplify_4326_shp")
-
-
-def subdivide_region(basin_gdf: gpd.GeoDataFrame,
-                     lat_bin_width_degree: float = 1,
-                     lon_bin_width_degree: float = 1,
-                    ) -> list[gpd.GeoDataFrame]:
+    return (
+        shp.to_crs(planar_crs)
+        .simplify(tolerance)
+        .to_crs(4326)
+        .make_valid()
+        .union_all(method="unary")
+    )
+
+
+def subdivide_region(
+    basin_gdf: gpd.GeoDataFrame,
+    lat_bin_width_degree: float = 1,
+    lon_bin_width_degree: float = 1,
+) -> list[gpd.GeoDataFrame]:
     """Devides GeoDataFrame of basins into smaller GeoDataFrame based on
     their central lat/lon coords.
 
@@ -153,15 +202,25 @@ def subdivide_region(basin_gdf: gpd.GeoDataFrame,
     """
     return_list = []
     # cut latitude into degree slices
-    n_lat_bins = max(1, round((basin_gdf.cenlat.max()-basin_gdf.cenlat.min())/lat_bin_width_degree))
+    n_lat_bins = max(
+        1,
+        round((basin_gdf.cenlat.max() - basin_gdf.cenlat.min()) / lat_bin_width_degree),
+    )
     # below, `observed=True` to grant compatibility with future pandas versions.
-    for lat_label, lat_group in basin_gdf.groupby(pd.cut(basin_gdf.cenlat, bins=n_lat_bins), observed=True):
+    for lat_label, lat_group in basin_gdf.groupby(
+        pd.cut(basin_gdf.cenlat, bins=n_lat_bins), observed=True
+    ):
         # similarly, cut longitude
-        n_lon_bins = max(1, round((lat_group.cenlon.max()-lat_group.cenlon.min())
-                                                     / lon_bin_width_degree
-                                                     * np.cos(np.deg2rad(lat_label.mid))))
-        for _, lon_group in lat_group.groupby(pd.cut(lat_group.cenlon, bins=n_lon_bins), observed=True):
+        n_lon_bins = max(
+            1,
+            round(
+                (lat_group.cenlon.max() - lat_group.cenlon.min())
+                / lon_bin_width_degree
+                * np.cos(np.deg2rad(lat_label.mid))
+            ),
+        )
+        for _, lon_group in lat_group.groupby(
+            pd.cut(lat_group.cenlon, bins=n_lon_bins), observed=True
+        ):
             return_list.append(lon_group)
     return return_list
-__all__.append("subdivide_region")
-