================================= Welcome to wflow's documentation! ================================= .. note:: $Id: index.rst 908 2014-01-16 11:42:57Z schelle $ $HeadURL: https://repos.deltares.nl/repos/Hydrology/trunk/OpenStreams/doc/wflow/sphinx/index.rst $ This documentation is for version |version| of wflow, release |release| This documentation was generated |today| Introduction ============ This document describes the wflow distributed hydrological modelling platform. wflow is part of the Deltares' OpenStreams project (http://www.openstreams.nl). Wflow consists of a set of python programs that can be run on the command line and perform hydrological simulations. The models are based on the PCRaster python framework. In wflow this framework is extended (the ``wf_DynamicFramework`` class) so that models build using the framework can be controlled using the API. Links to OpenMI (www.openmi.org) and OpenDAP (www.openda.org) are being tested. The wflow distributed hydrological model platform currently includes the following models: - the wflow\_sbm model (derived from `topog\_sbm `_ ) - the wflow\_hbv model (a distributed version of the HBV96 model). - the wflow\_gr4 model (a distributed version of the gr4h/d models). - the wflow\_wave model (a dynamic wave model that can run on the output of the sbm and hbv models). - the wflow\_floodmap model (a flood mapping model that can use the output of the wflow\_wave model or de sbm and hbv models). The low level api and links to other frameworks allow the models to be linked as part of larger modelling systems: .. digraph:: Linking WFLOW_HBV -> WFLOWAPI; WFLOW_SBM -> WFLOWAPI; WFLOWAPI -> "PI" [dir=both]; "Data and Models" -> "PI"; WFLOWAPI -> OpenMI [dir=both]; ModelX -> OpenMI; ModelY -> OpenMI; WFLOWAPI -> OpenDA [dir=both]; Calibration -> OpenDA; Assimilation -> OpenDA; WFLOWAPI [shape=square]; OpenDA [shape=square]; OpenMI [shape=square]; "PI" [shape=square]; dpi=69; .. note:: wflow is part of the Deltares OpenStreams project (http://www.openstreams.nl). The OpenStreams project is a work in progress. Wflow functions as a toolkit for distributed hydrological models within OpenStreams. .. warning:: At the moment the models and documentation are being worked on. Things that worked yesterday may stop working tomorrow. The different wflow models share the same structure but are fairly different with respect to the conceptualisation. The shared software framework includes the basic maps (dem, landuse, soil etc) and the hydrological routing via the kinematic wave. The Python class framework also exposes the models as an API and is based on the PCRaster/Python version 4.0 Beta (www.pcraster.eu). The wflow\_sbm model maximises the use of available spatial data. Soil depth, for example, is estimated from the DEM using a topographic wetness index . The model is derived from the [CQFLOW]_ model that has been applied in various countries, most notably in Central America. The wflow\_hbv model is derived from the HBV-96 model but does not include the routing functions, instead it uses the same kinematic wave routine as the wflow\_sbm model to route the water downstream. The models are programmed in a dynamic GIS language called PCRaster available as a Python extension. As such, the structure of the model is transparent, can be changed by other modellers easily, and the system allows for rapid development. The PCRaster version used here is a beta version that comes with bindings to the Python language. In order to run the model both PCRaster and Python 2.7 are needed. .. only:: html .. note:: A pdf version of this version of the documentation can be found at (http://publicwiki.deltares.nl/download/attachments/76613461/wflow.pdf) .. only:: latex .. note:: A html version of this version of the documentation can be found at (http://schj.home/xs4all.nl/html) or zipped at (http://publicwiki.deltares.nl/download/attachments/76613461/wflow_html.zip) The wflow\_hbv model ==================== .. toctree:: :maxdepth: 2 wflow_hbv The wflow\_sbm model ==================== .. toctree:: :maxdepth: 2 wflow_sbm The wflow\_gr4 model ==================== .. toctree:: :maxdepth: 2 wflow_gr4 The wflow\_wave model ===================== .. toctree:: :maxdepth: 2 wflow_wave The wflow\_floodmap model ========================= .. toctree:: :maxdepth: 2 wflow_floodmap The wflow Delft-FEWS adapter ============================ .. toctree:: :maxdepth: 2 wflow_adapt Building a model ================ .. toctree:: :maxdepth: 1 wflow_building How to use the models ===================== .. toctree:: :maxdepth: 2 wflow_usage wflow modules and libraries =========================== .. toctree:: :maxdepth: 2 wflow_fit wflow_lib wflow_delwaq Examples and tests ================== .. toctree:: :maxdepth: 2 testrunner_wflowhbv calib_report Adding a new model using the framework ====================================== .. toctree:: :maxdepth: 2 framework wf_DynamicFramework FAQ === .. toctree:: :maxdepth: 2 faq OpenDA ====== .. toctree:: :maxdepth: 2 wflow_openda Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` References ========== .. [CQFLOW] Köhler, L., Mulligan, M., Schellekens, J., Schmid, S. and Tobón, C.: Final Technical Report DFID-FRP Project no. R7991 Hydrological impacts of converting tropical montane cloud forest to pasture, with initial reference to northern Costa Rica.,, 2006. TODO ==== .. todolist::