### How to install and use CADDIES-caflood **(2018 April)** ###

The CADDIES 2D caflood application, which implements the WCA2D model
for fast 2D flood simulations, is available as a single zip file. 

This version of the software works only on a Windows 64 bits operating
system and it has been tested only on a Windows 10 64 bit OS. This
version of the software does use parallel GPU computation and it
uses double precision floating point values.

Attention, the caflood application is composed only of a command line
executable, i.e. it does not have any graphical user interface
(GUI). In order to execute a simulation, the user must call the
command using Windows PowerShell or similar command line shell.

The zip file contains the following elements:

  1. ReadMe.txt: this short guide on how to install and use the software.

  2. vcredist_x64.exe: the Visual C++ Redistributable Packages for
     Visual Studio 2017.

  3. caflood.exe: the executable of the caflood application.

The steps needed to install the caflood application are the following:

  1. Install the Visual C++ Redistributable Packages using the
     executable vcredist_x64.exe. This executable is also available at
     the following link: 
     
     http://www.microsoft.com/en-gb/download/confirmation.aspx?id=40784

  2. Copy the caflood.exe file in a local folder like C:\Path\CAFLOOD\

  3. Install the OpenCL libraries for the various computational
     resources available. Some examples are:
     
     - For 3rd and 4th Generations Intel Core Processors (ATTENTION no
       Xeon processors) is the following link:
       
       http://software.intel.com/en-us/vcsource/tools/opencl-sdk

       It is not necessary to install the full SDK. It is possible to
       install only the free redistributable run-time package for
       Windows 64-bit OS.

     - For Intel Xeon processors and Intel Xeon Phi coprocessors is
       the following link:
       
       http://software.intel.com/en-us/vcsource/tools/opencl-sdk-xe

       It is not necessary to install the full SDK. It is possible to
       install only the run-time package for Windows 64-bit OS.
       
     - For an NVIDIA GPU is the following link:

       http://www.nvidia.co.uk/Download/index.aspx?lang=en-uk

       The graphics drivers of the available graphics card need to be
       installed. It is not necessary to install the CUDA SDK.

     The are also available an OpenCL library for AMD processors and
     graphics card if these are the computational resources
     available. However, the CADDIES-2D software has not been tested
     on these resources.

Attention, this build has only been tested on NVIDIA GPU's without 
OpenCL events.

The steps needed to run the caflood application are the following:

  1. Start Windows PowerShell or similar command line shell.

  2. Change the current folder into the folder where the caflood.exe
     file is located:

     Ex:
     > cd C:\Path\CAFLOOD\

  3. Run the caflood.exe command by passing the argument /WCA2D and
     the following three input arguments:

     - The path to the input folder containing the input simulation data.
     - The name of the CSV setup file.
     - The path to the output folder where the output simulation data
       will be generated.

     Ex:
     > caflood.exe /WCA2D C:\Path\To\Input setup.csv C:\Path\To\Output


See the user manual for further information on how to run the caflood
application. Use the argument /help to see a list of available
arguments.

For further information, please contact Mike Gibson at
m.j.gibson@exeter.ac.uk.
