Skip to main content

hydroMT plugin for sfincs models.

Project description

Latest PyPI version conda_forge Latest developers docs Stable docs last release codecov License Zenodo binder

What is the HydroMT-SFINCS plugin?

HydroMT (Hydro Model Tools) is an open-source Python package that facilitates the process of building and analyzing spatial geoscientific models with a focus on water system models. It does so by automating the workflow to go from raw data to a complete model instance which is ready to run and to analyse model results once the simulation has finished. This plugin provides an implementation of the model API for the SFINCS model.

What is SFINCS?

SFINCS is Deltares’ new open-source reduced-complexity model designed for super-fast modelling of compound flooding events in a dynamic way! What HydroMT-SFINCS does provide is a powerful Python based set of tools to help you build and analyse the best possible SFINCS models! This HydroMT-SFINCS plugin does not include the SFINCS model or executable itself, for that see the SFINCS download portal or the source code repository on Github. For general documentation about the model, how to run it and what the input files are see the SFINCS documentation.

Why HydroMT-SFINCS?

Setting up hydrodynamic models typically requires many (manual) steps to process input data and might therefore be time consuming and hard to reproduce. Especially improving models based on global geospatial datasets, which are rapidly becoming available at increasingly high resolutions, might be challenging. HydroMT-SFINCS aims to make the model building process fast, modular and reproducible and to facilitate the analysis of SFINCS model results

How to use HydroMT-SFINCS?

The HydroMT-SFINCS plugin can be used as a command line + configuration file application, which provides commands to build, update the SFINCS model with a single line, or from python to exploit its rich interface. You can learn more about how to use HydroMT-SFINCS in its online documentation. For a smooth installing experience we recommend installing HydroMT-SFINCS and its dependencies from conda-forge in a clean environment, see installation guide.

How to cite?

To reference the software please use the the DOI provided in the Zenodo badge that points to the latest release Zenodo.

The following paper presents a real-world application of HydroMT-SFINCS:

Eilander, D., Couasnon, A., Leijnse, T., Ikeuchi, H., Yamazaki, D., Muis, S., Dullaart, J., Haag, A., Winsemius, H. C., and Ward, P. J.: A globally applicable framework for compound flood hazard modeling, Nat. Hazards Earth Syst. Sci., 23, 823–846, https://doi.org/10.5194/nhess-23-823-2023, 2023.

How to contribute?

If you find any issues in the code or documentation feel free to leave an issue on the github issue tracker. You can find information about how to contribute to the HydroMT project at our contributing page.

HydroMT seeks active contribution from the (hydro) geoscientific community. So far, it has been developed and tested with a range of Deltares models, but we believe it is applicable to a much wider set of geoscientific models and are happy to discuss how it can be implemented for your model.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hydromt_sfincs-1.2.0.tar.gz (110.3 kB view details)

Uploaded Source

Built Distribution

hydromt_sfincs-1.2.0-py3-none-any.whl (115.2 kB view details)

Uploaded Python 3

File details

Details for the file hydromt_sfincs-1.2.0.tar.gz.

File metadata

  • Download URL: hydromt_sfincs-1.2.0.tar.gz
  • Upload date:
  • Size: 110.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for hydromt_sfincs-1.2.0.tar.gz
Algorithm Hash digest
SHA256 749df2d06197ed6d490b717564cd53745547a1b5a89af3258451063aaec8dd51
MD5 90827f53524de5448835d46eccff9510
BLAKE2b-256 c980984f72a8f9fc8270643a56b016a951e397e336c458931d521eb4e829f5dd

See more details on using hashes here.

File details

Details for the file hydromt_sfincs-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: hydromt_sfincs-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 115.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for hydromt_sfincs-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16513b54e61c28df785f9c072164e6f4710bd3660c166915e1483a94b2cdd2f1
MD5 5021db91855d3fde159b7de901c60b62
BLAKE2b-256 58ad4648af4a544f809d2b15cc7a002c3cf6613ff08e343dbe90d42210031849

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page