Examples#

1 - Install HydroMT-Delft3D FM#

The next step is to install all the python dependencies required to run the notebooks, including HydroMT and HydroMT-Delft3D FM.

If you do not have hydromt-delft3dfm yet installed, first create a new empty environment with the base hydromt installation:

$ conda create -n hydromt-delft3dfm -c conda-forge hydromt

Alternatively, you can also use mamba. Checkout more details in the installation guide.

To run the notebooks, you need to install the examples version of HydroMT Delft3D FM using pip. The examples version installs additional dependencies such as jupyter notebook to run the notebooks, matplotlib to plot etc. It is a more complete installation of hydromt_delft3dfm. To install or update in an existing environment (example hydromt-delft3dfm environment), do:

$ conda activate hydromt-delft3dfm
$ pip install "hydromt_delft3dfm[examples]"

2 - Download the content of the examples and notebooks#

To run the examples locally, you will need to download the content of the hydromt_delft3dfm repository. You have two options:

1. Download and unzip the examples manually

2. Clone the hydromt_delft3dfm GitHub repository

$ hydromt --models

model plugins:
 - dflowfm (hydromt_delft3dfm 0.1.2)
generic models (hydromt 0.9.0)
 - grid_model
 - vector_model
 - mesh_model
 - network_model

In the examples above, we see version 0.1.2 of hydromt_delft3dfm is installed and version 0.9.0 of hydromt.

Option 1: manual download and unzip

To manually download the examples on Windows, do (!replace with your own hydromt_delft3dfm version!):

$ curl https://github.com/Deltares/hydromt_delft3dfm/archive/refs/tags/v0.1.2.zip -O -L
$ tar -xf v0.1.2.zip
$ ren hydromt_delft3dfm-0.1.2 hydromt_delft3dfm

You can also download, unzip and rename manually if you prefer, rather than using the windows command prompt.

Option 2: cloning the hydromt_delft3dfm repository

For git users, you can also get the examples by cloning the hydromt_delft3dfm github repository and checking the version you have installed:

$ git clone https://github.com/Deltares/hydromt_delft3dfm.git
$ git checkout v0.1.2

3 - Running the examples#

Finally, start a jupyter lab server inside the examples folder after activating the hydromt-delft3dfm environment, see below.

Alternatively, you can run the notebooks from Visual Studio Code.

$ conda activate hydromt-delft3dfm
$ cd hydromt_delft3dfm/examples
$ jupyter lab