Table Of Contents
+ +Previous topic
@@ -83,9 +91,637 @@wflow_lib Module¶
+wflow_lib Module¶
+wflow_lib - terrain analysis and hydrological library¶
+The goal of this module is to make a series functions to upscale maps (DEM) +and to maintain as much of the information in a detailled dem when upscaling +to a coarser DEM. These include:
++++
+- river length (per cell)
+- river network location
+- elevation distribution
+- other terrain analysis
+
the wflow_prepare scripts use this library extensively.
+$Author$ +$Id$ +$Rev$
+-
+
- +wflow_lib.Gzip(fileName, storePath=False, chunkSize=1048576)¶ +
Usage: Gzip(fileName, storePath=False, chunksize=1024*1024) +Gzip the given file to the given storePath and then remove the file. +A chunk size may be selected. Default is 1 megabyte +Input:
++
+fileName: file to be GZipped +storePath: destination folder. Default is False, meaning the file will be zipped to its own folder +chunkSize: size of chunks to write. If set too large, GZip will fail with memory problems
-
+
- +wflow_lib.area_percentile(inmap, area, n, order, percentile)¶ +
calculates percentile of inmap per area +n is the number of points in each area, +order, the sorter order of inmap per area (output of +areaorder(inmap,area)) +n is the output of areatotal(spatial(scalar(1.0)),area)
+-
+
- Input: +
-
+
- inmap +
- area map +
- n +
- order (riverorder) +
- percentile +
+- Output: +
-
+
- percentile map +
+
-
+
- +wflow_lib.area_river_burnin(ldd, dem, order, Area)¶ +
Calculates the lowest values in as DEM for each erea in an area map for +river of order order
+-
+
- Input: +
-
+
- ldd +
- dem +
- order +
- Area map +
+- Output: +
-
+
- dem +
+
-
+
- +wflow_lib.area_riverlength_factor(ldd, Area, Clength)¶ +
ceates correction factors for riverlength for +the largest streamorder in each area
+-
+
- Input: +
-
+
- ldd +
- Area +
- Clength (1d length of a cell (sqrt(Area)) +
+- Output: +
-
+
- distance per area +
+
-
+
- +wflow_lib.areastat(Var, Area)¶ +
Calculate several statistics of Var for each unique id in Area
+-
+
- Input: +
-
+
- Var +
- Area +
+- Output: +
-
+
- Standard_Deviation,Average,Max,Min +
+
-
+
- +wflow_lib.checkerboard(mapin, fcc)¶ +
checkerboard create a checkerboard map with unique id’s in a +fcc*fcc cells area. The resulting map can be used +to derive statistics for (later) upscaling of maps (using the fcc factor)
+-
+
- Input: +
-
+
- map (used to determine coordinates) +
- fcc (size of the areas in cells) +
+- Output: +
-
+
- checkerboard type map +
+
-
+
- +wflow_lib.classify(inmap, lower=[0, 10, 20, 30], upper=[10, 20, 30, 40], classes=[2, 2, 3, 4])¶ +
classify a scaler maps accroding to the boundaries given in classes.
+
-
+
- +wflow_lib.configget(config, section, var, default)¶ +
Gets a string from a config file (.ini) and returns a default value if +the key is not found. If the key is not found it also sets the value +with the default in the config-file
+-
+
- Input: +
-
+
- config - python ConfigParser object +
- section - section in the file +
- var - variable (key) to get +
- default - default string +
+- Returns: +
-
+
- string - either the value from the config file or the default value +
+
-
+
- +wflow_lib.configsection(config, section)¶ +
gets the list of lesy in a section
+-
+
- Input: +
-
+
- config +
- section +
+- Output: +
-
+
- list of keys in the section +
+
-
+
- +wflow_lib.configset(config, section, var, value, overwrite=False)¶ +
Sets a string in the in memory representation of the config object +Deos NOT overwrite existing values if overwrite is set to False (default)
+-
+
- Input: +
-
+
- config - python ConfigParser object +
- section - section in the file +
- var - variable (key) to set +
- value - the value to set +
- overwrite (optional, default is False) +
+- Returns: +
-
+
- nothing +
+
-
+
- +wflow_lib.detdrainlength(ldd, xl, yl)¶ +
Determines the drainaige length (DCL) for a non square grid
+-
+
- Input: +
-
+
- ldd - drainage network +
- xl - length of cells in x direction +
- yl - length of cells in y direction +
+- Output: +
-
+
- DCL +
+
-
+
- +wflow_lib.detdrainwidth(ldd, xl, yl)¶ +
Determines width of drainage over DEM for a non square grid
+-
+
- Input: +
-
+
- ldd - drainage network +
- xl - length of cells in x direction +
- yl - length of cells in y direction +
+- Output: +
-
+
- DCL +
+
-
+
- +wflow_lib.find_outlet(ldd)¶ +
Tries to find the outlet of the largest catchment in the Ldd
+-
+
- Input: +
-
+
- Ldd +
+- Output: +
-
+
- outlet map (single point in the map) +
+
-
+
- +wflow_lib.getRowColPoint(in_map, xcor, ycor)¶ +
returns the row and col in a map at the point given. +Works but is rather slow.
+-
+
- Input: +
-
+
- in_map - map to determine coordinates from +
- xcor - x coordinate +
- ycor - y coordinate +
+- Output: +
-
+
- row, column +
+
-
+
- +wflow_lib.getValAtPoint(in_map, xcor, ycor)¶ +
returns the value in a map at the point given. +works but is rather slow.
+-
+
- Input: +
-
+
- in_map - map to determine coordinates from +
- xcor - x coordinate +
- ycor - y coordinate +
+- Output: +
-
+
- value +
+
-
+
- +wflow_lib.getcols()¶ +
returns the number of columns in the current map
+-
+
- Input: +
-
+
-
+
+
+
+- Output: +
-
+
- nr of columns in the current clonemap as a scalar +
+
-
+
- +wflow_lib.getgridparams()¶ +
return grid parameters in a python friendly way
+-
+
- Output: +
[ Xul, Yul, xsize, ysize, rows, cols]
+-
+
- xul - x upper left centre +
- yul - y upper left centre +
- xsize - size of a cell in x direction +
- ysize - size of a cell in y direction +
- cols - number of columns +
- rows - number of rows +
+
-
+
- +wflow_lib.getrows()¶ +
returns the number of rows in the current map
+-
+
- Input: +
-
+
-
+
+
+
+- Output: +
-
+
- nr of rows in the current clonemap as a scalar +
+
-
+
- +wflow_lib.hand(dem, ldd, threshold=50.0, stream=None)¶ +
Determines heigth above nearest drain.
+-
+
- Input: +
- ldd +dem +Optional: +threshold - to determine streams (number of upstreams cell needed to be a stream) +stream - if the threshols is not a stream map (boolean) should be supplied +
Returns: Hand and the stream map
+
-
+
- +wflow_lib.lddcreate_save(lddname, dem, force, corevolume=1e+35, catchmentprecipitation=1e+35, corearea=1e+35, outflowdepth=1e+35)¶ +
Creates an ldd if a file does not exists or if the force flag is used
+-
+
- input: +
-
+
- lddname (name of the ldd to create) +
- dem (actual dem) +
- force (boolean to force recreation of the ldd) +
- outflowdepth (set to 10.0E35 normally but smaller if needed) +
+- Output: +
-
+
- the LDD +
+
-
+
- +wflow_lib.points_to_map(in_map, xcor, ycor, tolerance)¶ +
Returns a map with non zero values at the points defined +in X, Y pairs. It’s goal is to replace the pcraster col2map program.
+tolerance should be 0.5 to select single points +Performance is not very good and scales linear with the number of points
+-
+
- Input: +
-
+
- in_map - map to determine coordinates from +
- xcor - x coordinate (array or single value) +
- ycor - y coordinate (array or single value) +
- tolerance - tolerance in cell units. 0.5 selects a single cell 10 would select a 10x10 block of cells +
+- Output: +
-
+
- Map with values burned in. 1 for first point, 2 for second and so on +
+
-
+
- +wflow_lib.readMap(fileName, fileFormat)¶ +
Read geographical file into memory
+
-
+
- +wflow_lib.riverlength(ldd, order)¶ +
Determines the length of a river using the ldd. +only determined for order and higher.
+-
+
- Input: +
-
+
- ldd, order (streamorder) +
+- Returns: +
-
+
- totallength,lengthpercell, streamorder +
+
-
+
- +wflow_lib.sCurve(X, a=0.0, b=1.0, c=1.0)¶ +
sCurve function:
+-
+
- Input: +
-
+
- X input map +
- C determines the steepness or “stepwiseness” of the curve. +The higher C the sharper the function. A negative C reverses the function. +
- b determines the amplitude of the curve +
- a determines the centre level (default = 0) +
+- Output: +
-
+
- result +
+
-
+
- +wflow_lib.sCurveSlope(X, a=0.0, b=1.0, c=1.0)¶ +
First derivitive of the sCurve defined by a,b,c at point X
+-
+
- Input: +
-
+
- X - value to calculate for +
- a +
- b +
- c +
+- Output: +
-
+
- first derivitive (slope) of the curve at point X +
+
-
+
- +wflow_lib.snaptomap(points, mmap)¶ +
Snap the points in _points_ to nearest non missing +values in _mmap_. Can be used to move gauge locations +to the nearest rivers.
+-
+
- Input: +
-
+
- points - map with points to move +
- mmap - map with points to move to +
+- Return: +
-
+
- map with shifted points +
+
-
+
- +wflow_lib.subcatch(ldd, outlet)¶ +
Determines a subcatchment map using LDD and outlet(s). In the resulting +subcatchment map the i’s of the catchment are determiend by the id’s of +the outlets.
+-
+
- Input: +
-
+
- ldd +
- Outlet - maps with points for each outlet. +
+- Output: +
-
+
- map of subcatchments +
+
-
+
- +wflow_lib.subcatch_order_a(ldd, oorder)¶ +
Determines subcatchments using the catchment order
+This version uses the last cell BELOW order to derive the +catchments. In general you want the _b version
+-
+
- Input: +
-
+
- ldd +
- order - order to use +
+- Output: +
-
+
- map with catchment for the given streamorder +
+
-
+
- +wflow_lib.subcatch_order_b(ldd, oorder, Largest=False, sizelimit=0)¶ +
Determines subcatchments using the catchment order
+This version uses the bottommost cell of order +If Largest is true the analysis is only done for the largest basin +found in the ldd
+-
+
- Input: +
-
+
- ldd +
- oorder - order to use +
- largest - toggle, default = False +
- sizelimit - smallest catchments to include, default is all (sizelimit=0) in number of cells +
+- Output: +
-
+
- map with catchment for the given streamorsder +
+
-
+
- +wflow_lib.upscale_riverlength(ldd, order, factor)¶ +
Upscales the riverlength using ‘factor’ +The resulting maps can be resampled (e.g. using resample.exe) by factor and should +include the accurate length as determined with the original higher +resolution maps. This function is depricated, +use are_riverlength instead as this version +is very slow for large maps
+-
+
- Input: +
-
+
- ldd +
- minimum streamorder to include +
+- Output: +
-
+
- distance per factor cells +
+
-
+
- +wflow_lib.writeMap(fileName, fileFormat, x, y, data, FillVal)¶ +
Write geographical data into file
+
-
+
- +wflow_lib.zipFiles(fileList, fileTarget)¶ +
Usage: zipFiles(fileList, fileTarget) +zip the given list of files to the given target file +Input:
++
+fileList: list of files to be zipped +fileTarget: target zip-file
wflow_routing module documentation¶
+wflow_routing module documentation¶
+Run the wflow_routing model..
+usage
+wflow_routing [-h][-v level][-F runinfofile][-L logfile][-C casename][-R runId]
+ [-c configfile][-T last_step][-S first_step][-s seconds][-l loglevel]
+
+-F: if set wflow is expected to be run by FEWS. It will determine
+ the timesteps from the runinfo.xml file and save the output initial
+ conditions to an alternate location. Also set fewsrun=1 in the .ini file!
+
+-X: save state at the end of the run over the initial conditions at the start
+
+-T: Set last timestep
+
+-S: Set the start timestep (default = 1)
+
+-s: Set the model timesteps in seconds
+
+-I: re-initialize the initial model conditions with default
+
+-C: set the name of the case (directory) to run
+
+-R: set the name runId within the current case
+
+-L: set the logfile
+
+-c: name of wflow the configuration file (default: Casename/wflow_routing.ini).
+
+-h: print usage information
+
+-l: loglevel (most be one of DEBUG, WARNING, ERROR)
+$Author$ +$Id$ +$Rev$
+-
+
- +class wflow_routing.WflowModel(cloneMap, Dir, RunDir, configfile)¶ +
Bases: pcraster.framework.dynamicPCRasterBase.DynamicModel
+++Changed in version 0.1: - initial version.
-
+
- +default_summarymaps()¶ +
Returns a list of default summary-maps at the end of a run. +This is model specific. You can also add them to the [summary]section of the ini file but stuff +you think is crucial to the model should be listed here
+
-
+
- +dynamic()¶ +
Stuf that is done for each timestep
+Below a list of variables that can be save to disk as maps or as +timeseries (see ini file for syntax):
+Dynamic variables
++
++ + + Variables: -
+
- self.SurfaceRunoff – Surface runoff in the kinematic wave [m^3/s] +
- self.WaterLevel – Water level in the kinematic wave [m] (above the bottom) +
Static variables
++
++ + + Variables: -
+
- self.Altitude – The altitude of each cell [m] +
- self.Bw – Width of the river [m] +
- self.River – booolean map indicating the presence of a river [-] +
- self.DLC – length of the river within a cell [m] +
- self.ToCubic – Mutiplier to convert mm to m^3/s for fluxes +
-
+
- +initial()¶ +
Initial part of the model, executed only once. Reads all static data from disk
+Surface water
++
++ + + Variables: -
+
- N.tbl – Manning’s N parameter +
- N_river.tbl – Manning’s N parameter fro cells marked as river +
-
+
- +resume()¶ +
-
+
- +stateVariables()¶ +
+
+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.
++
++ + + Variables: -
+
- self.SurfaceRunoff – Surface runoff in the kin-wave resrvoir [m^3/s] +
- self.WaterLevel – Water level in the kin-wave resrvoir [m] +
-
+
- +supplyCurrentTime()¶ +
gets the current time in seconds after the start of the run
+
-
+
- +suspend()¶ +
-
+
- +updateRunOff()¶ +
Updates the kinematic wave reservoir. Should be run after updates to Q
+
-
+
- +wflow_routing.main(argv=None)¶ +
Perform command line execution of the model.
+
-
+
- +wflow_routing.usage(*args)¶ +