Skip to content
DewberryPublic
forked from Deltares/SFINCS

About

Super-fast modelling of dynamic compound flooding in Coastal Systems

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

570 Commits

Folders and files

Repository files navigation

SFINCS: Super-Fast INundation of CoastS

Website Latest developers docs Stable docs last release License Zenodo Elsevier

What is SFINCS?

SFINCS is Deltares' new open-source, open-access reduced-complexity model designed for super-fast modelling of compound flooding events in a dynamic way!

Deltares is a not-for-profit independent institute for applied research in the field of water, subsurface and infrastructure.

Why SFINCS?

Compound flooding during extreme events can result in tremendous amounts of property damage and loss of life. Early warning systems and multi-hazard risk analysis can reduce these impacts. However, traditional approaches either do not involve relevant physics or are too computationally expensive to do so for large stretches of coastline. The SFINCS model is a new reduced-complexity engine recently developed by Deltares, that is capable of simulating compound flooding including a high computational efficiency balanced with good accuracy.

Where do I find more information about SFINCS?

For general information see: https://www.deltares.nl/en/software/sfincs/

Find the user manual and more information on: https://sfincs.readthedocs.io/en/latest/

How do I get SFINCS?

Download the latest windows executable here: https://download.deltares.nl/sfincs

Get the Docker of version of SFINCS to run on Mac, Linux or HPC here: https://hub.docker.com/r/deltares/sfincs-cpu

How to cite?

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

The following paper presents the introduction of SFINCS:

Leijnse, T., van Ormondt, M., Nederhoff, K., & van Dongeren, A. (2021). Modeling compound flooding in coastal systems using a computationally efficient reduced-physics solver: Including fluvial, pluvial, tidal, wind- and wave-driven processes. Coastal Engineering, 163, 103796. https://doi.org/10.1016/j.coastaleng.2020.103796

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 SFINCS model at our contributing page.

SFINCS seeks active contribution from the hydro modelling community, so feel free to add something to our docs or model code, or reach out to 'sfincs@deltares.nl'!

How to ask questions to other users?

For the SFINCS model itself, questions to fellow users can be asked in the SFINCS github discussion board section.

Questions to fellow users regarding model building with the Python toolbox HydroMT-SFINCS can be asked in the HydroMT-SFINCS github discussion board section.

Licensing conditions source code?

This source code is available open source under GNU GPL-3.0 license, see attached. This means (summarised, for details always read license):

  • Permissions: Commercial use, Distribution, Modification, Patent use, Private use
  • Conditions: Disclose source, License and copyright notice, Same license (so no distributing closed source versions), State changes
  • Limitations: No liability, no warranty
SFINCS makes use of several third-party codes and libraries, which are subject to their respective licenses:
  • SnapWave (source/src/snapwave/): GNU LGPL-2.1, see source/src/snapwave/LICENSE. Copyright Dano Roelvink / IHE Delft. Parts of the SnapWave code are adapted from XBeach (copyright UNESCO-IHE, Deltares and Delft University). SFINCS-SnapWave comes with modifications of and additions to SnapWave by Deltares (copyright Deltares). The header of each file lists its copyright holders.
  • NetCDF-Fortran 4.6.1 (source/third_party_open/netcdf/netcdf-fortran-4.6.1/): copyright University Corporation for Atmospheric Research/Unidata, BSD-style license, see COPYRIGHT in that folder; the Fortran 2003 interfaces are under Apache-2.0, see F03Interfaces_LICENSE.
  • NetCDF-C 4.9.2 (Windows binaries in source/third_party_open/netcdf/netCDF 4.9.2/): copyright UCAR/Unidata, BSD-style license. These binaries include HDF5, HDF4, zlib, libcurl and libjpeg, each under its own permissive license.
  • TOML-Fortran (source/third_party_open/utils/toml-f/): copyright Sebastian Ehlert, dual-licensed under Apache-2.0 or MIT, see LICENSE-Apache and LICENSE-MIT in that folder.
  • hpsort_eps heapsort (source/third_party_open/utils/hpsort_eps.f90): from EPW / Quantum ESPRESSO, copyright Samuel Poncé, Roxana Margine, Carla Verdi, Feliciano Giustino, Jesse Noffsinger and Brad Malone, GNU GPL.
  • Astronomical tide routines (source/third_party_open/Delft3D/astro.f90): from Delft3D, copyright Stichting Deltares, GNU GPL-3.0.

SnapWave and the other libraries are integrated into SFINCS, which as a whole is distributed under GNU GPL-3.0, as above.

Licensing conditions executables?

The SFINCS pre-compiled executables on Windows and Docker(linux) are available under the conditions as indicated when downloading SFINCS from https://download.deltares.nl/sfincs.

SFINCS is available under Deltares Freeware license without monetary fee, meaning (summarised, for details always read license):
  • Permissions: Commercial use allowed, Research publishing allowed, no distribution, no modification
  • IP, ownership: Deltares owns the copyright to SFINCS Software and the Deltares Software Documentation
  • Conditions: Disclose source, License and copyright notice, Same license (so no distribution of closed source versions), no changes
  • Limitations: No liability, no warranty
  • Support: Deltares will only provide any maintenance and/or support for SFINCS Software as part of separate project and/or a maintenance Agreement as agreed with Deltares
https://user-images.githubusercontent.com/28528822/200898347-d4016571-f3c7-4257-b59c-86aa1e97a699.png

About

Super-fast modelling of dynamic compound flooding in Coastal Systems

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages