Download code & toolbox
To start modelling using XBeach, you will need to download it first. In principle, there are two options:
- Download the XBeach source code and compile the executable yourself (see the next section Compile code)
- Download a pre-compiled executable suitable for you operating system and needs
If you have Matlab available, you might want to consider to download the Matlab Toolbox for XBeach as well. The toolbox facilitates setting up and running XBeach models and subsequently reading, analyzing and visualizing the model output.
Download source code
In order to download the XBeach source code, again to options are available:
- Subversion (https://svn.oss.deltares.nl/repos/xbeach/trunk)
- ZIP file (see Download page)
Subversion is a well-known version management system that allows you to always have the most recent source code at hand. It also allows developers to commit changes to the source code, without interferring with other developers. In order to use Subversion, you will need a Subversion client. A well-known client for Windows is Tortoise. If you have registered, you can download the source code via the following URL: https://svn.oss.deltares.nl/repos/xbeach/trunk.
If you do not want to use Subversion, you can download prepared ZIP files with the entire source code from our Download page. Please be aware that different versions of XBeach can be downloaded and that the most recent ZIP file does not necessarily contain the most recent XBeach version.
Download pre-compiled executable
You can download pre-compiled executables for both Windows and UNIX systems. XBeach is tested for 32-bit Windows versions and on a CentOS Linux system, that is closely related to the Red Hat Linux system. The available downloads are listed on Download page. Please be aware that different versions of XBeach can be downloaded and that the most recent executables are not necessarily the most recent XBeach version.
As you will see on the download page, XBeach comes in different flavours. Next to the regular XBeach executable, you will find the following executables:
- MPI
- netCDF
- MPI + netCDF (UNIX only)
The MPI executable enables you to use a parallel programming application like MPICH2 to run XBeach over multiple processors and/or computers. The netCDF executable enables you to write XBeach output to a netCDF formatted file, which is particulary interesting for large models and publication of data. The last type of executable enables you to use both, but is only available for UNIX systems due to conflicting libraries in Windows.
If you choose to download pre-compiled executables, you can skip the next step in the Get started menu (Compile code).
Download toolbox
Also the Matlab Toolbox for XBeach can be downloaded from the Download page. The toolbox contains a variety of functions to setup an XBeach model and run it. It also contains functions to read model output, analyze and visualize the results. Tutorials on how to use the toolbox can be found here.