FV-AED

FV-AED is the water quality model AED compiled as a plugin ready for linking with the 3D finite volume hydrodynamic model TUFLOW-FV.

Repository organisation

The repository includes:

• binaries : model pre-compiled executables for linux and windows.
• fv-source : model source code, including required AED libraries (libaed-fv, libaed-water and libaed-benthic) as linked sub-modules.
• fv-examples : example simulations for running a TUFLOW-FV + AED simulation, including all required input files.
• workflows : github workflows for automated compilation and testing.

Citing this code

Users may need to cite the AED model in general, or a specific model code package/bundle/version.

Citing a specific code bundle, please use the appropriate DOI, eg.:

Hipsey, M.R., Boon, C., Paraska, D., Bruce, L. and Huang, P., (2022). AquaticEcoDynamics/fv-aed: v2.2.1 (v2.2.1). Zenodo. https://doi.org/10.5281/zenodo.7047676.

Citing the AED model:

Hipsey, M.R., ed. (2022) Modelling Aquatic Eco-Dynamics: Overview of the AED modular simulation platform. Zenodo. https://doi.org/10.5281/zenodo.6516222.

Getting the latest pre-compiled version

For users who only need access to a model executable plugin, the executable for your chosen platform can be downloaded without getting the full repository. Simply navigate to the binaries/os folder, click on the relevant file (e.g., tuflow_external_wq_2.2.1.zip) and click the "download" button on the right.

Cloning the repo with all sub-module code

To access the full repository, including the model examples, the repository must be cloned or downloaded in full. Note that a basic clone will not include the code/files in the linked sub-modules, so an extra argument is needed --recurse-submodules

Cloning the latest code

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

Cloning a particular tag

git clone --recurse-submodules -b v2.2.1 https://github.com/AquaticEcoDynamics/fv-aed.git

Getting hold of older versions

Releases from 2022 are available by sorting through the releases section. For users seeking older bundles of the code (e.g., for compatibility with prior TUFLOW-FV versions), please visit the AED releases repository.

Additional information

See repository Wiki for additional information on getting started using FV-AED, working with the repository, and updating or adding new example water-bodies.