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
2 maintainers
Release files for xbTools 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xbtools-1.0.3.tar.gz | 60.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xbtools-1.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 125.5 kB
Release files / xbtools-1.0.3.tar.gz
| Download URL | xbtools-1.0.3.tar.gz |
|---|---|
| Size | 60.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e7673210ee4c7c6e1cc8b9219a2d9b0bcd29cbb9fdb9e3478d2d23dac8f6332
|
|
BLAKE2b-256 checksum How to use checksums |
2681dce9ff7da1e3138504de41e20b206178038d43f197de9907f745bd75b5f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / xbtools-1.0.3-py3-none-any.whl
| Download URL | xbtools-1.0.3-py3-none-any.whl |
|---|---|
| Size | 64.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d0bb9acbd9d0dc9f14d8bbbae19b4c931f525266177ab0a625748ba9b19e6a54
|
|
BLAKE2b-256 checksum How to use checksums |
ee5edbaf6d5c42b7a5c87de4db7e0985f879ba5dbc11b05914c395a4c6622285
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
