HydroTasmania Woods Lake Water Quality Model

This repository houses the hydrodynamic-biogeochemical model for Woods Lake, a lake located in Tasmania. · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Built With

Getting Started

This repository contains model files (except the bc_repo) that are version-controlled can be run locally on Windows or Linux. The bc_repo contains boundary conditions files that the sizes are too large to be stored at Github, therefore they are stored in an associated project folder and can be accessed by direct download or a fetch method (see below). To get a local copy up and running follow these steps.

Prerequisites

Running the model contained herein requires users to have an active TUFLOW-FV binary and license with the AED pre-compiled plugin.

• Download and install the TUFLOW-FV model and license server from BMT TUFLOW.

• Download and install the compatible AED model plugin (FV-AED) from the UWA-AED releases repository.

Cloning and executing the model

1. Clone the current woods_model_tfvaed_0.1 repo

   Linux: git clone https://github.com/AquaticEcoDynamics/woods_model_tfvaed_0.1.git
   Windows: use Github Destop to clone or download ZIP at the Github website

2. Clone the complete model files including bc_repo folder. For Linux users, copy the fetch_woods.sh shell file from the Github woods_model_tools repository. Then fetch the bc_repo as:

   ./fetch_woods.sh 1.0

   The above fetch command will download all the model files including the bc_repo;

3. Go to the main model run directory, and execute model as:

   {tfv_aed binary} {csiem model tfvaed 1.0 main configuration}.fvc

Folder structure and file naming conventions

1. Folder structure: model files are organized in the following catogories/folders:

Folders	Content
bc_repo	repository for boundary condition files
gis_repo	repository for GIS files required by the model simulations
includes	model configuration files for being included in simulations
model_runs	main model configuration files
outputs	place holder for model output storage

2. File naming convention: model files are named using the following conventions:

• model_runs

Sub-type	Conventions	comments
WQ (water quality)	woods_{model generation ID}_{mesh option}_{model period}_WQ.fvc	Main configuration file for coupled TFV-AED model, e.g. woods_v1_B009_20130101_20131231_WQ.fvc
HD (hydrodynamics)	woods_{model generation ID}_{mesh  option}_{model  period}_HD.fvc	Main configuration file for TFV hydrodynamic model only, e.g. woods_v1_B009_20130101_20131231_HD.fvc

• includes

Sub-type	Conventions	comments
bc (boundary conditions)	{boundary type}_{data source}_{data period}.fvc	e.g. met_BOM_liawenee_20130101_20131231.fvc
ic (initial condition)	initial_conditions_{model version}.fvc	e.g. initial_conditions_wq.fvc
domain	domain_config_{mesh option}_{model type}.fvc	e.g. domain_config_woods_mesh.fvc
turbulence	turbulence.fvc	Include configuration for turbulence parameters
wq (water quality)	AED model configuration files	Include configuration for AED water quality module
output	output_{output category}.fvc	Configuration for model outputs, e.g. output_wq.fvc
roughness	roughness_material_{version NO}.fvc	Configuration for benthic roughness settings, e.g. roughness_wq_Material_011.fvc

• bc_repo

Sub-type	Conventions	comments
1_weather (weather condition)	{data source}_{domain}_{UTC zone}_{data period}.nc	e.g. BOM_UTC+0_20220101_20230101.nc
2_waves (waves inputs)	{data source}_{domain}_{UTC zone}_{data period}.nc	e.g. SWAN_UTC+0_20150101_20151231.nc
3_weir (dam wall)	{location}_{BC type}_{ data period}_{model type}.csv	e.g. Dam_20100101_20230101_wq.csv
4_river (lake river)	N/A (to be updated)

• gis_repo

Sub-type	Conventions	comments
1_domain (GIS files for model domain)	woods_mesh_{mesh option}_{version ID}_{resolution}	e.g. woods_mesh_B009_opt.2dm
2_benthic (GIS files for benthic conditions)	woods_{benthic type}_{version ID}	e.g. Woods_Material_011.shp
3_output (GIS files for output definition)	output_point.csv

Analysis

Input files and model output files are able to be processed using the aed-marvl repository that includes the supporting scripts and site data. Please contact the developers for further information.

(back to top)

Contributing

Contributions from the user and developer community are welcome and greatly appreciated!.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the --- License. See LICENSE.txt for more information.

(back to top)

Contact

Matt Hipsey: @matthipsey - matt.hipsey@uwa.edu.au

(back to top)

Acknowledgments