OSM tiling

docs/api.rst

@@ -459,6 +459,7 @@ Raster writing methods
    :toctree: _generated
 
    DataArray.raster.to_xyz_tiles
+   DataArray.raster.to_osm_tiles
    DataArray.raster.to_raster
    Dataset.raster.to_mapstack
 

docs/changelog.rst

@@ -11,7 +11,7 @@ Unreleased
 
 Added
 -----
--
+- New raster method ``to_osm_tiles``: tiling of a raster dataset according to the osm structure.
 
 Changed
 -------

examples/prep_data_catalog.ipynb

@@ -773,7 +773,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.11.4"
   },
   "vscode": {
    "interpreter": {

examples/working_with_tiled_raster_data.ipynb

@@ -52,7 +52,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### tiling raster with XYZ stucture\n",
+    "### Tiling raster with XYZ stucture\n",
     "\n",
     "First let's have a look at the XYZ structure.\n",
     "an xarray.DataArray is simple written to a tile database in XYZ structure via .raster.to_xyz_tiles\n",
@@ -92,12 +92,55 @@
     "At last, a .yml file is produced which can be read by the [DataCatalog](https://deltares.github.io/hydromt/latest/_generated/hydromt.data_catalog.DataCatalog.html) of HydroMT."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Tiling raster with OSM stucture\n",
+    "\n",
+    "Now let's have a look at tiling according to the OSM structure\n",
+    "an xarray.DataArray is simple written to a tile database in OSM structure via .raster.to_osm_tiles"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Write the database in XYZ stucture\n",
+    "name_osm = f\"{source}_osm\"\n",
+    "root_osm = join(\"tmpdir\", name_osm)\n",
+    "zoom_levels = [0, 1, 2, 5]  # note that you have to present all levels\n",
+    "da0.raster.to_osm_tiles(\n",
+    "    root=root_osm,\n",
+    "    zoom_levels=zoom_levels,\n",
+    "    min_lvl=9, # minimal level from where to upscale from (prevent memory issues)\n",
+    "    driver=\"GTiff\",  # try also 'netcdf4'\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The tiles in the 'merit_hydro_OSM' folder now contains all the zoom_levels from the minimal starting level (9) until the highest level (0).\n",
+    "\n",
+    "Every tile, regardless of the zoomlevel, has a resolution of 256 by 256 pixels.\n",
+    "\n",
+    "Zoomlevel 0 is at the scale of the entire world (one tile) and is the most downscaled. Zoomlevel 9 contains the highest resolution (most tiles) in regards to this tile database.\n",
+    "\n",
+    "A mosaic is created per zoomlevel of these tiles in a .vrt file.\n",
+    "\n",
+    "At last, a .yml file is produced which can be read by the [DataCatalog](https://deltares.github.io/hydromt/latest/_generated/hydromt.data_catalog.DataCatalog.html) of HydroMT."
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### reading tiled raster data with zoom levels\n",
+    "### Reading tiled raster data with zoom levels\n",
     "\n",
     "With DataCatalog.[get_rasterdataset](https://deltares.github.io/hydromt/latest/_generated/hydromt.data_catalog.DataCatalog.get_rasterdataset.html) a raster (.vrt) can be retrieved. In case of a tile database it can be done for a certain zoomlevel. E.g."
    ]
@@ -112,12 +155,22 @@
     "from hydromt import DataCatalog\n",
     "\n",
     "# Load the yml into a DataCatalog\n",
-    "data_catalog = DataCatalog(join(root, f\"{name}.yml\"), logger=logger)\n",
+    "data_catalog = DataCatalog([join(root, f\"{name}.yml\"), join(root_osm, f\"{name_osm}.yml\")], logger=logger)\n",
     "\n",
     "# View the structure of the DataCatalog\n",
     "data_catalog[name]"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# For the osm dataset\n",
+    "data_catalog[name_osm]"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -129,6 +182,17 @@
     "da0.raster.shape"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# And for OSM\n",
+    "da1 = data_catalog.get_rasterdataset(name_osm)\n",
+    "da1.raster.shape"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -137,8 +201,10 @@
    "source": [
     "# Request a raster from the Datacatolog based on zoom resolution & unit\n",
     "da = data_catalog.get_rasterdataset(name, zoom_level=(1/600, 'degree'))\n",
+    "da = data_catalog.get_rasterdataset(name_osm, zoom_level=(1/600, 'degree'))\n",
     "\n",
-    "da = data_catalog.get_rasterdataset(name, zoom_level=(1e3, 'meter'))\n"
+    "da = data_catalog.get_rasterdataset(name, zoom_level=(1e3, 'degree'))\n",
+    "da = data_catalog.get_rasterdataset(name_osm, zoom_level=(1e4, 'meter'))\n"
    ]
   },
   {
@@ -220,7 +286,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.11.4"
   },
   "orig_nbformat": 4,
   "vscode": {