Difference between revisions of "Worldfiles"

From Rhessys
Jump to navigationJump to search
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Be warned that the grass2world parser program is not very flexible when it comes to file layout, so be
+
Be warned that the grass2world parser program is not flexible when it comes to file layout, so be
−
careful when creating your template files. The template file is parsed based on the order in which variables occur, and all fields must be specified. A world file consists of three parts.  First, there are two dates giving the start and end time of the simulation. Second, is a list of support files, such as def files and met station information that grass2world must incorporate. The last and largest section, sets initial values for various  
+
careful when creating your template files. The template file is parsed based on the order in which variables occur, and all fields must be specified.  
 +
 
 +
<pre>
 +
WARNING!
 +
Worldfiles are currently incompatible between minor version releases of RHESSys. This means if your worldfile runs under
 +
5.13, then it will probably not run under 5.14.
 +
</pre>
 +
 
 +
A world file consists of three parts.  First, there are two dates giving the start and end time of the simulation. Second, is a list of support files, such as def files and met station information that grass2world must incorporate. The last and largest section, sets initial values for various  
 
parameters at various spacial levels. A generic template file would be layed out like so:     
 
parameters at various spacial levels. A generic template file would be layed out like so:     
 
<pre>
 
<pre>
−
start date <year month day hour>
+
<start date: year month day hour>
−
end date <year month day hour>
+
<end date: year month day hour>
 
<number of basin defs>
 
<number of basin defs>
 
..paths to basin defs
 
..paths to basin defs
Line 40: Line 48:
 
| align="center" style="background:#f0f0f0;"|'''Statum Vars'''
 
| align="center" style="background:#f0f0f0;"|'''Statum Vars'''
 
|-
 
|-
−
| x||x||x||x||default_ID
+
| [[basin x|x]]||[[hillslope x|x]]||[[zone x|x]]||[[patch x|x]]||[[stratum default_ID|default_ID]]
 
|-
 
|-
−
| y||y||y||y||cover_fraction
+
| [[basin y|y]]||[[hillslope y|y]]||[[zone y|y]]||[[patch y|y]]||[[cover_fraction]]
 
|-
 
|-
−
| z||z||z||z||gap_fraction
+
| [[basin z|z]]||[[hillslope z|z]]||[[zone z|z]]||[[patch z|z]]||[[gap_fraction]]
 
|-
 
|-
−
| default_ID||default_ID||default_ID||soil_default_ID||root_depth
+
| [[basin default_ID|default_ID]]||[[hillslope default_ID|default_ID]]||[[zone default_ID|default_ID]]||[[patch soil_default_ID|soil_default_ID]]||[[root_depth]]
 
|-
 
|-
−
| latitude||base_flow||a_area||landuse_default_ID||snow_stored
+
| [[latitude]]||[[base_flow]]||[[a_area]]||[[landuse_default_ID]]||[[snow_stored]]
 
|-
 
|-
−
| n_basestations||n_basestations||slope||a_area||rain_stored
+
| [[basin n_basestations|n_basestations]]||[[hillslope n_basestations|n_basestations]]||[[zone slope|slope]]||[[a_area]]||[[rain_stored]]
 
|-
 
|-
−
| ||||aspect||slope||cs_pool
+
| ||||[[aspect]]||[[patch slope|slope]]||[[cs_pool]]
 
|-
 
|-
−
| ||||isohyet||wetness_index||cs_leafc
+
| ||||[[isohyet]]||[[wetness_index]]||[[cs_leafc]]
 
|-
 
|-
−
| ||||east_horizon||Ksat_vertical||cs_dead_leafc
+
| ||||[[East and west horizons|east_horizon]]||[[Ksat_vertical]]||[[cs_dead_leafc]]
 
|-
 
|-
−
| ||||n_basestations||m||cs_leafc_store
+
| ||||[[East and west horizons|west_horizon]]||[[m]]||[[cs_leafc_store]]
 
|-
 
|-
−
| ||||base_station_ID||unsat_storage||cs_leafc_transfer
+
| ||||[[zone n_basestations|n_basestations]]||[[unsat_storage]]||[[cs_leafc_transfer]]
 
|-
 
|-
−
| ||||||sat_deficit||cs_live_stemc
+
| |||||[[base_station_ID]]||[[sat_deficit]]||[[cs_live_stemc]]
 
|-
 
|-
−
| ||||||snowpack_water_equivalent_depth||cs_live_stemc_store
+
| ||||||[[snowpack_water_equivalent_depth]]||[[cs_live_stemc_store]]
 
|-
 
|-
−
| ||||||snowpack_water_depth||cs_live_steamc_transfer
+
| ||||||[[snowpack_water_depth]]||[[cs_live_steamc_transfer]]
 
|-
 
|-
−
| ||||||snowpack_T||cs_dead_stem
+
| ||||||[[snowpack_T]]||[[cs_dead_stem]]
 
|-
 
|-
−
| ||||||snowpack_energy_deficit||cs_dead_stemc_store
+
| ||||||[[snowpack_energy_deficit]]||[[cs_dead_stemc_store]]
 
|-
 
|-
−
| ||||||rain_stored||cs_dead_stemc_transer
+
| ||||||[[rain_stored]]||[[cs_dead_stemc_transer]]
 
|-
 
|-
−
| ||||||litter_cs.litr1c||cs_live_crootc
+
| ||||||[[litter_cs.litr1c]]||[[cs_live_crootc]]
 
|-
 
|-
−
| ||||||litter_ns.litr1n||cs_live_crootc_store
+
| ||||||[[litter_ns.litr1n]]||[[cs_live_crootc_store]]
 
|-
 
|-
−
| ||||||litter_cs.litr2c||cs_live_crootc_transfer
+
| ||||||[[litter_cs.litr2c]]||[[cs_live_crootc_transfer]]
 
|-
 
|-
−
| ||||||litter_cs.litr3c||cs_dead_crootc
+
| ||||||[[litter_cs.litr3c]]||[[cs_dead_crootc]]
 
|-
 
|-
−
| ||||||litter_cs.litr4c||cs_dead_crootc_store
+
| ||||||[[litter_cs.litr4c]]||[[cs_dead_crootc_store]]
 
|-
 
|-
−
| ||||||soil_cs.soils1c||cs_dead_crootc_transfer
+
| ||||||[[soil_cs.soils1c]]||[[cs_dead_crootc_transfer]]
 
|-
 
|-
−
| ||||||soil_ns.sminn||cs_frootc
+
| ||||||[[soil_ns.sminn]]||[[cs_frootc]]
 
|-
 
|-
−
| ||||||soil_ns.nitrate||cs_frootc_store
+
| ||||||[[soil_ns.nitrate]]||[[cs_frootc_store]]
 
|-
 
|-
−
| ||||||soil_cs.soils2c||cs_frootc_transfer
+
| ||||||[[soil_cs.soils2c]]||[[cs_frootc_transfer]]
 
|-
 
|-
−
| ||||||soils_cs.soil3c||cs_cwdc
+
| ||||||[[soils_cs.soil3c]]||[[cs_cwdc]]
 
|-
 
|-
−
| ||||||soil_cs.soil4c||epv.prev_leafcalloc
+
| ||||||[[soil_cs.soil4c]]||[[epv.prev_leafcalloc]]
 
|-
 
|-
−
| ||||||n_basestations||ns_pool
+
| ||||||[[patch n_basestations|n_basestations]]||[[ns_pool]]
 
|-
 
|-
−
| ||||||||ns_leafn
+
| ||||||||[[ns_leafn]]
 
|-
 
|-
−
| ||||||||ns_dead_leafn
+
| ||||||||[[ns_dead_leafn]]
 
|-
 
|-
−
| ||||||||ns_leafn_store
+
| ||||||||[[ns_leafn_store]]
 
|-
 
|-
−
| ||||||||ns_leafn_transfer
+
| ||||||||[[ns_leafn_transfer]]
 
|-
 
|-
−
| ||||||||ns_live_stemn
+
| ||||||||[[ns_live_stemn]]
 
|-
 
|-
−
| ||||||||ns_live_stemn_store
+
| ||||||||[[ns_live_stemn_store]]
 
|-
 
|-
−
| ||||||||ns_live_stemn_transfer
+
| ||||||||[[ns_live_stemn_transfer]]
 
|-
 
|-
−
| ||||||||ns_dead_stem
+
| ||||||||[[ns_dead_stem]]
 
|-
 
|-
−
| ||||||||ns_dead_stemn_store
+
| ||||||||[[ns_dead_stemn_store]]
 
|-
 
|-
−
| ||||||||ns_dead_stemn_transfer
+
| ||||||||[[ns_dead_stemn_transfer]]
 
|-
 
|-
−
| ||||||||ns_live_crootn
+
| ||||||||[[ns_live_crootn]]
 
|-
 
|-
−
| ||||||||ns_live_crootn_store
+
| ||||||||[[ns_live_crootn_store]]
 
|-
 
|-
−
| ||||||||ns_live_crootn_transfer
+
| ||||||||[[ns_live_crootn_transfer]]
 
|-
 
|-
−
| ||||||||ns_dead_crootn
+
| ||||||||[[ns_dead_crootn]]
 
|-
 
|-
−
| ||||||||ns_dead_crootn_store
+
| ||||||||[[ns_dead_crootn_store]]
 
|-
 
|-
−
| ||||||||ns_dead_crootn_transfer
+
| ||||||||[[ns_dead_crootn_transfer]]
 
|-
 
|-
−
| ||||||||ns_frootn
+
| ||||||||[[ns_frootn]]
 
|-
 
|-
−
| ||||||||ns_frootn_store
+
| ||||||||[[ns_frootn_store]]
 
|-
 
|-
−
| ||||||||ns_frootn_transfer
+
| ||||||||[[ns_frootn_transfer]]
 
|-
 
|-
−
| ||||||||ns_cwdn
+
| ||||||||[[ns_cwdn]]
 
|-
 
|-
−
| ||||||||epv_wstress
+
| ||||||||[[epv_wstress]]
 
|-
 
|-
−
| ||||||||epv_min_fparabs
+
| ||||||||[[epv_min_fparabs]]
 
|-
 
|-
−
| ||||||||epv_min_vwc
+
| ||||||||[[epv_min_vwc]]
 
|-
 
|-
−
| ||||||||n_basestations
+
| ||||||||[[stratum n_basestations|n_basestations]]
 
|}
 
|}
  
Line 155: Line 163:
 
| daver||map||Outputs the average integer value in map
 
| daver||map||Outputs the average integer value in map
 
|-
 
|-
−
| aver||map||outputs the average float value in map
+
| aver||map||Outputs the average float value in map
 
|-
 
|-
−
| spavg||map||output the spherical average (float) in map
+
| spavg||map||Output the spherical average (float) in map
 
|-
 
|-
−
| mode||map||outputs the average float value in map
+
| mode||map||Outputs the average float value in map
 
|-
 
|-
−
| area||||outputs the area
+
| area||||Outputs the area
 
|-
 
|-
−
| count||map||outputs the number of categories in map
+
| count||map||Outputs the number of categories in map
 
|-
 
|-
−
| deqn||multiply, add, map||outputs (average integer value in map ) * multiply + add
+
| deqn||multiply, add, map||Outputs (average integer value in map ) * multiply + add
 
|-
 
|-
−
| eqn||multiply add map||outputs (average float value in map ) * multiply + add
+
| eqn||multiply add map||Outputs (average float value in map ) * multiply + add
 
|-
 
|-
−
| dvalue||integer_value||outputs integer_value
+
| dvalue||integer_value||Outputs integer_value
 
|-
 
|-
−
| value||float_value||outputs float_value
+
| value||float_value||Outputs float_value
 
|}
 
|}

Latest revision as of 16:48, 24 November 2009

Be warned that the grass2world parser program is not flexible when it comes to file layout, so be careful when creating your template files. The template file is parsed based on the order in which variables occur, and all fields must be specified. 

WARNING!
Worldfiles are currently incompatible between minor version releases of RHESSys. This means if your worldfile runs under
5.13, then it will probably not run under 5.14.

A world file consists of three parts. First, there are two dates giving the start and end time of the simulation. Second, is a list of support files, such as def files and met station information that grass2world must incorporate. The last and largest section, sets initial values for various parameters at various spacial levels. A generic template file would be layed out like so: 

<start date: year month day hour>
<end date: year month day hour>
<number of basin defs>
..paths to basin defs
<number of hillslope defs>
..paths to hillslope defs
<number of zone defs>
..paths to zone defs
<number of soil defs>
..paths to soils defs
<number of landuse defs>
..paths to landuse defs
<number of vegetation defs>
..paths to vegeation defs
<number of met stations>
..paths to met stations
_world <map> <extent=1>
	_basin <map> <extent=1>
	<basin variable> <function> <parameters>
		_hillslope <map> <extent=1>
		<hillslope variable> <function> <parameters>
			_zone <map> <extent=1>
			<zone variable> <function> <parameters>
				_patch <map> <extent=1>
				<patch variable> <function> <parameters>
					_stratum <map> <extent={integer >0}>
					<stratum variable> <function> <parameters>

Variables

Basin Vars Hillslope Vars Zone Vars Patch Vars Statum Vars
x x x x default_ID
y y y y cover_fraction
z z z z gap_fraction
default_ID default_ID default_ID soil_default_ID root_depth
latitude base_flow a_area landuse_default_ID snow_stored
n_basestations n_basestations slope a_area rain_stored
aspect slope cs_pool
isohyet wetness_index cs_leafc
east_horizon Ksat_vertical cs_dead_leafc
west_horizon m cs_leafc_store
n_basestations unsat_storage cs_leafc_transfer
base_station_ID sat_deficit cs_live_stemc
snowpack_water_equivalent_depth cs_live_stemc_store
snowpack_water_depth cs_live_steamc_transfer
snowpack_T cs_dead_stem
snowpack_energy_deficit cs_dead_stemc_store
rain_stored cs_dead_stemc_transer
litter_cs.litr1c cs_live_crootc
litter_ns.litr1n cs_live_crootc_store
litter_cs.litr2c cs_live_crootc_transfer
litter_cs.litr3c cs_dead_crootc
litter_cs.litr4c cs_dead_crootc_store
soil_cs.soils1c cs_dead_crootc_transfer
soil_ns.sminn cs_frootc
soil_ns.nitrate cs_frootc_store
soil_cs.soils2c cs_frootc_transfer
soils_cs.soil3c cs_cwdc
soil_cs.soil4c epv.prev_leafcalloc
n_basestations ns_pool
ns_leafn
ns_dead_leafn
ns_leafn_store
ns_leafn_transfer
ns_live_stemn
ns_live_stemn_store
ns_live_stemn_transfer
ns_dead_stem
ns_dead_stemn_store
ns_dead_stemn_transfer
ns_live_crootn
ns_live_crootn_store
ns_live_crootn_transfer
ns_dead_crootn
ns_dead_crootn_store
ns_dead_crootn_transfer
ns_frootn
ns_frootn_store
ns_frootn_transfer
ns_cwdn
epv_wstress
epv_min_fparabs
epv_min_vwc
n_basestations

Functions

Name Parameters Description
daver map Outputs the average integer value in map
aver map Outputs the average float value in map
spavg map Output the spherical average (float) in map
mode map Outputs the average float value in map
area Outputs the area
count map Outputs the number of categories in map
deqn multiply, add, map Outputs (average integer value in map ) * multiply + add
eqn multiply add map Outputs (average float value in map ) * multiply + add
dvalue integer_value Outputs integer_value
value float_value Outputs float_value
Retrieved from "http://wiki-rhessys.eri.ucsb.edu/index.php?title=Worldfiles&oldid=324"