https://github.com/openearth/xbeach-toolbox

Collection of Python modules for pre- and postprocessing XBeach models and output files
https://github.com/openearth/xbeach-toolbox

coastal modelling morphology numerical sediment-transport storm-surge waves xbeach

Last synced: 4 months ago
JSON representation

Collection of Python modules for pre- and postprocessing XBeach models and output files

• Host: GitHub
• URL: https://github.com/openearth/xbeach-toolbox
• Owner: openearth
• License: gpl-3.0
• Created: 2021-10-11T15:40:51.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2026-01-20T09:56:54.000Z (5 months ago)
• Last Synced: 2026-01-20T19:22:54.034Z (5 months ago)
• Topics: coastal, modelling, morphology, numerical, sediment-transport, storm-surge, waves, xbeach
• Language: Python
• Homepage: https://xbeach-toolbox.readthedocs.io/en/latest/
• Size: 3.69 MB
• Stars: 22
• Watchers: 8
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![ReadTheDocs](http://readthedocs.org/projects/xbeach-toolbox/badge/?version=latest)](http://xbeach-toolbox.readthedocs.io/en/latest/)

[![pytest-py310](https://github.com/openearth/xbeach-toolbox/actions/workflows/pytest-py310.yml/badge.svg?branch=main)](https://github.com/openearth/xbeach-toolbox/actions/workflows/pytest-py310.yml)

[![pylint](https://github.com/openearth/xbeach-toolbox/actions/workflows/pylint.yml/badge.svg?branch=main)](https://github.com/openearth/xbeach-toolbox/actions/workflows/pylint.yml)

[![pypi-upload](https://github.com/openearth/xbeach-toolbox/actions/workflows/pypi-upload.yml/badge.svg?branch=main)](https://github.com/openearth/xbeach-toolbox/actions/workflows/pypi-upload.yml)

# About the xbeach-toolbox

Welcome to the xbeach-toolbox! 

This package contains a set of general tools to setup and postprocess 1D and 2D XBeach models.

The tools have been written in Python, please see the sections below for further instructions.

Information about this package and its contents can also be viewed on: 

https://xbeach-toolbox.readthedocs.io/en/latest/

Information about the use of the XBeach model itself can be found on: 

https://xbeach.readthedocs.io/en/latest/.

# Getting started / installation

Pip packages are hosted on the pypi server and can be installed using:

**pip install xbTools**. 

# Release notes

Release  | notes 

------------- | -------------

0.0.1  | first testing of package on test.pypi

0.0.n  | additional testing on test.pypi until release

1.0.0  | first official release on pypi 🎉

# Usage / examples

Basic examples have been added to the examples folder in the project.

For both a 1D and 2D simulation these python notebooks show how the tools can be used to setup a model.

# Contributing

fork, issue, branch, commit, review, approve, merge

# Contact

Menno de Ridder - menno.deridder@deltares.nl

Cas van Bemmelen - cas.van.bemmelen@witteveenbos.com

Marlies van der Lugt - marlies.vanderlugt@deltares.nl