Support / Quickstart Guide
The "AED" modelling code-base is a community-driven library of modules and algorithms for simulation of "aquatic ecodynamics" - water quality, aquatic biogeochemsitry, biotic habitat and aquatic ecosystem dynamics.
Several options exist for using the model - depedning on the host model and the level of complexity required. Currently 3 main code bundles exist including AED2, AED2+, and a legacy bundle AED bundle that works in the FABM framework (FABM-AED).
The below information summarises the six key steps to get the AED/AED2/AED2+ model up and running.
- 1: Model Driver
- 2: OS, Release & Compiling
- 3: Setting up AED2
- 4: Running the Model
- 5: Post Processing
- 6: Validation & Assessment
Users must choose to either download a pre-compiled model binary, or download the source code and compile for a specific model driver and chosen operating system.
| Host Model Name | Download | Source Code |
|---|---|---|
GLM |
GLM-AED2 (Windows & Mac OSX) GLM-AED2+ (on request) |
GLM GitHub AED2 GitHub AED2+ GitHub (registration required) |
TUFLOW-FV |
TUFLOW-FV (Windows only, requires License) AED2 (Windows Only) AED2+ (on request) |
AED2 GitHub AED2+ GitHub (registration required) FV-AED2 GitHub |
Telemac |
TELEMAC (Registration Required) | TELEMAC SVN code repository |
Bring your own |
You can connect your own hydrodynamic model - see our developers page | - |
Once the first two steps are completed a simulation configuration must be developed. This is generally the same regardless of the hydrodynamic driver, but some features are platform specific.
| Host Model Name | Configuring a Simulation | Supporting Info & Guides |
|---|---|---|
GLM |
Refer to the setup instructions for configuring an AED simulation (select the GLM tab). | GLM publications AED2 Module Information GLM aed2.nml Example |
TUFLOW-FV |
Refer to the setup instructions for running AED with TUFLOW-FV (select the TUFLOW-FV tab). | TUFLOW-FV Information AED2 Module Information FV aed2.nml Example |
Telemac |
Refer to the setup instructions for running AED (T3D instructions pending). | TELEMAC wiki |
Once a AED/AED2/AED2+ setup has been configured, users run a simulation with the host model.
| Host Model Name | Running a Simulation | Additional Info |
|---|---|---|
GLM |
Refer to the instructions for running AED with GLM (select the GLM tab). | GLM Getting Started GLM Example Simulations GLM Publications |
TUFLOW-FV |
Refer to the instructions for running AED with TUFLOW-FV (select the TUFLOW-FV tab). | TUFLOW-FV Manuals TUFLOW-FV Tutorials & Examples SWAN Wave Model SMS Tutorials |
Telemac |
Currently under development | TELEMAC (Registration Required) |
Once a simulation is completed, users are able to plot and analyse the results. Several options for plotting exist depending on the host model.
| Host Model Name | Processing a simulation | Additional Info |
|---|---|---|
GLM |
Refer to the instructions for processing an AED simulation run with GLM (select the GLM tab). | GLMr R-Studio Package GLMm Matlab Package |
TUFLOW-FV |
Refer to the instructions for processing an AED simulation run with TUFLOW-FV (select the TUFLOW-FV tab). | Tuflow FV Matlab Package AED2 Matlab Package (pending) SMS Tutorials |
Telemac |
-- | TELEMAC GUI Options |
The final step in running AED2 is to compare the model with field data, and where possible, to calibrate the simulation and undertake uncertainty analysis.
TO BE UPDATED
