This repository houses the hydrodynamic-biogeochemical model for Cockburn Sound, a coastal embayment located near Perth, Western Australia.
Explore the online manual »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
In 2022, the Western Australian Marine Science Insitution and Wesport commisioned development of an independent hydrodynamic-biogeochemical model for Cockburn Sound, which is located on the coast of Perth, Western Australia.
The model uses the TUFLOW-FV 3D finite volume hydrodynamic model, and the AED water quality model.
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 on Pawsey WAMSI 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.
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 WBM BMT.
-
Download and install the compatible AED model plugin (FV-AED) from the UWA-AED website.
-
Clone the current csiem_model_tfvaed_1.0 repo
Linux: git clone https://github.com/AquaticEcoDynamics/csiem_model_tfvaed_1.0.git Windows: use Github Destop to clone or download ZIP at the Github website
-
Clone the complete model files including
bc_repofolder. For Linux users, copy the fetch_csiem.sh shell file from the Github csiem_model_tools repository. Then fetch thebc_repoas:./fetch_csiem.sh 1.0
The above fetch command will download all the model files including the bc_repo;
-
Go to the main model run directory, and execute model as:
{tfv_aed binary} {csiem model tfvaed 1.0 main configuration}.fvc
- 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 |
- File naming convention: model files are named using the following conventions:
- model_runs
| Sub-type | Conventions | comments |
|---|---|---|
| WQ (water quality) | csiem_{model generation ID}_{mesh option}_{model period}_WQ.fvc | Main configuration file for coupled TFV-AED model, e.g. csiem_v1_B009_20130101_20131231_WQ.fvc |
| HD (hydrodynamics) | csiem_{model generation ID}_{mesh option}_{model period}_HD.fvc | Main configuration file for TFV hydrodynamic model only, e.g. csiem_v1_B009_20130101_20131231_HD.fvc |
| ST (sediment transport) | csiem_{model generation ID}_{mesh option}_{model period}_SED.fvc | Main configuration file for TFV-ST model, e.g. csiem_v1_B009_20130101_20131231_ST.fvc. Note: the TFV-ST model was originally set by BMT and to be updated with corresponding file paths/names |
- includes
| Sub-type | Conventions | comments |
|---|---|---|
| bc (boundary conditions) | {boundary type}_{data source}_{data period}.fvc | e.g. met_BARRA_perth_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_csiem_mesh_B.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_ocean (ocean boundary) | - NetCDF: {data source}_{UTC zone}_{data period}.nc - CSV: ocean_bgc_{source}_{data period}.csv |
e.g. ROMS_UTC+8_20130101_20140101_FILLED.nc ocean_bgc_IMOS_20220101_20221231.csv |
| 2_weather (weather condition) | {data source}_{domain}_{UTC zone}_{data period}.nc | e.g. WRF_d02_UTC+0_20220101_20230101.nc |
| 3_waves (waves inputs) | {data source}_{domain}_{UTC zone}_{data period}.nc | e.g. WWM_Agrid_UTC+0_20150101_20151231.nc |
| 4_sce (Swan-Canning Estuary) | {location}_{BC type}_{ data period}_{model type}.csv | e.g. NAR_Inflow_20100101_20230101_wq.csv |
| 5_phe (Peel-Harvey Estuary) | N/A (to be updated) | |
| 6_gw (Groundwater inputs) | SGD_{zone id}_{data period}.csv | e.g. SGD_zone1_1_20130101_20131231.csv |
| 7_discharges (industrial discharge) | {data source}_{data period}.nc | e.g. BP_20130101_20140101_wq.csv |
| 8_intakes (industrial intakes) | {data source}_{data period}.nc | e.g. PSDP1_20130101_20140101_wq.csv |
| 9_operations (Cockburn Sound operations) | N/A (to be updated) |
- gis_repo
| Sub-type | Conventions | comments |
|---|---|---|
| 1_domain (GIS files for model domain) | csiem_mesh_{mesh option}_{version ID}_{resolution} | e.g. csiem_mesh_B009_opt.2dm |
| 2_benthic (GIS files for benthic conditions) | csiem_{benthic type}_{version ID} | e.g. Cockburn_Sound_Material_011.shp |
| 3_output (GIS files for output definition) | extraction_point.csv | |
| 4_gw (GIS files for defining groundwater inputs) | groundwater_zones_{version NO} | e.g. groundwater_zones_v2.shp |
Input files and model output files are able to be processed using the csiem-marvl repository that includes the supporting scripts and site data. Please contact the developers for further information.
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the --- License. See LICENSE.txt for more information.
Matt Hipsey: @matthipsey - [email protected]
Project Link: csiem online manual
- Funding from the WAMSI Westport Research Program
- Gayan Gunaratne, Louise Bruce and the BMT software team
- Brendan Busch & Peisheng Huang from the AED research group
- Oceanographic models from Ivica Janeković & Chari Pattiaratchi from the UWA Oceans Institute