Navigating the source code bundle

From ccrmwiki
Revision as of 11:52, 29 August 2012 by Yjzhang (talk | contribs)
Jump to: navigation, search

You can find a lot of useful information/files in the source code bundle. In general, each directory has a readme type file.

We use v3.2.0 as an example to explain the structure inside:

cmake

The README inside explains how to use cmake (needs to be installed on your system) to build SELFE. See [1]for more details.

mk

The files in this dir are local configuration settings usd by src/Makefile

test

This dir has all the test cases used to benchmark each version of SELFE

src
The source code dir has the following subirs and files:
  • All modules: Core, Driver, Hydro, EcoSim, OilSpill-Jug, ParMetis-3.1.-Sep2010, Sediment, and WWMII
  • GNU make files: Makefile and Makefile.old, the latter is a self-contained makefile
  • cmake files: CMakeLists.txt
  • beta_notes: this file details all the changes in input files for each version
  • Utility