The wflow_W3RA Model

Warning

The documentation of this model is incomplete

Introduction

Dependencies

Configuration

It needs a number of settings in the ini file. The default name for the file is wflow_W3RA.ini.

See below for an example:

wflow_W3RA module documentation

Definition of the wflow_W3RA model.

The model is modified from the Australian Water Resources Assessment Landscape (AWRA-L) model version 0.5

W3RA is documented in van Dijk et al. (2013), Water Resour. Res., 49, 2729-2746, doi:10.1002/wrcr.20251 URL: http://onlinelibrary.wiley.com/doi/10.1002/wrcr.20251/abstract More comprehensive documentation of AWRA-L version 0.5 can be found in:

Van Dijk, A.I.J.M. (2010) The Australian water resources assessment system (version 0.5), 3.0.5.Technical description of the landscape hydrology model (AWRA-L). WIRADA Technical Report, CSIRO Water for a Healthy Country Flagship, Canberra. URL: http://www.clw.csiro.au/publications/waterforahealthycountry/2010/wfhc-aus-water-resources-assessment-system.pdf The section references below refer to the sections in the AWRA-L report. Changes compared to that code are indicated, e.g. by commenting out redundant code.

Further question please contact albert.vandijk@anu.edu.au Port to Python/PCRaster: Deltares

Usage: wflow_W3RA -C case -R Runid -c inifile

-C: set the name of the case (directory) to run

-R: set the name runId within the current case

-c name of the config file (in the case directory)

$Author$ $Id$ $Rev$

class wflow_W3RA.WflowModel(cloneMap, Dir, RunDir, configfile)

Bases: pcraster.framework.dynamicPCRasterBase.DynamicModel

The user defined model class. T

default_summarymaps()

Optional

Return a default list of variables to report as summary maps in the outsum dir.

dynamic()

Required

This is where all the time dependent functions are executed. Time dependent output should also be saved here.

initial()

Required

Initial part of the model, executed only once. It reads all static model information (parameters) and sets-up the variables used in modelling.

This function is required. The contents is free. However, in order to easily connect to other models it is advised to adhere to the directory structure used in the other models.

resume()

Required

This function is required. Read initial state maps (they are output of a previous call to suspend()). The implementation shown here is the most basic setup needed.

stateVariables()

Required

Returns a list of state variables that are essential to the model. This list is essential for the resume and suspend functions to work.

This function is specific for each model and must be present. This is where you specify the state variables of you model. If your model is stateless this function must return and empty array (states = [])

suspend()

Required

Suspends the model to disk. All variables needed to restart the model are saved to disk as pcraster maps. Use resume() to re-read them

This function is required.

wflow_W3RA.main(argv=None)

Optional

Perform command line execution of the model. This example uses the getopt module to parse the command line options.

The user can set the caseName, the runDir, the timestep and the configfile.

wflow_W3RA.usage(*args)