Toolbox to analyse and setup xbeach models
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xbtools-1.0.3.tar.gz.
File metadata
- Download URL: xbtools-1.0.3.tar.gz
- Upload date:
- Size: 60.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e7673210ee4c7c6e1cc8b9219a2d9b0bcd29cbb9fdb9e3478d2d23dac8f6332
|
|
| MD5 |
aa22b39aa29c009bbf970eebd87f1cd2
|
|
| BLAKE2b-256 |
2681dce9ff7da1e3138504de41e20b206178038d43f197de9907f745bd75b5f2
|
File details
Details for the file xbtools-1.0.3-py3-none-any.whl.
File metadata
- Download URL: xbtools-1.0.3-py3-none-any.whl
- Upload date:
- Size: 64.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d0bb9acbd9d0dc9f14d8bbbae19b4c931f525266177ab0a625748ba9b19e6a54
|
|
| MD5 |
13be467eeec5e5a2624eb585fe096325
|
|
| BLAKE2b-256 |
ee5edbaf6d5c42b7a5c87de4db7e0985f879ba5dbc11b05914c395a4c6622285
|
