{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "05912d98",
   "metadata": {
    "papermill": {
     "duration": 0.003524,
     "end_time": "2025-06-18T09:44:31.897880",
     "exception": false,
     "start_time": "2025-06-18T09:44:31.894356",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "# Fluvial flood risk\n",
    "\n",
    "This example shows a workflow to derive fluvial flood risk using the **Wflow**, **SFINCS** and **Delft-FIAT** models. The starting point is a user defined region and data catalog. Wflow simulated discharge is translated into hydrographs for different return periods and used to simulate the flood hazard maps. The hazard maps are combined with exposure and impact data to derive risk.\n",
    "\n",
    "This example also show how to work with parsing to CWL."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "01bc5efd",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:31.905279Z",
     "iopub.status.busy": "2025-06-18T09:44:31.904767Z",
     "iopub.status.idle": "2025-06-18T09:44:35.132020Z",
     "shell.execute_reply": "2025-06-18T09:44:35.131534Z"
    },
    "papermill": {
     "duration": 3.231658,
     "end_time": "2025-06-18T09:44:35.132812",
     "exception": false,
     "start_time": "2025-06-18T09:44:31.901154",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - log - hydroflows version: 0.1.0\n"
     ]
    }
   ],
   "source": [
    "# Import packages\n",
    "from pathlib import Path\n",
    "\n",
    "from hydroflows import Workflow, WorkflowConfig\n",
    "from hydroflows.log import setuplog\n",
    "from hydroflows.methods import discharge, fiat, sfincs, wflow\n",
    "from hydroflows.methods.utils.example_data import fetch_data\n",
    "\n",
    "logger = setuplog(level=\"INFO\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "f2369cfb",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:35.140961Z",
     "iopub.status.busy": "2025-06-18T09:44:35.140248Z",
     "iopub.status.idle": "2025-06-18T09:44:35.143501Z",
     "shell.execute_reply": "2025-06-18T09:44:35.143092Z"
    },
    "papermill": {
     "duration": 0.007766,
     "end_time": "2025-06-18T09:44:35.144224",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.136458",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# Define case name and root directory\n",
    "name = \"fluvial_risk\"\n",
    "pwd = Path().resolve()  # Get the current file location\n",
    "case_root = Path(pwd, \"cases\", name)  # output directory\n",
    "pwd_rel = \"../../\"  # relative path from the case directory to the current file"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ecd5a9bf",
   "metadata": {
    "papermill": {
     "duration": 0.003149,
     "end_time": "2025-06-18T09:44:35.150523",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.147374",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "## Workflow inputs\n",
    "\n",
    "The example requires the following inputs which are provided via a configuration file:\n",
    "- a user defined region that can be used to delineate the SFINCS model domain\n",
    "- a data catalog file describing all input datasets. Here we fetch some test datasets for a region in Northern Italy.  \n",
    "- HydroMT configuration files for all three models\n",
    "- how to execute models. Since the CWL runner we use is not supported on Windows, we opt for docker for WFLOW, SFINCS and python for Delft-FIAT."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "6c9af434",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:35.157520Z",
     "iopub.status.busy": "2025-06-18T09:44:35.157153Z",
     "iopub.status.idle": "2025-06-18T09:44:35.939200Z",
     "shell.execute_reply": "2025-06-18T09:44:35.938681Z"
    },
    "papermill": {
     "duration": 0.786575,
     "end_time": "2025-06-18T09:44:35.940193",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.153618",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# Fetch the global build data\n",
    "cache_dir = fetch_data(data=\"global-data\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "44d60060",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:35.948061Z",
     "iopub.status.busy": "2025-06-18T09:44:35.947667Z",
     "iopub.status.idle": "2025-06-18T09:44:35.951273Z",
     "shell.execute_reply": "2025-06-18T09:44:35.950873Z"
    },
    "papermill": {
     "duration": 0.008083,
     "end_time": "2025-06-18T09:44:35.951986",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.943903",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# Setup the configuration\n",
    "config = WorkflowConfig(\n",
    "    # general settings\n",
    "    region=Path(pwd_rel, \"data/build/region.geojson\"),\n",
    "    catalog_path=Path(cache_dir, \"data_catalog.yml\"),\n",
    "    plot_fig=True,\n",
    "    start_date=\"2014-01-01\",\n",
    "    end_date=\"2021-12-31\",\n",
    "    # sfincs settings\n",
    "    hydromt_sfincs_config=Path(pwd_rel, \"hydromt_config/sfincs_config.yml\"),\n",
    "    sfincs_run_method=\"docker\",\n",
    "    depth_min=0.05,  # minimum depth for inundation map\n",
    "    # fiat settings\n",
    "    hydromt_fiat_config=Path(pwd_rel, \"hydromt_config/fiat_config.yml\"),\n",
    "    fiat_run_method=\"python\",\n",
    "    # wflow settings\n",
    "    hydromt_wflow_config=Path(pwd_rel, \"hydromt_config/wflow_config.yml\"),\n",
    "    wflow_run_method=\"docker\",\n",
    "    # design event settings\n",
    "    rps=[2, 5, 10, 50, 100],\n",
    ")\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "5d2d7f5c",
   "metadata": {
    "papermill": {
     "duration": 0.003339,
     "end_time": "2025-06-18T09:44:35.958583",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.955244",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "## Create the workflow"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "2d9d951d",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:35.965808Z",
     "iopub.status.busy": "2025-06-18T09:44:35.965470Z",
     "iopub.status.idle": "2025-06-18T09:44:35.968278Z",
     "shell.execute_reply": "2025-06-18T09:44:35.967791Z"
    },
    "papermill": {
     "duration": 0.007224,
     "end_time": "2025-06-18T09:44:35.969038",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.961814",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# create and empty workflow\n",
    "wf = Workflow(name=name, config=config, root=case_root)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b93b065a",
   "metadata": {
    "papermill": {
     "duration": 0.00319,
     "end_time": "2025-06-18T09:44:35.975986",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.972796",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "### Build models\n",
    "\n",
    "In this section we build a model cascade and make sure these are configured correctly for offline coupling, i.e. Wflow exports discharge at the right locations and Delft-FIAT uses the same ground elevation as SFINCS. Note that you can also skip these steps and use your own models instead."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "0da62292",
   "metadata": {
    "papermill": {
     "duration": 0.003213,
     "end_time": "2025-06-18T09:44:35.982420",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.979207",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "First, we build a **SFINCS** model for the user defined region using. \n",
    " - setting from the hydromt_sfincs_config, see the [HydroMT-SFINCS docs](https://deltares.github.io/hydromt_sfincs/latest/) for more info.\n",
    " - data from the catalog_path, see the [HydroMT docs](https://deltares.github.io/hydromt/v0.10.0/user_guide/data_prepare_cat.html) for more info.\n",
    " - Note that we need src points at the boundary of the SFINCS model (``src_points_output=True``) to get Wflow output at the right locations. Make sure the hydromt_sfincs configuration defines these source locations.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "9d864d3b",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:35.989611Z",
     "iopub.status.busy": "2025-06-18T09:44:35.989286Z",
     "iopub.status.idle": "2025-06-18T09:44:35.995895Z",
     "shell.execute_reply": "2025-06-18T09:44:35.995467Z"
    },
    "papermill": {
     "duration": 0.010963,
     "end_time": "2025-06-18T09:44:35.996588",
     "exception": false,
     "start_time": "2025-06-18T09:44:35.985625",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=sfincs_build, method=sfincs_build, runs=1)"
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Build a SFINCS model\n",
    "sfincs_build = sfincs.SfincsBuild(\n",
    "    region=wf.get_ref(\"$config.region\"),\n",
    "    config=wf.get_ref(\"$config.hydromt_sfincs_config\"),\n",
    "    sfincs_root=\"models/sfincs\",\n",
    "    catalog_path=wf.get_ref(\"$config.catalog_path\"),\n",
    "    plot_fig=wf.get_ref(\"$config.plot_fig\"),\n",
    "    subgrid_output=True,\n",
    "    src_points_output=True,\n",
    ")\n",
    "wf.create_rule(sfincs_build, rule_id=\"sfincs_build\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "5ec79d5b",
   "metadata": {
    "papermill": {
     "duration": 0.003256,
     "end_time": "2025-06-18T09:44:36.003383",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.000127",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "Next we build a **Wflow** model using:\n",
    "- the sfincs_build output for the model region\n",
    "- \"gauges\" based on SFINCS source points\n",
    "- settings from the hydromt_wflow_config, see [HydroMT-Wflow docs](https://deltares.github.io/hydromt_wflow/latest/) \n",
    "- data from the data catalog"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "id": "94af5e6b",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.010933Z",
     "iopub.status.busy": "2025-06-18T09:44:36.010582Z",
     "iopub.status.idle": "2025-06-18T09:44:36.015330Z",
     "shell.execute_reply": "2025-06-18T09:44:36.014843Z"
    },
    "papermill": {
     "duration": 0.00931,
     "end_time": "2025-06-18T09:44:36.016033",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.006723",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=wflow_build, method=wflow_build, runs=1)"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Build a Wflow model\n",
    "wflow_build = wflow.WflowBuild(\n",
    "    region=sfincs_build.output.sfincs_region,\n",
    "    config=wf.get_ref(\"$config.hydromt_wflow_config\"),\n",
    "    wflow_root=\"models/wflow\",\n",
    "    catalog_path=wf.get_ref(\"$config.catalog_path\"),\n",
    "    gauges=sfincs_build.output.sfincs_src_points,\n",
    "    plot_fig=wf.get_ref(\"$config.plot_fig\"),\n",
    ")\n",
    "wf.create_rule(wflow_build, rule_id=\"wflow_build\")\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "6f17e045",
   "metadata": {
    "papermill": {
     "duration": 0.003362,
     "end_time": "2025-06-18T09:44:36.022799",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.019437",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "Next, we build a **FIAT** model using:\n",
    "- the sfincs_build output for the model region and ground elevation\n",
    "- settings from the hydromt_fiat_config, see the [hydromt_fiat docs](https://deltares.github.io/hydromt_fiat/latest/)\n",
    "- data from the data catalog"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "id": "fcdd284e",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.030495Z",
     "iopub.status.busy": "2025-06-18T09:44:36.030182Z",
     "iopub.status.idle": "2025-06-18T09:44:36.034757Z",
     "shell.execute_reply": "2025-06-18T09:44:36.034353Z"
    },
    "papermill": {
     "duration": 0.009177,
     "end_time": "2025-06-18T09:44:36.035502",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.026325",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=fiat_build, method=fiat_build, runs=1)"
      ]
     },
     "execution_count": 8,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Build a FIAT model\n",
    "fiat_build = fiat.FIATBuild(\n",
    "    region=sfincs_build.output.sfincs_region,\n",
    "    ground_elevation=sfincs_build.output.sfincs_subgrid_dep,\n",
    "    fiat_root=\"models/fiat\",\n",
    "    catalog_path=wf.get_ref(\"$config.catalog_path\"),\n",
    "    config=wf.get_ref(\"$config.hydromt_fiat_config\"),\n",
    ")\n",
    "wf.create_rule(fiat_build, rule_id=\"fiat_build\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3ae077b3",
   "metadata": {
    "papermill": {
     "duration": 0.003549,
     "end_time": "2025-06-18T09:44:36.042571",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.039022",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "### Derive fluvial design events from Wflow\n",
    "\n",
    "In this section we derive fluvial design events for each Wflow output gauge location.\n",
    "First, we update and run Wflow to simulate discharge for the present climate. \n",
    "Then, we derive design hydrographs for a number of return periods from discharge time series. By default, the magnitude and shape of these events are based on the annual maxima peaks from the timeseries. Note that we have set `copy_model` to `True`. This is required to be able to run with CWL, as the moving around of inputs done by CWL does not play nice with the relative paths in model config files otherwise used. This also holds for the `update_sfincs` and `update_fiat` steps we will encounter later in this workflow.\n",
    "\n",
    "Note that in case of multiple discharge boundary locations this approach assumes full dependence which might be an oversimplification of the reality."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "id": "7b9af415",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.050484Z",
     "iopub.status.busy": "2025-06-18T09:44:36.050311Z",
     "iopub.status.idle": "2025-06-18T09:44:36.055185Z",
     "shell.execute_reply": "2025-06-18T09:44:36.054769Z"
    },
    "papermill": {
     "duration": 0.009781,
     "end_time": "2025-06-18T09:44:36.055947",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.046166",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=wflow_update, method=wflow_update_forcing, runs=1)"
      ]
     },
     "execution_count": 9,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Update Wflow meteorological forcing for the simulation period\n",
    "wflow_update = wflow.WflowUpdateForcing(\n",
    "    wflow_toml=wflow_build.output.wflow_toml,\n",
    "    catalog_path=wf.get_ref(\"$config.catalog_path\"),\n",
    "    start_time=wf.get_ref(\"$config.start_date\"),\n",
    "    end_time=wf.get_ref(\"$config.end_date\"),\n",
    "    output_dir=wflow_build.output.wflow_toml.parent/\"simulations\"/\"default\",\n",
    "    copy_model=True, # Necessary for CWL\n",
    ")\n",
    "wf.create_rule(wflow_update, rule_id=\"wflow_update\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "id": "abd4532d",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.064192Z",
     "iopub.status.busy": "2025-06-18T09:44:36.063801Z",
     "iopub.status.idle": "2025-06-18T09:44:36.068101Z",
     "shell.execute_reply": "2025-06-18T09:44:36.067592Z"
    },
    "papermill": {
     "duration": 0.009152,
     "end_time": "2025-06-18T09:44:36.068910",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.059758",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=wflow_run, method=wflow_run, runs=1)"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Run the wflow model for a continuous simulation setup in the wflow_update rule\n",
    "wflow_run = wflow.WflowRun(\n",
    "    wflow_toml=wflow_update.output.wflow_out_toml,\n",
    "    run_method=wf.get_ref(\"$config.wflow_run_method\"),\n",
    ")\n",
    "wf.create_rule(wflow_run, rule_id=\"wflow_run\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "id": "a03d9a1a",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.076900Z",
     "iopub.status.busy": "2025-06-18T09:44:36.076714Z",
     "iopub.status.idle": "2025-06-18T09:44:36.081869Z",
     "shell.execute_reply": "2025-06-18T09:44:36.081356Z"
    },
    "papermill": {
     "duration": 0.010012,
     "end_time": "2025-06-18T09:44:36.082607",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.072595",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - wildcards - Added wildcard 'events' with values: ['q_event_rp002', 'q_event_rp005', 'q_event_rp010', 'q_event_rp050', 'q_event_rp100']\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "Rule(id=fluvial_events, method=fluvial_design_events, runs=1, expand=['events'])"
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Derive fluvial design events\n",
    "# Checkout the FluvialDesignEvents parameters for many options\n",
    "fluvial_events = discharge.FluvialDesignEvents(\n",
    "    discharge_nc=wflow_run.output.wflow_output_timeseries,\n",
    "    rps=wf.get_ref(\"$config.rps\"),\n",
    "    event_root=\"input/events\",\n",
    "    index_dim=\"Q_gauges_bounds\",\n",
    "    wildcard=\"events\",\n",
    ")\n",
    "\n",
    "# Note that a new wildcard is created for the fluvial events\n",
    "wf.create_rule(fluvial_events, rule_id=\"fluvial_events\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "98f8d547",
   "metadata": {
    "papermill": {
     "duration": 0.003752,
     "end_time": "2025-06-18T09:44:36.090193",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.086441",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "### Derive flood hazard"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "462e521a",
   "metadata": {
    "papermill": {
     "duration": 0.003732,
     "end_time": "2025-06-18T09:44:36.097657",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.093925",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "To derive flood hazard maps for each event, we \n",
    "1. Update the SFINCS model using the discharge event timeseries. This will create new SFINCS instances for each event.\n",
    "2. Run the SFINCS model. This will create simulated water levels for each event.\n",
    "3. Postprocess the SFINCS output. This will postprocess the SFINCS results to a regular grid of maximum water levels.\n",
    "4. Optionally, downscale the SFINCS output. This will downscale the max simulated SFINCS water levels to a high-res flood depth map."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "id": "96b0c523",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.105974Z",
     "iopub.status.busy": "2025-06-18T09:44:36.105542Z",
     "iopub.status.idle": "2025-06-18T09:44:36.110729Z",
     "shell.execute_reply": "2025-06-18T09:44:36.110356Z"
    },
    "papermill": {
     "duration": 0.010058,
     "end_time": "2025-06-18T09:44:36.111447",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.101389",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=sfincs_update, method=sfincs_update_forcing, runs=5, repeat=['events'])"
      ]
     },
     "execution_count": 12,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Update the SFINCS model with fluvial events\n",
    "sfincs_update = sfincs.SfincsUpdateForcing(\n",
    "    sfincs_inp=sfincs_build.output.sfincs_inp,\n",
    "    event_yaml=fluvial_events.output.event_yaml,\n",
    "    output_dir=sfincs_build.output.sfincs_inp.parent/\"simulations\"/\"{events}\",\n",
    "    copy_model=True, # Necessary for CWL\n",
    ")\n",
    "wf.create_rule(sfincs_update, rule_id=\"sfincs_update\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "id": "1e567edb",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.119782Z",
     "iopub.status.busy": "2025-06-18T09:44:36.119634Z",
     "iopub.status.idle": "2025-06-18T09:44:36.124217Z",
     "shell.execute_reply": "2025-06-18T09:44:36.123715Z"
    },
    "papermill": {
     "duration": 0.009715,
     "end_time": "2025-06-18T09:44:36.125027",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.115312",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=sfincs_run, method=sfincs_run, runs=5, repeat=['events'])"
      ]
     },
     "execution_count": 13,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Run the SFINCS model for each fluvial event\n",
    "sfincs_run = sfincs.SfincsRun(\n",
    "    sfincs_inp=sfincs_update.output.sfincs_out_inp,\n",
    "    run_method=wf.get_ref(\"$config.sfincs_run_method\")\n",
    ")\n",
    "wf.create_rule(sfincs_run, rule_id=\"sfincs_run\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "id": "62c3869a",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.133655Z",
     "iopub.status.busy": "2025-06-18T09:44:36.133304Z",
     "iopub.status.idle": "2025-06-18T09:44:36.137975Z",
     "shell.execute_reply": "2025-06-18T09:44:36.137488Z"
    },
    "papermill": {
     "duration": 0.009722,
     "end_time": "2025-06-18T09:44:36.138691",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.128969",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=sfincs_post, method=sfincs_postprocess, runs=5, repeat=['events'])"
      ]
     },
     "execution_count": 14,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Postprocesses SFINCS results to a regular grid of maximum water levels\n",
    "sfincs_post = sfincs.SfincsPostprocess(\n",
    "    sfincs_map=sfincs_run.output.sfincs_map,\n",
    ")\n",
    "wf.create_rule(sfincs_post, rule_id=\"sfincs_post\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 15,
   "id": "b2d58768",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.147490Z",
     "iopub.status.busy": "2025-06-18T09:44:36.147171Z",
     "iopub.status.idle": "2025-06-18T09:44:36.152147Z",
     "shell.execute_reply": "2025-06-18T09:44:36.151636Z"
    },
    "papermill": {
     "duration": 0.01022,
     "end_time": "2025-06-18T09:44:36.152931",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.142711",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=sfincs_downscale, method=sfincs_downscale, runs=5, repeat=['events'])"
      ]
     },
     "execution_count": 15,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Optionally, downscale the SFINCS output to derive high-res flood hazard maps\n",
    "sfincs_downscale = sfincs.SfincsDownscale(\n",
    "    sfincs_map=sfincs_run.output.sfincs_map,\n",
    "    sfincs_subgrid_dep=sfincs_build.output.sfincs_subgrid_dep,\n",
    "    depth_min=wf.get_ref(\"$config.depth_min\"),\n",
    "    output_root=\"output/hazard\",\n",
    ")\n",
    "wf.create_rule(sfincs_downscale, rule_id=\"sfincs_downscale\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "2a30dee2",
   "metadata": {
    "papermill": {
     "duration": 0.004087,
     "end_time": "2025-06-18T09:44:36.161185",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.157098",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "## Derive flood risk"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b28584e7",
   "metadata": {
    "papermill": {
     "duration": 0.004018,
     "end_time": "2025-06-18T09:44:36.169244",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.165226",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "To calculate flood risk, we \n",
    "- Update Delft-FIAT with *all fluvial events* which are combined in an event set. This will create a new Delft-FIAT instance for the event set.\n",
    "- Run Delft-FIAT to calculate flood impact and risk. This will create impact and risk data at the individual and aggregated asset level.\n",
    "- Visualize the risk results at the aggregated asset level.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "id": "c9b16a12",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.177878Z",
     "iopub.status.busy": "2025-06-18T09:44:36.177693Z",
     "iopub.status.idle": "2025-06-18T09:44:36.182418Z",
     "shell.execute_reply": "2025-06-18T09:44:36.181940Z"
    },
    "papermill": {
     "duration": 0.009933,
     "end_time": "2025-06-18T09:44:36.183185",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.173252",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=fiat_update, method=fiat_update_hazard, runs=1, reduce=['events'])"
      ]
     },
     "execution_count": 16,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Update FIAT hazard forcing with the fluvial eventset to compute fluvial flood risk\n",
    "fiat_update = fiat.FIATUpdateHazard(\n",
    "    fiat_cfg=fiat_build.output.fiat_cfg,\n",
    "    event_set_yaml=fluvial_events.output.event_set_yaml,\n",
    "    map_type=\"water_level\",\n",
    "    hazard_maps=sfincs_post.output.sfincs_zsmax,\n",
    "    risk=True,\n",
    "    output_dir=fiat_build.output.fiat_cfg.parent/\"simulations\",\n",
    "    copy_model=True, # Necessary for CWL\n",
    ")\n",
    "wf.create_rule(fiat_update, rule_id=\"fiat_update\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 17,
   "id": "a908d78a",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.192387Z",
     "iopub.status.busy": "2025-06-18T09:44:36.192061Z",
     "iopub.status.idle": "2025-06-18T09:44:36.196041Z",
     "shell.execute_reply": "2025-06-18T09:44:36.195641Z"
    },
    "papermill": {
     "duration": 0.009416,
     "end_time": "2025-06-18T09:44:36.196787",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.187371",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=fiat_run, method=fiat_run, runs=1)"
      ]
     },
     "execution_count": 17,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Run FIAT to compute pluvial flood risk\n",
    "fiat_run = fiat.FIATRun(\n",
    "    fiat_cfg=fiat_update.output.fiat_out_cfg,\n",
    "    run_method=wf.get_ref(\"$config.fiat_run_method\")\n",
    ")\n",
    "wf.create_rule(fiat_run, rule_id=\"fiat_run\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 18,
   "id": "791cf7fd",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.206026Z",
     "iopub.status.busy": "2025-06-18T09:44:36.205681Z",
     "iopub.status.idle": "2025-06-18T09:44:36.210035Z",
     "shell.execute_reply": "2025-06-18T09:44:36.209533Z"
    },
    "papermill": {
     "duration": 0.009672,
     "end_time": "2025-06-18T09:44:36.210696",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.201024",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Rule(id=fiat_visualize, method=fiat_visualize, runs=1)"
      ]
     },
     "execution_count": 18,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Visualize Fiat \n",
    "fiat_visualize = fiat.FIATVisualize(\n",
    "    fiat_cfg=fiat_update.output.fiat_out_cfg,\n",
    "    fiat_output_csv=fiat_run.output.fiat_out_csv,\n",
    "    spatial_joins_cfg=fiat_build.output.spatial_joins_cfg,\n",
    "    output_dir=\"output/risk\"\n",
    ")\n",
    "wf.create_rule(fiat_visualize, rule_id=\"fiat_visualize\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d57a5fb9",
   "metadata": {
    "papermill": {
     "duration": 0.004295,
     "end_time": "2025-06-18T09:44:36.219340",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.215045",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "## Visualize and execute the workflow\n",
    "\n",
    "To inspect the workflow we can plot the rulegraph which shows all rules their dependencies.\n",
    "The nodes are colored based on the type, for instance the red nodes show the result rules."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 19,
   "id": "ee37fcc0",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.228812Z",
     "iopub.status.busy": "2025-06-18T09:44:36.228401Z",
     "iopub.status.idle": "2025-06-18T09:44:36.262956Z",
     "shell.execute_reply": "2025-06-18T09:44:36.262444Z"
    },
    "papermill": {
     "duration": 0.04002,
     "end_time": "2025-06-18T09:44:36.263654",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.223634",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "data": {
      "image/svg+xml": [
       "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n",
       "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\"\n",
       " \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n",
       "<!-- Generated by graphviz version 12.2.1 (20250203.1708)\n",
       " -->\n",
       "<!-- Title: fluvial_risk Pages: 1 -->\n",
       "<svg width=\"412pt\" height=\"804pt\"\n",
       " viewBox=\"0.00 0.00 412.00 804.00\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n",
       "<g id=\"graph0\" class=\"graph\" transform=\"scale(1 1) rotate(0) translate(4 800)\">\n",
       "<title>fluvial_risk</title>\n",
       "<polygon fill=\"white\" stroke=\"none\" points=\"-4,4 -4,-800 408,-800 408,4 -4,4\"/>\n",
       "<!-- sfincs_build -->\n",
       "<g id=\"node1\" class=\"node\">\n",
       "<title>sfincs_build</title>\n",
       "<path fill=\"none\" stroke=\"black\" stroke-width=\"2\" d=\"M218,-796C218,-796 154,-796 154,-796 148,-796 142,-790 142,-784 142,-784 142,-772 142,-772 142,-766 148,-760 154,-760 154,-760 218,-760 218,-760 224,-760 230,-766 230,-772 230,-772 230,-784 230,-784 230,-790 224,-796 218,-796\"/>\n",
       "<text text-anchor=\"start\" x=\"150\" y=\"-779.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">sfincs_build</text>\n",
       "<text text-anchor=\"start\" x=\"165\" y=\"-767.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- fiat_build -->\n",
       "<g id=\"node2\" class=\"node\">\n",
       "<title>fiat_build</title>\n",
       "<path fill=\"none\" stroke=\"black\" stroke-width=\"2\" d=\"M64,-264C64,-264 12,-264 12,-264 6,-264 0,-258 0,-252 0,-252 0,-240 0,-240 0,-234 6,-228 12,-228 12,-228 64,-228 64,-228 70,-228 76,-234 76,-240 76,-240 76,-252 76,-252 76,-258 70,-264 64,-264\"/>\n",
       "<text text-anchor=\"start\" x=\"8\" y=\"-247.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">fiat_build</text>\n",
       "<text text-anchor=\"start\" x=\"17\" y=\"-235.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- sfincs_build&#45;&gt;fiat_build -->\n",
       "<g id=\"edge1\" class=\"edge\">\n",
       "<title>sfincs_build&#45;&gt;fiat_build</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M144.77,-759.01C100.98,-736.78 38,-694.47 38,-635 38,-635 38,-635 38,-405 38,-360.56 38,-309.08 38,-277.28\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"41.5,-277.56 38,-267.56 34.5,-277.56 41.5,-277.56\"/>\n",
       "</g>\n",
       "<!-- wflow_build -->\n",
       "<g id=\"node3\" class=\"node\">\n",
       "<title>wflow_build</title>\n",
       "<path fill=\"none\" stroke=\"black\" stroke-width=\"2\" d=\"M175,-724C175,-724 117,-724 117,-724 111,-724 105,-718 105,-712 105,-712 105,-700 105,-700 105,-694 111,-688 117,-688 117,-688 175,-688 175,-688 181,-688 187,-694 187,-700 187,-700 187,-712 187,-712 187,-718 181,-724 175,-724\"/>\n",
       "<text text-anchor=\"start\" x=\"113\" y=\"-707.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">wflow_build</text>\n",
       "<text text-anchor=\"start\" x=\"125\" y=\"-695.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- sfincs_build&#45;&gt;wflow_build -->\n",
       "<g id=\"edge2\" class=\"edge\">\n",
       "<title>sfincs_build&#45;&gt;wflow_build</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M175.91,-759.34C171.86,-752.26 167.1,-743.92 162.57,-736\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"165.73,-734.48 157.73,-727.53 159.65,-737.95 165.73,-734.48\"/>\n",
       "</g>\n",
       "<!-- sfincs_update -->\n",
       "<g id=\"node7\" class=\"node\">\n",
       "<title>sfincs_update</title>\n",
       "<path fill=\"none\" stroke=\"purple\" stroke-width=\"2\" d=\"M259,-428C259,-428 159,-428 159,-428 153,-428 147,-422 147,-416 147,-416 147,-396 147,-396 147,-390 153,-384 159,-384 159,-384 259,-384 259,-384 265,-384 271,-390 271,-396 271,-396 271,-416 271,-416 271,-422 265,-428 259,-428\"/>\n",
       "<text text-anchor=\"start\" x=\"170\" y=\"-413.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">sfincs_update</text>\n",
       "<text text-anchor=\"start\" x=\"188\" y=\"-401.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=5</text>\n",
       "<text text-anchor=\"start\" x=\"155\" y=\"-389.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> repeat=[&#39;events&#39;]</text>\n",
       "</g>\n",
       "<!-- sfincs_build&#45;&gt;sfincs_update -->\n",
       "<g id=\"edge6\" class=\"edge\">\n",
       "<title>sfincs_build&#45;&gt;sfincs_update</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M192.63,-759.36C202,-732.79 218,-680.74 218,-635 218,-635 218,-635 218,-561 218,-519.94 214.77,-472.83 212.18,-441.64\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"215.69,-441.59 211.35,-431.92 208.72,-442.19 215.69,-441.59\"/>\n",
       "</g>\n",
       "<!-- sfincs_downscale -->\n",
       "<g id=\"node9\" class=\"node\">\n",
       "<title>sfincs_downscale</title>\n",
       "<path fill=\"none\" stroke=\"red\" stroke-width=\"2\" d=\"M392,-268C392,-268 292,-268 292,-268 286,-268 280,-262 280,-256 280,-256 280,-236 280,-236 280,-230 286,-224 292,-224 292,-224 392,-224 392,-224 398,-224 404,-230 404,-236 404,-236 404,-256 404,-256 404,-262 398,-268 392,-268\"/>\n",
       "<text text-anchor=\"start\" x=\"294\" y=\"-253.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">sfincs_downscale</text>\n",
       "<text text-anchor=\"start\" x=\"321\" y=\"-241.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=5</text>\n",
       "<text text-anchor=\"start\" x=\"288\" y=\"-229.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> repeat=[&#39;events&#39;]</text>\n",
       "</g>\n",
       "<!-- sfincs_build&#45;&gt;sfincs_downscale -->\n",
       "<g id=\"edge9\" class=\"edge\">\n",
       "<title>sfincs_build&#45;&gt;sfincs_downscale</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M221.21,-759.2C260.91,-736.34 320,-692.62 320,-635 320,-635 320,-635 320,-405 320,-362.11 328.05,-313.28 334.41,-281.41\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"337.8,-282.31 336.4,-271.81 330.94,-280.9 337.8,-282.31\"/>\n",
       "</g>\n",
       "<!-- fiat_update -->\n",
       "<g id=\"node11\" class=\"node\">\n",
       "<title>fiat_update</title>\n",
       "<path fill=\"none\" stroke=\"green\" stroke-width=\"2\" d=\"M166,-188C166,-188 66,-188 66,-188 60,-188 54,-182 54,-176 54,-176 54,-156 54,-156 54,-150 60,-144 66,-144 66,-144 166,-144 166,-144 172,-144 178,-150 178,-156 178,-156 178,-176 178,-176 178,-182 172,-188 166,-188\"/>\n",
       "<text text-anchor=\"start\" x=\"83\" y=\"-173.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">fiat_update</text>\n",
       "<text text-anchor=\"start\" x=\"95\" y=\"-161.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "<text text-anchor=\"start\" x=\"62\" y=\"-149.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> reduce=[&#39;events&#39;]</text>\n",
       "</g>\n",
       "<!-- fiat_build&#45;&gt;fiat_update -->\n",
       "<g id=\"edge12\" class=\"edge\">\n",
       "<title>fiat_build&#45;&gt;fiat_update</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M55.7,-227.3C64.44,-218.56 75.24,-207.76 85.27,-197.73\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"87.46,-200.49 92.05,-190.95 82.51,-195.54 87.46,-200.49\"/>\n",
       "</g>\n",
       "<!-- fiat_visualize -->\n",
       "<g id=\"node13\" class=\"node\">\n",
       "<title>fiat_visualize</title>\n",
       "<path fill=\"none\" stroke=\"red\" stroke-width=\"2\" d=\"M102,-36C102,-36 26,-36 26,-36 20,-36 14,-30 14,-24 14,-24 14,-12 14,-12 14,-6 20,0 26,0 26,0 102,0 102,0 108,0 114,-6 114,-12 114,-12 114,-24 114,-24 114,-30 108,-36 102,-36\"/>\n",
       "<text text-anchor=\"start\" x=\"22\" y=\"-19.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">fiat_visualize</text>\n",
       "<text text-anchor=\"start\" x=\"43\" y=\"-7.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- fiat_build&#45;&gt;fiat_visualize -->\n",
       "<g id=\"edge16\" class=\"edge\">\n",
       "<title>fiat_build&#45;&gt;fiat_visualize</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M38.8,-227.08C39.8,-206.86 41.8,-173 45,-144 48.58,-111.6 54.4,-74.73 58.66,-49.47\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"62.09,-50.17 60.33,-39.73 55.19,-48.99 62.09,-50.17\"/>\n",
       "</g>\n",
       "<!-- wflow_update -->\n",
       "<g id=\"node4\" class=\"node\">\n",
       "<title>wflow_update</title>\n",
       "<path fill=\"none\" stroke=\"black\" stroke-width=\"2\" d=\"M168,-652C168,-652 104,-652 104,-652 98,-652 92,-646 92,-640 92,-640 92,-628 92,-628 92,-622 98,-616 104,-616 104,-616 168,-616 168,-616 174,-616 180,-622 180,-628 180,-628 180,-640 180,-640 180,-646 174,-652 168,-652\"/>\n",
       "<text text-anchor=\"start\" x=\"100\" y=\"-635.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">wflow_update</text>\n",
       "<text text-anchor=\"start\" x=\"115\" y=\"-623.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- wflow_build&#45;&gt;wflow_update -->\n",
       "<g id=\"edge3\" class=\"edge\">\n",
       "<title>wflow_build&#45;&gt;wflow_update</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M143.48,-687.34C142.54,-680.75 141.44,-673.08 140.38,-665.67\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"143.86,-665.3 138.99,-655.9 136.93,-666.29 143.86,-665.3\"/>\n",
       "</g>\n",
       "<!-- wflow_run -->\n",
       "<g id=\"node5\" class=\"node\">\n",
       "<title>wflow_run</title>\n",
       "<path fill=\"none\" stroke=\"black\" stroke-width=\"2\" d=\"M154,-580C154,-580 108,-580 108,-580 102,-580 96,-574 96,-568 96,-568 96,-556 96,-556 96,-550 102,-544 108,-544 108,-544 154,-544 154,-544 160,-544 166,-550 166,-556 166,-556 166,-568 166,-568 166,-574 160,-580 154,-580\"/>\n",
       "<text text-anchor=\"start\" x=\"104\" y=\"-563.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">wflow_run</text>\n",
       "<text text-anchor=\"start\" x=\"110\" y=\"-551.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- wflow_update&#45;&gt;wflow_run -->\n",
       "<g id=\"edge4\" class=\"edge\">\n",
       "<title>wflow_update&#45;&gt;wflow_run</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M134.74,-615.34C134.27,-608.75 133.72,-601.08 133.19,-593.67\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"136.7,-593.65 132.49,-583.92 129.72,-594.15 136.7,-593.65\"/>\n",
       "</g>\n",
       "<!-- fluvial_events -->\n",
       "<g id=\"node6\" class=\"node\">\n",
       "<title>fluvial_events</title>\n",
       "<path fill=\"none\" stroke=\"blue\" stroke-width=\"2\" d=\"M178,-508C178,-508 78,-508 78,-508 72,-508 66,-502 66,-496 66,-496 66,-476 66,-476 66,-470 72,-464 78,-464 78,-464 178,-464 178,-464 184,-464 190,-470 190,-476 190,-476 190,-496 190,-496 190,-502 184,-508 178,-508\"/>\n",
       "<text text-anchor=\"start\" x=\"86\" y=\"-493.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">fluvial_events</text>\n",
       "<text text-anchor=\"start\" x=\"107\" y=\"-481.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "<text text-anchor=\"start\" x=\"74\" y=\"-469.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> expand=[&#39;events&#39;]</text>\n",
       "</g>\n",
       "<!-- wflow_run&#45;&gt;fluvial_events -->\n",
       "<g id=\"edge5\" class=\"edge\">\n",
       "<title>wflow_run&#45;&gt;fluvial_events</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M130.27,-543.09C130.01,-536.67 129.71,-529.2 129.41,-521.84\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"132.92,-521.85 129.01,-512 125.92,-522.14 132.92,-521.85\"/>\n",
       "</g>\n",
       "<!-- fluvial_events&#45;&gt;sfincs_update -->\n",
       "<g id=\"edge7\" class=\"edge\">\n",
       "<title>fluvial_events&#45;&gt;sfincs_update</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M150.56,-463.27C158.74,-455.39 168.15,-446.34 176.99,-437.82\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"179.32,-440.44 184.1,-430.98 174.47,-435.4 179.32,-440.44\"/>\n",
       "</g>\n",
       "<!-- fluvial_events&#45;&gt;fiat_update -->\n",
       "<g id=\"edge13\" class=\"edge\">\n",
       "<title>fluvial_events&#45;&gt;fiat_update</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M127.18,-463.14C125.12,-408.78 119.78,-267.11 117.3,-201.4\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"120.8,-201.48 116.93,-191.61 113.81,-201.74 120.8,-201.48\"/>\n",
       "</g>\n",
       "<!-- sfincs_run -->\n",
       "<g id=\"node8\" class=\"node\">\n",
       "<title>sfincs_run</title>\n",
       "<path fill=\"none\" stroke=\"purple\" stroke-width=\"2\" d=\"M259,-348C259,-348 159,-348 159,-348 153,-348 147,-342 147,-336 147,-336 147,-316 147,-316 147,-310 153,-304 159,-304 159,-304 259,-304 259,-304 265,-304 271,-310 271,-316 271,-316 271,-336 271,-336 271,-342 265,-348 259,-348\"/>\n",
       "<text text-anchor=\"start\" x=\"179\" y=\"-333.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">sfincs_run</text>\n",
       "<text text-anchor=\"start\" x=\"188\" y=\"-321.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=5</text>\n",
       "<text text-anchor=\"start\" x=\"155\" y=\"-309.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> repeat=[&#39;events&#39;]</text>\n",
       "</g>\n",
       "<!-- sfincs_update&#45;&gt;sfincs_run -->\n",
       "<g id=\"edge8\" class=\"edge\">\n",
       "<title>sfincs_update&#45;&gt;sfincs_run</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M209,-383.27C209,-376.57 209,-369.01 209,-361.66\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"212.5,-361.91 209,-351.91 205.5,-361.91 212.5,-361.91\"/>\n",
       "</g>\n",
       "<!-- sfincs_run&#45;&gt;sfincs_downscale -->\n",
       "<g id=\"edge10\" class=\"edge\">\n",
       "<title>sfincs_run&#45;&gt;sfincs_downscale</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M246.4,-303.07C261.12,-294.44 278.2,-284.42 293.82,-275.26\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"295.41,-278.38 302.27,-270.3 291.87,-272.34 295.41,-278.38\"/>\n",
       "</g>\n",
       "<!-- sfincs_post -->\n",
       "<g id=\"node10\" class=\"node\">\n",
       "<title>sfincs_post</title>\n",
       "<path fill=\"none\" stroke=\"purple\" stroke-width=\"2\" d=\"M250,-268C250,-268 150,-268 150,-268 144,-268 138,-262 138,-256 138,-256 138,-236 138,-236 138,-230 144,-224 150,-224 150,-224 250,-224 250,-224 256,-224 262,-230 262,-236 262,-236 262,-256 262,-256 262,-262 256,-268 250,-268\"/>\n",
       "<text text-anchor=\"start\" x=\"167\" y=\"-253.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">sfincs_post</text>\n",
       "<text text-anchor=\"start\" x=\"179\" y=\"-241.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=5</text>\n",
       "<text text-anchor=\"start\" x=\"146\" y=\"-229.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> repeat=[&#39;events&#39;]</text>\n",
       "</g>\n",
       "<!-- sfincs_run&#45;&gt;sfincs_post -->\n",
       "<g id=\"edge11\" class=\"edge\">\n",
       "<title>sfincs_run&#45;&gt;sfincs_post</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M206.49,-303.27C205.72,-296.57 204.85,-289.01 204,-281.66\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"207.5,-281.42 202.87,-271.89 200.54,-282.22 207.5,-281.42\"/>\n",
       "</g>\n",
       "<!-- sfincs_post&#45;&gt;fiat_update -->\n",
       "<g id=\"edge14\" class=\"edge\">\n",
       "<title>sfincs_post&#45;&gt;fiat_update</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M176.6,-223.27C168.03,-215.31 158.15,-206.14 148.9,-197.55\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"151.49,-195.18 141.78,-190.94 146.73,-200.31 151.49,-195.18\"/>\n",
       "</g>\n",
       "<!-- fiat_run -->\n",
       "<g id=\"node12\" class=\"node\">\n",
       "<title>fiat_run</title>\n",
       "<path fill=\"none\" stroke=\"black\" stroke-width=\"2\" d=\"M144,-108C144,-108 104,-108 104,-108 98,-108 92,-102 92,-96 92,-96 92,-84 92,-84 92,-78 98,-72 104,-72 104,-72 144,-72 144,-72 150,-72 156,-78 156,-84 156,-84 156,-96 156,-96 156,-102 150,-108 144,-108\"/>\n",
       "<text text-anchor=\"start\" x=\"100\" y=\"-91.6\" font-family=\"Courier,monospace\" font-weight=\"bold\" font-size=\"12.00\">fiat_run</text>\n",
       "<text text-anchor=\"start\" x=\"103\" y=\"-79.6\" font-family=\"Courier,monospace\" font-size=\"12.00\"> runs=1</text>\n",
       "</g>\n",
       "<!-- fiat_update&#45;&gt;fiat_run -->\n",
       "<g id=\"edge15\" class=\"edge\">\n",
       "<title>fiat_update&#45;&gt;fiat_run</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M118.36,-143.2C119.09,-136.46 119.9,-128.91 120.68,-121.69\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"124.14,-122.24 121.74,-111.92 117.18,-121.49 124.14,-122.24\"/>\n",
       "</g>\n",
       "<!-- fiat_update&#45;&gt;fiat_visualize -->\n",
       "<g id=\"edge17\" class=\"edge\">\n",
       "<title>fiat_update&#45;&gt;fiat_visualize</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M101.13,-143.07C94.74,-132.8 87.68,-120.16 83,-108 75.75,-89.18 71.01,-66.99 68.07,-49.48\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"71.57,-49.21 66.59,-39.86 64.65,-50.27 71.57,-49.21\"/>\n",
       "</g>\n",
       "<!-- fiat_run&#45;&gt;fiat_visualize -->\n",
       "<g id=\"edge18\" class=\"edge\">\n",
       "<title>fiat_run&#45;&gt;fiat_visualize</title>\n",
       "<path fill=\"none\" stroke=\"grey\" stroke-width=\"2\" d=\"M108.86,-71.34C102.44,-63.85 94.81,-54.95 87.68,-46.63\"/>\n",
       "<polygon fill=\"grey\" stroke=\"grey\" stroke-width=\"2\" points=\"90.48,-44.51 81.31,-39.2 85.16,-49.07 90.48,-44.51\"/>\n",
       "</g>\n",
       "</g>\n",
       "</svg>\n"
      ],
      "text/plain": [
       "<graphviz.graphs.Digraph at 0x7f47fa10b910>"
      ]
     },
     "execution_count": 19,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# plot the rulegraph using graphviz\n",
    "wf.plot_rulegraph(filename=\"rulegraph.svg\", plot_rule_attrs=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 20,
   "id": "53164744",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.273922Z",
     "iopub.status.busy": "2025-06-18T09:44:36.273515Z",
     "iopub.status.idle": "2025-06-18T09:44:36.284158Z",
     "shell.execute_reply": "2025-06-18T09:44:36.283672Z"
    },
    "papermill": {
     "duration": 0.016462,
     "end_time": "2025-06-18T09:44:36.284871",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.268409",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 1/13: sfincs_build (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 2/13: fiat_build (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 3/13: wflow_build (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 4/13: wflow_update (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 5/13: wflow_run (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 6/13: fluvial_events (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 7/13: sfincs_update (5 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 8/13: sfincs_run (5 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 9/13: sfincs_downscale (5 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 10/13: sfincs_post (5 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 11/13: fiat_update (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 12/13: fiat_run (1 runs)\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO - workflow - Dryrun rule 13/13: fiat_visualize (1 runs)\n"
     ]
    }
   ],
   "source": [
    "# dryrun workflow. Make sure no warnings are raised\n",
    "wf.dryrun()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e69bfcbf",
   "metadata": {
    "papermill": {
     "duration": 0.004981,
     "end_time": "2025-06-18T09:44:36.295051",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.290070",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "The workflow can be executed using HydroFlows or a workflow engine. \n",
    "To run the workflow in HydroFlows use ``wf.run()``. \n",
    "To run the workflow with SnakeMake (preferred) use ``wf.to_snakemake()`` to create a snakemake file, see below.\n",
    "You can then use the Snakemake CLI to execute the workflow, see the [snakemake documentation](https://snakemake.readthedocs.io/en/stable/executing/cli.html)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 21,
   "id": "30987400",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.306094Z",
     "iopub.status.busy": "2025-06-18T09:44:36.305733Z",
     "iopub.status.idle": "2025-06-18T09:44:36.322028Z",
     "shell.execute_reply": "2025-06-18T09:44:36.321573Z"
    },
    "papermill": {
     "duration": 0.022638,
     "end_time": "2025-06-18T09:44:36.322737",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.300099",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "cases/fluvial_risk:\n",
      "- Snakefile\n",
      "- rulegraph.svg\n",
      "- Snakefile.config.yml\n"
     ]
    }
   ],
   "source": [
    "# Write the workflow to a Snakefile and snakefile.config.yml\n",
    "wf.to_snakemake()\n",
    "\n",
    "# show the files in the case directory\n",
    "print(f\"{wf.root.relative_to(pwd)}:\")\n",
    "for f in wf.root.iterdir():\n",
    "    print(f\"- {f.name}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 22,
   "id": "54d88fc1",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.333563Z",
     "iopub.status.busy": "2025-06-18T09:44:36.333404Z",
     "iopub.status.idle": "2025-06-18T09:44:36.335756Z",
     "shell.execute_reply": "2025-06-18T09:44:36.335359Z"
    },
    "papermill": {
     "duration": 0.008503,
     "end_time": "2025-06-18T09:44:36.336473",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.327970",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# uncomment to run the workflow\n",
    "# import subprocess\n",
    "# subprocess.run([\"snakemake\", \"-c\", \"1\"], cwd=wf.root)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 23,
   "id": "368c19f1",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.347294Z",
     "iopub.status.busy": "2025-06-18T09:44:36.346979Z",
     "iopub.status.idle": "2025-06-18T09:44:36.388973Z",
     "shell.execute_reply": "2025-06-18T09:44:36.388455Z"
    },
    "papermill": {
     "duration": 0.048088,
     "end_time": "2025-06-18T09:44:36.389657",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.341569",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# Write the workflow to a cwl file and cwl config file\n",
    "wf.to_cwl()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 24,
   "id": "2e34b93d",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-06-18T09:44:36.400522Z",
     "iopub.status.busy": "2025-06-18T09:44:36.400263Z",
     "iopub.status.idle": "2025-06-18T09:44:36.402679Z",
     "shell.execute_reply": "2025-06-18T09:44:36.402201Z"
    },
    "papermill": {
     "duration": 0.008554,
     "end_time": "2025-06-18T09:44:36.403347",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.394793",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": [
    "# uncomment to run the workflow with cwll\n",
    "# cwltool does not by default preserve environment variables. This causes issues when running Delft-FIAT.\n",
    "# Hence the extra flag to explicitly tell cwltool to preserve the PROJ_DATA environment variable\n",
    "# import subprocess\n",
    "# subprocess.run([\"cwltool\", \"--preserve-environment\", \"PROJ_DATA\", f\"{wf.name}.cwl\", f\"{wf.name}.config.yml\"], cwd=wf.root)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e96c4d9f",
   "metadata": {
    "papermill": {
     "duration": 0.005091,
     "end_time": "2025-06-18T09:44:36.413679",
     "exception": false,
     "start_time": "2025-06-18T09:44:36.408588",
     "status": "completed"
    },
    "tags": []
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "full",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.12"
  },
  "papermill": {
   "default_parameters": {},
   "duration": 5.949837,
   "end_time": "2025-06-18T09:44:37.234992",
   "environment_variables": {},
   "exception": null,
   "input_path": "/home/runner/work/HydroFlows/HydroFlows/docs/../examples/fluvial_risk.ipynb",
   "output_path": "/home/runner/work/HydroFlows/HydroFlows/docs/_examples/fluvial_risk.ipynb",
   "parameters": {},
   "start_time": "2025-06-18T09:44:31.285155",
   "version": "2.6.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}