OpenWQ

Table of Contents

• Introduction
• Branches
• Compiling
• Execution
• Visualization
• Supporting Scripts
• Working Example

Introduction

• Soure code for the multi-chemistry, multi-scale OpenWQ modelling framework.
• Reading material:
  • Documentation
  • Articles: Coming soon!

Branches

Active

• main: primary branch with latest verified updates to the working code
• development: used to verify updates from feature branches before merging with main
• supporting_scripts: feature branch for development of supporting Python and MATLAB scripts
• wrapper_interfaces: feature branch for development of wrapper interfaces between SUMMA and OpenWQ, and MESH and OpenWQ
• expression_evaluation_optimization: feature branch for optimizing string parsing and the computation of mathematical expressions
• optimization_sink_source: feature branch

Notes

• Note that the primary branch (formerly known as "master") was renamed as "main"
• If using a local clone with the previous naming scheme, the clone may be updated using the following Git commands:

$ git branch -m master main
$ git fetch -p origin
$ git branch -u origin/main main

Compiling

• CMake: CMakeLists.txt is provided
• Library dependencies: Armadillo, VTK, OpenMP
• CMake minimum version: 3.10

Execution

• Coming soon!

Visualization

• Coming soon!

Supporting Scripts

• Used for post-processing
• See supporting_scripts folder

Working Example

• Coming soon!