Nuflood

Build status

Linux	Codecov

Installation

Nuflood uses the following software as its dependencies:

CMake >= 2.8
gcc >= 4.8.4

To retrieve dependencies included as submodules (e.g., rapidjson), run:

git submodule update --init --recursive

Finally, compile the software:

mkdir build && cd build
cmake .. && make

To compile on Mac OSX, ensure non-Clang gcc and g++ compilers are installed, then run

mkdir build && cd build
cmake -DCMAKE_C_COMPILER=/path/to/gcc -DCMAKE_CXX_COMPILER=/path/to/g++ ..
make

Build and run the Docker image

docker build -t nuflood .
docker run -it --rm nuflood /bin/bash

Usage at a glance

To simulate a modeling scenario, execute a command similar to

/path/to/nuflood/executables/kurganov_petrova example.json

where /path/to/nuflood/executables/kurganov_petrova is the system path to the compiled Kurganov-Petrova simulation model and example.json is a path to the scenario input file.

For scenario examples, please visit the Nuflood examples project.

License

BSD-ish