This page moved to the XBeach portal

The contents of this page moved to the new XBeach Open-source Software (OSS) portal at http://oss.deltares.nl/ and can be directly approached using http://www.xbeach.org.

New XBeach repository and portal website

The new XBeach portal website is released on http://oss.deltares.nl! It replaces the general parts of this WIKI space and the Google Groups website.
The Subversion (SVN) repository is migrated as well. The new address is: https://svn.oss.deltares.nl/repos/xbeach. Read the instruction on how to register and create a new working copy or how to relocate to start using the new SVN server.

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. The upcoming full release will be announced on this web page.

Cheatsheet

A cheatsheet for toolbox commands is now available: XBeach Matlab Toolbox Cheatsheet.pdf

Contents

Introduction

The XBeach Toolbox in the OpenEarthTools repository tries to provide a generic and easy-to-use Matlab interface to the XBeach model.

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

What will I download?

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)

  • No labels