Skip to main content

Toolbox to analyse and setup xbeach models

Project description

ReadTheDocs pytest-py310 pylint pypi-upload

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

Project details


Download files

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

Source Distribution

xbTools-1.0.2.tar.gz (41.6 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

xbtools-1.0.2-py3-none-any.whl (64.6 kB view details)

Uploaded Python 3

xbTools-1.0.2-py3-none-any.whl (44.7 kB view details)

Uploaded Python 3

File details

Details for the file xbTools-1.0.2.tar.gz.

File metadata

  • Download URL: xbTools-1.0.2.tar.gz
  • Upload date:
  • Size: 41.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for xbTools-1.0.2.tar.gz
Algorithm Hash digest
SHA256 d8219502ce5a487928395578ebdfbcf73c9c4cbf811ca44bb59a1a509622be29
MD5 c60312e2239dae5b730551910ba7100e
BLAKE2b-256 68f746dd9e97e0e2cdac374bb158f590e1dd2dc5746d7a7605ae09c627bcb2e4

See more details on using hashes here.

File details

Details for the file xbtools-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: xbtools-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 64.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xbtools-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ad3ce797b9b83a96d950dd0d82f64861d2759d2241fb9b1fed2d8a7b30a9bfb1
MD5 611bb949cc34bb3816eda8f2e1b224ec
BLAKE2b-256 46d196901c8530c7e980960bdc85e1db4626352809633e7885bc5344f8e3c697

See more details on using hashes here.

File details

Details for the file xbTools-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: xbTools-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 44.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for xbTools-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ed002a3a660e3c4d80e35ebc714e16ab335d4a52d415faf0a2eaaf4cb5fe4fb0
MD5 98a0a18619c8c08f67b37d0338d5a1ba
BLAKE2b-256 361043e92eecb2eb7895bda00fd039377e7a0e744e7914546d10b20d93532fac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page