Merge pull request #981 from CLIMADA-project/feature/climada_osmflex

Add osm-flex to CLIMADA core
CLIMADA-project · Jan 14, 2025 · 493deb0 · 493deb0
2 parents 86061e2 + b90d42e
commit 493deb0
Show file tree

Hide file tree

Showing 5 changed files with 659 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ Code freeze date: YYYY-MM-DD
 
 ### Added
 
+- Add `osm-flex` package to CLIMADA core [#981](https://github.com/CLIMADA-project/climada_python/pull/981)
+- `doc.tutorial.climada_entity_Exposures_osm.ipynb` tutorial explaining how to use `osm-flex`with CLIMADA
 - `climada.util.coordinates.bounding_box_global` function [#980](https://github.com/CLIMADA-project/climada_python/pull/980)
 - `climada.util.coordinates.bounding_box_from_countries` function [#980](https://github.com/CLIMADA-project/climada_python/pull/980)
 - `climada.util.coordinates.bounding_box_from_cardinal_bounds` function [#980](https://github.com/CLIMADA-project/climada_python/pull/980)

diff --git a/doc/tutorial/climada_entity_Exposures_osm.ipynb b/doc/tutorial/climada_entity_Exposures_osm.ipynb
diff --git a/doc/tutorial/climada_entity_Exposures_polygons_lines.ipynb b/doc/tutorial/climada_entity_Exposures_polygons_lines.ipynb
@@ -24,7 +24,13 @@
     "    * Interpolate geometries to points to fit in an `Exposure` instance; \n",
     "    * Disaggregate the respective geometry values to the point values\n",
     "2. Perform the impact calculation in CLIMADA with the point exposure\n",
-    "3. Aggregate the calculated point `Impact` back to an impact instance for the initial polygons or lines  "
+    "3. Aggregate the calculated point `Impact` back to an impact instance for the initial polygons or lines  \n",
+    "\n",
+    "Note:\n",
+    "Polygons or lines can be useful to represent specific types of exposures such as infrastructures (e.g. roads)\n",
+    "or landuse types (e.g. crops, forests). In CLIMADA, it is possible to retrieve such specific exposure types using \n",
+    "[OpenStreetMap data](https://www.openstreetmap.org/). Please refer to the associated [tutorial](https://climada-python.readthedocs.io/en/latest/tutorial/climada_entity_Exposures_osm.html) to learn \n",
+    "how to do so."
    ]
   },
   {
@@ -2692,7 +2698,7 @@
  "metadata": {
   "hide_input": false,
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "climada_osm",
    "language": "python",
    "name": "python3"
   },
@@ -2706,7 +2712,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.12"
+   "version": "3.9.18"
   },
   "latex_envs": {
    "LaTeX_envs_menu_present": true,

diff --git a/doc/tutorial/exposures.rst b/doc/tutorial/exposures.rst
@@ -8,3 +8,4 @@ Exposures Tutorials
     climada_entity_Exposures
     LitPop <climada_entity_LitPop>
     Polygons or Lines as Exposures <climada_entity_Exposures_polygons_lines>
+    OpenStreetMap data as Exposures <climada_entity_Exposures_osm>
diff --git a/requirements/env_climada.yml b/requirements/env_climada.yml
@@ -18,6 +18,7 @@ dependencies:
   - numba>=0.60
   - numexpr>=2.10
   - openpyxl>=3.1
+  - osm-flex>=1.1
   - pandas>=2.1,<2.2  # 2.2 is not compatible with the default pytables=3.7 and yields a very high deprecation warning number through geopandas
   - pandas-datareader>=0.10
   - pathos>=0.3