{include:ContentHeader}
{info:title=Pre-release}
A pre-release of the Matlab XBeach Toolbox can be obtained from [https://repos.deltares.nl/repos/OpenEarthTools/tags/xbeach_release_27Jun2011/] or downloaded as [ZIP archive|^xbeach_release_27Jun2011.zip]. The upcoming full release will be announced on this web page.
{info}
{info:title=Cheatsheet}
A cheatsheet for toolbox commands is now available: [^XBeach Matlab Toolbox Cheatsheet.pdf]
{info}
h1. Contents
{children}
h1. Introduction
The XBeach Toolbox in the OpenEarthTools repository tries to provide a generic and easy-to-use Matlab interface to the [XBeach model|XBEACH:Home].
h2. How can I obtain the XBeach toolbox?
Download the latest version from the OpenEarthTools subversion repository: [https://repos.deltares.nl/repos/OpenEarthTools/trunk/matlab/applications/xbeach/]
Or download the pre-release from [https://repos.deltares.nl/repos/OpenEarthTools/tags/xbeach_release_21Apr2011/] or as [ZIP archive|^xbeach_release_21Apr2011.zip]
h2. What will I download?
!xb_toolboxes.png|width=800!
{table-plus:width=800|enhableHighlighting=true}
|| Toolbox || Collection || Subcollection || Description ||
| XBeach | xb_io | | Low-level I/O functions. Return XBeach structures containing the contents of any XBeach file. |
| | | xb_dat | Low-level function for XBeach DAT files. Return contents of an XBeach DAT file or information about an XBeach DAT file, mainly type and dimensions. |
| | xb_human | | Mid-level functions to interact with [XBeach structures|XBeach structure] as supplied by the xb_io and xb_modelsetup toolboxes. Displays, adds, modifies, deletes, checks, merges, splits, renames contents of XBeach structures in a way understandable for human beings. |
| | xb_modelsetup | | Mid-level functions for model setup. In fact, a collection of xb_generate_\* functions that all supply a part of an XBeach settings structure, which can be written to disk as a fully functional XBeach model by the xb_io toolbox. |
| | | xb_grid | Mid-level functions for grid generation. Generates XBeach settings structures containing grids based on bathymetries, waves, etcetera. |
| | | xb_bc | Mid-level functions for boundary conditions generation. Generates XBeach settings structures containing waves and tide data. |
| | xb_run | | High-level functions to run XBeach settings structures as an actual model. Functions to write XBeach settings structures to disk, obtain the latest XBeach binaries applicable in the current situation from the TeamCity build server and start the model. |
| | xb_visualise | | High-level functions to visualise XBeach structure contents. Basic functions to visualise XBeach input and output stored in a XBeach structure. |
| | | xb_output_gui / xb_result_viewer | High-level functions to build advances visualisations of XBeach structure contents. |
| | xb_analysis | | High-level functions to analyse XBeach output structures. |
| | xb_nesting | | High-level nesting functions to nest XBeach models in other models like Delft3D. |
| | | xb_swan | Helper functions for SWAN input/output. |
| | | xb_delft3d | Helper functions for Delft3D input/output. |
| | xb_lib | | Low-level miscellaneous functions. |
| | xb_gui | | Graphical User Interface for the toolbox (under construction). |
{table-plus}
h2. How do I contribute?
Script and commit\!
Please not the following conventions, next to the general OpenEarthTools coding conventions (like documentations, test functions, etc):
* All function names are prefixed by "xb_"
* (Parts of) XBeach model configurations or output are structured in a generic Matlab structure (see [XBeach structure])
* Functions are minimal. All functions have their own tiny task. Only combined they will show their strength\!
* Functions do not output to the screen. If all minimal functions output to the screen, it will be a mess\!. So, no output unless explicitly requested (e.g. xb_plot_*, xb_show, etc)
|