Installation

This document describes the installation steps needed to get the XBeach MI (Multiple Instances) framework to work on a Windows machine (the screenshots may deviate slightly as they are from a Mac OS X machine). If you have a working XBeach installation you can skip step 1. If you have a working Python 2.7 installation with packages numpy, netCDF4, multiprocessing and mako installed, you can skip step 2.

1. Download XBeach

1. Go to http://xbeach.org.

1. Choose Downloads and Releases and source.

1. Go to Daily builds and download XBeach rev. XXXX (with netCDF support). You need a recent version of XBeach (rev. >= 4748) that implements the Basic Model Interface (BMI).

2. Download Python

1. Google for Python XY (or Anaconda).

1. Follow the instructions to download Python XY (or Anaconda).

1. Follow the instructions to install Python XY (or Anaconda). Do not forget to choose Full install and not the default installation configuration.

3. Download BMI and XBeach MI

1. Go to http://github.com/openearth and search for bmi-python.

1. Choose Download ZIP.

1. Go back and search for xbeach-mi.

1. Choose Download ZIP.

4. Install BMI and XBeach MI

1. Unzip the downloaded bmi-python and xbeach-mi packages.
2. Go to the command line (Start > cmd).
3. Go to the download directory of the bmi-python package.
4. Go to the directory that contains the setup.py file.
5. Run the command python setup.py install.

1. Go to the download directory of the xbeach-mi package that contains the setup.py file.
2. Again, run the command python setup.py install.

5. Test XBeach MI

1. Test the installation by running the command xbeach-mi --help.

1. Go to the example directory in the xbeach-mi download directory.
2. Run XBeach MI with the provided configuration file.

1. Details on configuring and running XBeach MI can be found on the documentation website: Examples