Skip to content

Deltares/Delft3D

Repository files navigation

Delft3D

This Delft3D repository contains the source code of the simulation engines of the Delft3D 4 and Delft3D Flexible Mesh Suites developed by Deltares. Both modelling suites can be used for the coastal, estuarine, river, rural and urban applications. The Delft3D 4 Suite supports only structured grids. Its successor, the Delft3D FM Suite, allows for unstructured grids including 1D networks. The simulation engines cover hydrodynamics (D-Flow FM, Delft3D-FLOW), hydrology (D-Hydrology), real-time control (D-Real Time Control), morphodynamics (D-Morphology), waves (D-Waves, Delft3D-WAVE), water quality (D-Water Quality, Delft3D-WAQ) and particle tracking (Delft3D-PART).

Delft3D logo

Documentation

For a description of the functionality included in the various components, please check the nightly draft builds of our Delft3D 4 manuals and Delft3D FM manuals.

Examples, tutorials and training

Most manuals (see documentation above) include a "Getting started" and/or "Tutorial" chapter. This repository includes a few example input files for the various simulation engines. Furthermore, we organize various online and in-person Delft3D courses throughout the year. The latest overview of scheduled Deltares courses is available on the Deltares academy website.

Support packages

If you are interested in using these products, and do not (yet) want to compile or contribute to the development, then check out the following websites for the Delft3D Service Packages (note that these Service Packages cover both Delft3D 4 and Delft3D FM):

and contact our sales services team: https://www.deltares.nl/en/software-and-data/software-sales-and-support-teams

Community support

Clients with Service Packages have access to the support team. For the wider open source community, we recommend the use of the GitHub Discussions tab. Please post questions and suggestions there in the Q&A sections.

Open Source Community

We have community websites for Delft3D 4 and Delft3D FM. Source code repositories for the Delft3D simulation engines (self-reference to this page unless you're looking at a forked version), the MATLAB-based postprocessing package QUICKPLOT, the Python-based pre- and postprocessing packages dfm_tools and hydrolib-core, and our grid generation library MeshKernel.

A set of pre-compiled user interfaces (Windows only) is available for Delft3D 4 after registration on the Deltares software website. See this page for details. A similar package for Delft3D FM is expected to be released in the coming months.

Compilation and development

For information on compiling, testing and development see the development page.

Contributing

If you want to contribute improvements or new features to our codebase, please see the contributing page for information about developer guidelines, code branches and our review process.

License

Most simulation engines are licensed under AGPL-3.0 or GPL-3.0, several utility libraries are licensed under LGPL-2.1, and several third-party packages under their original license. Details are listed in the respective subdirectories or source files.