Downloading the code

This page covers obtaining the source code. If you only need a ready-to-run executable, see Downloading the model instead.

Cloning the bundle

The source is assembled from linked sub-modules, so a plain git clone will leave the glm-source subdirectories empty. The --recurse-submodules argument is required:

git clone --recurse-submodules https://github.com/AquaticEcoDynamics/glm-aed.git

To clone a particular tagged release:

git clone --recurse-submodules -b v3.3.0 https://github.com/AquaticEcoDynamics/glm-aed.git

Note

This repository is large (over 1 GB), because it carries the full history of published binaries. If you only need the current source and examples, a shallow clone is much faster:

git clone --depth 1 --recurse-submodules --shallow-submodules \
    https://github.com/AquaticEcoDynamics/glm-aed.git

If you have already cloned without sub-modules, populate them with:

git submodule update --init --recursive

What you get

The glm-source directory contains the build scripts and the following sub-modules:

Sub-module	Role
GLM	Hydrodynamic model (4.x line)
libaed-water	AED water column modules
libaed-benthic	AED benthic modules
libaed-demo	AED demonstration modules
libaed-api	GLM–AED coupling interface
libutil	Shared utility routines
libplot	Optional plotting support

To build what you have downloaded, see Compiling the code.

To update sub-modules to newer commits, see Updating existing submodule state.