CONTENTS OF SWMM51015_ENGINE.ZIP
================================

The 'src' folder of this archive contains the C source code for
Version 5.1.015 of the Storm Water Management Model's computational
engine. Consult the included 'Roadmap.txt' file for an overview of
the various code modules. The code can be compiled into both a shared
object library and a command line executable. Under Windows, the 
library file (swmm5.dll) is used to power SWMM's graphical user
interface.

The 'CMakeLists.txt' file is a script used by CMake (https://cmake.org/)
to build the SWMM 5.1 binaries. CMake is a cross-platform build tool
that generates platform native build systems for many compilers. To
check if the required version is installed on your system, enter

    cmake --version

from a console window and check that the version is 3.5 or higher.

To build the SWMM 5.1 engine library and its command line executable
using CMake:

1. Open a console window and navigate to the directory where this
   Readme file resides (which should have 'src' as a sub-directory
   underneath it).
2. Issue the following commands:
      mkdir build
      cd build
      cmake ..
      cmake --build . --config Release

On Windows the resulting engine DLL (swmm5.dll) and command line
executable (runswmm5.exe) will appear in the build\Release directory.
For Linux and MacOS the shared object library (libswmm5.so) and the
command line executable (runswmm5) will appear in the build directory. 