Metadata-Version: 2.4
Name: deltares_coastal_structures_toolbox
Version: 1.1.0
Summary: A Python toolbox with (empirical) formulas for the design of Coastal Structures.
License-Expression: GPL-3.0-or-later
License-File: AUTHORS.rst
License-File: LICENSE
Author: Joost den Bieman
Author-email: joost.denbieman@deltares.nl
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: deltares-wave-toolbox (>=1.1.0,<2.0.0)
Requires-Dist: matplotlib (>=3.10.0,<4.0.0)
Requires-Dist: numpy (>=2.2.3,<3.0.0)
Requires-Dist: pandas (>=2.3.1,<3.0.0)
Description-Content-Type: text/markdown

# Deltares Coastal Structures Toolbox

The Deltares Coastal Structures Toolbox package implements a large selection of (design) formulas for coastal structures. The intent is to make applying these formulas as easy as possible for the user, so most formulas are implemented in multiple ways to enable the calculation of different variables. When applying the formulas from the toolbox, the validity range of those formulas (where available) is checked and a warning is given when the formula is used outside its validity range (including which variable is out of range). The toolbox contains a significant number of tests to ensure the enduring quality of the implementations.

## How to install the toolbox?

The package is available at pip. To install the package run:

`pip install deltares-coastal-structures-toolbox`

## Where to find information about the Deltares Coastal Structures Toolbox?

See the online manual (https://deltares-coastal-structures-toolbox.readthedocs.io/en) for information about the toolbox. In addition, the examples folder contains scripts with applications of the toolbox and a Jupyter notebook is available in the documentation folder.

## Credits

* Joost den Bieman <joost.denbieman@deltares.nl>
* Ivo van der Werf <ivo.vanderwerf@deltares.nl>

