Skip to main content

A package for the conceptual design of breakwaters

Project description



breakwater: a Python package for the conceptual design of breakwaters

Documentation Status GitHub issues

Date July 2020
Author Sander Winkel
Contact pybreakwater@gmail.com
Master Thesis Developing a design automation tool for the conceptual design of breakwaters
Documentation https://breakwater.readthedocs.io/
License CC-BY-NC-SA 4.0

Purpose

The main goal of breakwater is to support the designer in exploring different types of breakwaters, see Figure 1.1 for a cross section of the breakwater types defined by CIRIA, CUR, CETMEF (2007). The main use case is thus to make a conceptual design of a breakwater using one of the design classes, see Chapter 7 of the documentation. However, because all functions and classes are also available from breakwater.core it is also possible to develop your own design automation script.


Note

Due to the limited time not all breakwater types defined by CIRIA, CUR, CETMEF (2007) could be implemented. Currently only the following structures have been implemented: conventional rubble mound breakwaters with rock and armour units as armour layer, caisson breakwaters and vertically composite breakwaters.

Main Features

breakwater offers the following features to support the designer:

  • Design a rubble mound breakwater with rock or concrete armour units as armour layer, with bw.RockRubbleMound or bw.ConcreteRubbleMound.
  • Design a vertical or vertically composite breakwater with bw.Caisson.
  • Design with an interactive design application by using bw.interactive_design. With this application several parameters can be changed with sliders, to assess the influence of certain parameters on the design and cost.
  • Design multiple breakwaters at ones by using bw.Configurations. With this class multiple breakwater types can be designed at ones, these concepts can than be assess by using a multi-criteria analysis or with the DesignExplorer.
  • Use the functions and classes from breakwater.core to create your own design automation approach. breakwater.core consist of all functions and classes defined in Chapters 8 to 11.

Getting Started

The latest released version is available at the Python package index

pip install breakwater

Alternatively, the source code can be downloaded, or cloned, from the GitHub repository.

python setup.py install

A tutorial of breakwater can be found in Chapter 3 of the documentation. This documentation also provides a full overview of the implemented failure mechanisms, and is thus a full overview of all features of breakwater.

Project details


Release history Release notifications | RSS feed

This version

1.0

Download files

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

Files for breakwater, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size breakwater-1.0-py3-none-any.whl (322.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size breakwater-1.0.tar.gz (288.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page