pyCoastal 0.2.0

A Python toolbox for coastal, port and ocean engineering. A wave record becomes a design condition, the design condition sizes a structure, and the structure comes out as a dimensioned drawing with its quantities and notes. Every relation names its source and states its range of validity.

Install

pip install pyCoastal            # PyPI
pip install -e ".[dev]"          # from a clone, with tests and plotting

Quick start

from pyCoastal.applications.structures import DesignConditions
from pyCoastal.applications.seawall import design_seawall
from pyCoastal.applications.sections import seawall_sheet

conditions = DesignConditions.from_peak_period(Hm0=2.8, Tp=9.5, depth=8.5)
wall = design_seawall(conditions, still_water_level=2.9, seabed_level=-5.6)
print(wall.summary())
seawall_sheet(wall, size="A3").save("seawall.png")

What is inside

PyCoaTools (webapp/index.html) runs the design modules in the browser. PyCoaPedia is the knowledge base of the coastal and ocean engineering literature, every claim with its regime and DOI: browse it in webapp/pedia.html, query it with python -m pyCoastal.pedia search "...", or read pedia/.

Documentation

• For people: pyCoastal manual.pdf, built from docs/manual/ with python docs/manual/build_manual.py.
• For AI agents: AGENTS.md and llms.txt, the Markdown API reference in docs/reference/, and the PyCoaPedia SQLite database (pedia/SCHEMA.md).

Citation

Biondi, S. (2025). pyCoastal: a Python package for Coastal Engineering, v0.2.0. https://github.com/stebiondi/pyCoastal

MIT License. Copyright (c) 2025 Stefano Biondi.