Examples#

This folder contains several iPython notebook examples for HydroMT-SFINCS.

These examples can be run online or on your local machine. To run these examples online press the binder badge above.

Local installation#

To run these examples on your local machine you need a copy of the examples folder of the repository and an installation of HydroMT-SFINCS including some additional packages required to run the notebooks.

1 - Install HydroMT-wflow#

The first step is to install HydroMT-SFINCS and the other Python dependencies in a separate environment, see the Install HydroMT-SFINCS in a new environment section in the installation guide

2 - Download the content of the HydroMT github repository#

To run the examples locally, you will need to download the content of the examples folder in the HydroMT-SFINCS repository. You can do a manual download and extract the content of the downloaded ZIP folder or clone the repository locally (this requires git):

$ git clone https://github.com/Deltares/hydromt_sfincs.git

3 - Running the examples#

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

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

$ conda activate hydromt-sfincs
$ cd hydromt-sfincs/examples
$ jupyter lab

List of examples#

For a static (non-interactive) view of the examples follow one of the links below:

Build and update a model (simple) using Command Line Interface (CLI)

Build from CLI

Build a model (advanced) using Python scripts

Build from Script

Run a SFINCS model:

Run a SFINCS model

Postprocessing and visualization