Skip to content

Welcome to WSIMOD

This is the documentation for the WSIMOD project. WSIMOD stands for the Water Systems Integrated Modelling framework.

The terrestrial water cycle is a highly interconnected system where the movement of water is affected by physical and human processes. Thus, environmental models may become inaccurate if they do not provide a complete picture of the water cycle, missing out on unexpected opportunities and omitting impacts that arise from complex interactions. WSIMOD is a modelling framework to integrate these different processes. It provides a message passing interface to enable different subsystem models to communicate water flux and water quality information between each other, and self-contained representations of the key parts of the water cycle (rivers, reservoirs, urban and rural hydrological catchments, treatment plants, and pipe networks). We created WSIMOD to enable a user greater flexibility in setting up their water cycle models, motivated by the abundance of non-textbook water systems that we have experienced in industry collaboration. The WSIMOD Python package provides tutorials and examples to help modellers create nodes, connect them with arcs, and create simulations.

Table Of Contents

The documentation follows the best practice for project documentation as described by Daniele Procida in the Diátaxis documentation framework and consists of:

  1. About

  2. Installation

  3. Tutorials

    3.1. Quickstart

    3.2. WSIMOD model demonstration - Oxford

    3.3. Land nodes - hydrology and agriculture

    3.4. Model object - WSIMOD models

  4. How-To Guides

    4.1. Customise a node

    4.2. Customise an arc

    4.3. Customise interactions

  5. Component library

  6. Command line interface

  7. Run WSIMOD in DAFNI

  8. API reference

    8.1. API reference - arc

    8.2. API reference - core

    8.3. API reference - land

    8.4. API reference - nodes

    8.5. API reference - sewer

    8.6. API reference - storage (reservoir, river, groundwater)

    8.7. API reference - wtw

    8.8. API reference - other components

    8.9. API reference - model

  9. Coverage


WSIMOD was developed by Barnaby Dobson and Liu Leyang. Theoretical support was provided by Ana Mijic. Testing the WSIMOD over a variety of applications has been performed by Fangjun Peng, Vladimir Krivstov and Samer Muhandes.

The design of WSIMOD was significantly influenced by CityDrain3, OpenMI, Belete, Voinov and Laniak, (2017), and smif.

We acknowledge funding from the CAMELLIA project (Community Water Management for a Liveable London), funded by the Natural Environment Research Council (NERC) under grant NE/S003495/1.