Welcome to the Coastal Hazards Toolkit’s documentation!

The Deltares Coastal Hazards Toolkit is a package of open-source Python modules used for modelling and data analysis of coastal environments. It contains scripts for generating model inputs, importing bathymetry data, creating web tile layers, and much more.

• Index

• Module Index

• Search Page

Installation

In order to use the Coastal Hazards Toolkit, you’ll first need to install the package using pip:

pip install deltares-coastalhazardstoolkit

or alternatively, if you have an OpenEarth account and checkout folder, install it as an editable package:

cd OpenEarthTools/trunk/python/applications/coastalhazardstoolkit/trunk
pip install -e .

• Bathymetry Database
  • Getting started
  • Importing bathymetry
  • Obtaining a list of available datasets
  • Obtaining meta-data for a dataset
  • Module
  • Classes
  • Functions
• Meteo Database
  • Setting the database path
  • Import dataset
  • Obtaining a list of available datasets
  • Obtaining dataset meta-data
• Web Tile Layers
  • Generating PNG web tiles
  • Generating topography tiles
  • Classes
• Tropical Cyclones
  • Importing a cyclone track
  • Building a spiderweb file
  • Building a track ensemble
• Nesting
  • Nesting Step 1
  • Nesting Step 2
• Delft3D-FM
  • Building a Delft3D-FM model
• SFINCS
  • Building a SFINCS model
• XBeach
  • Building an XBeach model
• HurryWave
  • Building a HurryWave model