Skip to main content

Toolbox to analyse and setup xbeach models

Project description

ReadTheDocs pytest-py310 pylint pypi-test-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 as usual.

Release notes

Release notes
0.0.1 first release!
0.0.2 future content

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

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.0.tar.gz (40.5 kB view details)

Uploaded Source

Built Distribution

xbTools-1.0.0-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xbTools-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b2d5fb46a6ea787cf3c2f07c02b96cc550387484b3c4fe2b3bf7d3bfcc01deaf
MD5 0180aa25a98fd85e64b6e5dc1defaf22
BLAKE2b-256 515f4ba290c6768e6323ad2da0eaf27af417e7ef1cc67f58b4809f7fbd5840e0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xbTools-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 648eb659df20be89aad8e648c369ff85bdee0aed43be04a9c4b873d5a514361a
MD5 3d86a575555d52564569c01d95394feb
BLAKE2b-256 a46c99c8906900841eb4ca74d551bf442f8040cfe746bdc728a27a463d23cf79

See more details on using hashes here.

Supported by

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