You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This is a short guide for people looking to get started with XBeach within Deltares (employees, MSc. students, interns, etc.)

Important resources

Where to find information on XBeach:

  1. Our website: www.xbeach.org (containing tutorials, executables, skillbed and a user forum)
  2. The manual (also on the website, although it is a little outdated on some topics)
  3. The source code (see below how to get hold of it)
  4. Your colleagues who are also using XBeach

Getting the toolbox (Matlab)

Setting up your own XBeach model is easiest when making use of our matlab toolbox (integrated into the OpenEarthTools toolbox). Getting hold of it involves the following steps:

  1. Install 'TortoiseSVN' via the Deltares Appstore
  2. Create a new folder where the toolbox will be placed
  3. Right-click and choose 'SVN Checkout ...'
  4. Use the URL: https://svn.oss.deltares.nl/repos/openearthtools and click OK
    1. Supply your Deltares login information
  5. You now have the complete OpenEarthTools toolbox, the XBeach tools are located in ..\trunk\matlab\applications\xbeach\
    1. Update regularly using right-click -> SVN Update on the highest level.
    2. Contribute with bug fixes and new functionality using right-click -> SVN Commit. Please try not to break stuff (unless you are a fan of angry emails).

Getting the source code

You do not need to download the source code just to run XBeach (see 'Running XBeach' below). You do need it if you want to examine or modify the source code. If you want to develop a new feature, please do so in a separate BRANCH, and NOT directly in the TRUNK.

If you want the complete source code, follow the steps below. 

  1. Install 'TortoiseSVN' via the Deltares Appstore
  2. Create a new folder where the toolbox will be placed
  3. Right-click and choose 'SVN Checkout ...'
  4. Take a moment to think if you really need all branches/tags/ etc, if not you might want to make a selection using 'Choose items'
  5. Use the URL: https://svn.oss.deltares.nl/repos/xbeach and click OK
    1. Supply your Deltares login information

Getting course material

There is course material (including exercises) on getting started with XBeach. This is located in the same repository as the source code (see above) in the folder 'Courses'. The most recent one at the time of writing is 'DSD2014'. 

Getting precompiled executables

Setting up your own XBeach model is easiest when making use of our matlab toolbox (integrated into the OpenEarthTools toolbox). Getting hold of it involves the following steps:

  1. Install 'TortoiseSVN' via the Deltares Appstore
  2. Create a new folder where the toolbox will be placed

Running XBeach

Setting up your own XBeach model is easiest when making use of our matlab toolbox (integrated into the OpenEarthTools toolbox). Getting hold of it involves the following steps:

  1. Install 'TortoiseSVN' via the Deltares Appstore
  2. Create a new folder where the toolbox will be placed

  • No labels

Disclaimer