Welcome to OpenWQ’s documentation!

OpenWQ is a generalised biogeochemical reaction-network model written in C++. It was designed as a coupler for integration with existing hydro-models to enable flexible, multi-scale, multi-chemistry simulations. OpenWQ adapts to the host hydro-model spatial and temporal configurations, which can include 1D, 2D or 3D spatial discretizations based on structured or unstructured meshes. It aims to be flexible, fast, free, and extendable.

• Home
  • Overview
  • Motivation & Innovation
  • Credits
  • License
• Documentation
  • Theoretical Foundation
    • Conservation Equations
    • Biogeochemistry: Reaction networks
  • Example of Case Studies
  • Software Documentation
• Installation
  • Get OpenWQ
    • STEP 1: Locate host-model source code folder
    • STEP 2: Clone OpenWQ
    • STEP 3: Keep OpenWQ updated
  • Building requirement
  • Build and Compile
    • Docker
    • Linux
    • Windows
    • MacOS
  • Troubleshooting
• Coupling OpenWQ
  • Existing couplings
    • SUMMA
    • CRHM
    • MizuRoute
    • FLUXOS-OVERLAND
  • How to couple OpenWQ?
    • Overview
    • Steps to perform the coupling
      • STEP 1: Hydro-model structure
      • STEP 2: Get OpenWQ
      • STEP 3: Create class objects
      • STEP 4: Locate coupler functions
      • STEP 5: Call coupler functions
      • STEP 6: Adjust coupler to hydro-model
      • STEP 7: Compile your coupled code
    • Example of OpenWQ_hydrolink files
      • OpenWQ_hydrolink.h
      • OpenWQ_hydrolink.cpp
    • C++ API reference
      • API 1 InitialConfig
      • API 2 RunTimeLoopStart
      • API 3 RunSpaceStep
      • API 4 RunTimeLoopEnd
    • Language binding
      • What is binding?
      • Wrapper libraries for Fortran
      • Wrapper libraries for other languages
  • Synthetic tests
• OpenWQ I/O
  • Overview
    • Standard input file format
    • JSON files in OpenWQ
  • Input files
    • Master
    • Configuration
    • Biogeochemistry
    • Source/Sink & External Fluxes (Optional)
  • Output files
    • Output formats
    • Read outputs
  • Units
    • Mass (\(L\))
    • Volume (\(L^3\))
    • Time (\(T\))
  • Supporting scripts
    • Biogeochemisty JSON Generator
      • Step 1: Identify the chemical pools
      • Step 2: Identify reactions
      • Step 3: Characterize the reaction kinetics
      • Step 4: Convert diagram to OpenWQ input file
    • Configuration JSON Generator
    • Sink-Source JSON Generator
    • Reading model outputs
• Join us!
• Contact