.. XBeach toolbox documentation master file, created by
   sphinx-quickstart on Mon Aug 14 16:52:44 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

XBeach Python toolbox
==========================================



With the XBeach toolbox a XBeach model can be setup with Python and the ouput can be analysed. On this page the various Python functions are descibed. 

The different functionalities are described with a few examples. First an 1D model setup is created with the toolbox. The next pages show how a 2D model setup can be created. Lastly, the postprocessing is demonstrated. All the functions are descibed at the Functions page.

.. toctree::
   introduction
   xbeach-setup-1D
   xbeach-setup-2D
   xbeach-post-2D
   functions