Metadata-Version: 2.1
Name: xbTools
Version: 1.0.0
Summary: Toolbox to analyse and setup xbeach models
Home-page: https://github.com/openearth/xbeach-toolbox
Author: Menno de Ridder
Author-email: menno.deridder@deltares.nl
License: GNU General Public License v3.0
Requires-Python: >=3, <4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib >=3.5.0
Requires-Dist: netCDF4 >=1.6.0
Requires-Dist: scipy >=1.10.0
Requires-Dist: datetime
Requires-Dist: geopandas >=0.13.0
Requires-Dist: shapely >=2.0.0
Requires-Dist: fiona >=1.9.4.post1
Requires-Dist: pytest

[![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-test-upload](https://github.com/openearth/xbeach-toolbox/actions/workflows/pypi-test-upload.yml/badge.svg?branch=main)](https://github.com/openearth/xbeach-toolbox/actions/workflows/pypi-test-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 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
