Difference between revisions of "Navigating the source code bundle"
| Line 20: | Line 20: | ||
<LI> cmake files: CMakeLists.txt | <LI> cmake files: CMakeLists.txt | ||
<LI> beta_notes: this file details all the changes in input files for each version | <LI> beta_notes: this file details all the changes in input files for each version | ||
| − | <LI> Utility | + | <LI> Utility: this dir contains a lot of useful utility code. The header of each program generally has info on its purpose and important notes on how to use it. |
| + | <UL> | ||
| + | <LI>ACE: source code and install notes for ACE tools | ||
| + | <LI>ArcGIS: some scripts to massage SELFE grid and outputs into ArcGIS | ||
| + | <LI>Combining_Scripts: FORTRAN and perl scripts used to gather outputs from SELFE (e.g., outputs/?_0000_elev.61 etc) into one binary file (?_elev.61) | ||
| + | <LI>Grid_Scripts: FORTRAN codes to interpolate depths from DEM files in either structured grid (raster) or unstructured grid format. While xmgredit5 can do similar things, these scripts are mostly for loading from very large DEM files. | ||
| + | <LI> | ||
| + | </UL> | ||
</UL> | </UL> | ||
Revision as of 19:33, 29 August 2012
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: this dir contains a lot of useful utility code. The header of each program generally has info on its purpose and important notes on how to use it.
- ACE: source code and install notes for ACE tools
- ArcGIS: some scripts to massage SELFE grid and outputs into ArcGIS
- Combining_Scripts: FORTRAN and perl scripts used to gather outputs from SELFE (e.g., outputs/?_0000_elev.61 etc) into one binary file (?_elev.61)
- Grid_Scripts: FORTRAN codes to interpolate depths from DEM files in either structured grid (raster) or unstructured grid format. While xmgredit5 can do similar things, these scripts are mostly for loading from very large DEM files.
