ewatercycle/wflow repository overview

⁠WFLOW

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) so that models build using the framework can be controlled using the API. Links to BMI, OpenMI and OpenDAP have been made.

A link to the latest version can always be found at https://github.com/openstreams/wflow⁠

Reference documentation at:

• http://wflow.readthedocs.io/en/latest/⁠

⁠Obtaining wflow

Go to https://github.com/openstreams/wflow⁠. There you can download the source or a release. Also make sure you get the required third party models first (see below). The documentation can be found at http://wflow.readthedocs.org⁠

⁠Which version to use

The master branch can change rapidly (and break functionality without warning) so please use one of the releases if possible. If you want to adjust things in the model(s) we assume you should be comfortable using the master branch.

⁠Binaries for windows

For windows binaries check the releases (https://github.com/openstreams/wflow/releases⁠). These can be used if you do not have a python installation. However, it is recommended to install wflow as a python package (see below). There is absolutely no guarantee the executables will work on your computer.

⁠Install as a python package (windows quick install instructions)

Installing Anaconda (scientific python distribution)

Download Anaconda for python 2.7 64 bit (Tested with anaconda2 2.5.0). From the Anaconda installer choose the following options:

• Install to c:\Anaconda
• Register as default python
• Add to path

Once Anaconda is installed open a command window and install netCDF4, gdal and pyproj using the following commands:

• conda install netCDF4
• conda install gdal
• conda install pyproj

Installing pcraster

• Download pcraster from www.pcraster.eu⁠ website (version 4.1 64 bit)
• Extract zip to root of c: This will create c:\pcraster-4.1.0_x86-64
• Add c:\pcraster-4.1.0_x86-64\python to the PYTHONPATH environment variable

Installing wflow itself

Clone with git or download the latest zip with the source code of wflow. Go to the wflow-py directory and run:

• python setup.py install

To check it the install is successful, go to the examples directory and run the following command:

• python c:\Anaconda\Scripts\wflow_sbm.py -C wflow_rhine_sbm -R testing

This should run without errors

⁠Running wflow_sbm from docker

To run the above from the docker container, get the docker image by either installing docker and running docker buid . in your local repository directory. Alternatively, download the image from docker hub by typing

• docker pull ewatercycle/wflow

After obtaining the docker image, run it by typing

• docker run -v :/data ewatercycle/wflow -R testing

This will create a (root-owned) subdirectory 'testing' in your data path with the model output.

⁠Credits

• The stats.py script was made by Keith Cherkauer (https://engineering.purdue.edu/~cherkaue/software.htm⁠)

• pcraster is developed and maintained by Utrecht University (http://www.pcraster.eu⁠)

• netCDF4 is developed by unidata (http://unidata.github.io/netcdf4-python/⁠)

• GDAL is released under an X/MIT style Open Source license by the Open Source Geospatial Foundation (http://www.gdal.org⁠).

⁠Citation

See doi of the release you use. If you use a snapshot of the development (without a DOI) cite as follows:

Jaap Schellekens, Willem van Verseveld, Tanja Euser, Hessel Winsemius, Christophe Thiange, Laurene Bouaziz, Daniel Tollenaar, Sander de Vries, Albrecht Weerts, YEAR. openstreams/wflow: unstable-master. https://github.com/openstreams/wflow⁠, obtained: DATE_OF_DOWNLOAD

⁠Recent releases

.. image:: https://zenodo.org/badge/17738134.svg⁠ :target: https://zenodo.org/badge/latestdoi/17738134⁠

Jaap Schellekens, Willem van Verseveld, Tanja Euser, Hessel Winsemius, Christophe Thiange, Laurene Bouaziz, Daniel Tollenaar, Sander de Vries, 2016. openstreams/wflow: 2016.04 Test release. doi:10.5281/zenodo.167057

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.155389.svg⁠ :target: https://doi.org/10.5281/zenodo.155389⁠

Jaap Schellekens, Willem van Verseveld, Tanja Euser, Hessel Winsemius, Christophe Thiange, Laurène Bouaziz, Daniel Tollenaar, Sander de Vries, 2016. openstreams/wflow: 2016.03. doi:10.5281/zenodo.155389