rhessyscalibrator.calibration_parameters.CalibrationParameters Class Reference

Represents a set of calibration parameters for a particular run. More...

Inheritance diagram for rhessyscalibrator.calibration_parameters.CalibrationParameters:

Public Member Functions
def	__init__
def	toDict (self)
def	newCalibrationParameters (cls)
	Create a new instance of CalibrationParameters with all parameters set to None – i.e. More...
def	__init__
def	toDict (self)
def	newCalibrationParameters (cls)
	Create a new instance of CalibrationParameters with all parameters set to None – i.e. More...
def	__init__
def	toDict (self)
def	newCalibrationParameters (cls)
	Create a new instance of CalibrationParameters with all parameters set to None – i.e. More...
Public Member Functions inherited from rhessyscalibrator.calibration_parameters.CalibrationParametersProto
def	__init__
def	parseParameterString (self, param_string)
	Parse parameter string for presence and range of all possible calibration parameters. More...
def	setPresenceAndRangeForParameter (self, param_name, param_string)
	Parses param_string for presence and optionally range of parameter param_name. More...
def	generateParameterValues (self)
	Generate random values for parameters specified as True. More...
def	__init__
def	parseParameterString (self, param_string)
	Parse parameter string for presence and range of all possible calibration parameters. More...
def	setPresenceAndRangeForParameter (self, param_name, param_string)
	Parses param_string for presence and optionally range of parameter param_name. More...
def	generateParameterValues (self)
	Generate random values for parameters specified as True. More...
def	__init__
def	parseParameterString (self, param_string)
	Parse parameter string for presence and range of all possible calibration parameters. More...
def	setPresenceAndRangeForParameter (self, param_name, param_string)
	Parses param_string for presence and optionally range of parameter param_name. More...
def	generateParameterValues (self)
	Generate random values for parameters specified as True. More...

Public Attributes
	s1
	s2
	s3
	sv1
	sv2
	gw1
	gw2
	vgsen1
	vgsen2
	vgsen3
	svalt1
	svalt2
	s_for_sv
Public Attributes inherited from rhessyscalibrator.calibration_parameters.CalibrationParametersProto
	s_for_sv
	s1
	s2
	s3
	sv1
	sv2
	gw1
	gw2
	vgsen1
	vgsen2
	vgsen3
	svalt1
	svalt2
	parameterRanges

Detailed Description

Represents a set of calibration parameters for a particular run.

Constructor & Destructor Documentation

def rhessyscalibrator.calibration_parameters.CalibrationParameters.__init__	(		self,
			s1,
			s2,
			s3,
			sv1,
			sv2,
			gw1,
			gw2,
			vgsen1,
			vgsen2,
			vgsen3,
			svalt1,
			svalt2,
			s_for_sv = False
	)

Parameters

s1	Double: decay of hydraulic conductivity with depth (m)
s2	Double: surface hydraulic conductivity (K)
s3	Double: soil depth (OPTIONAL; default=None)
sv1	Double: m to vertical drainage
sv2	Double: K to vertical drainage
gw1	Double: hillslope sat_to_gw_coeff (amount of water moving from saturated to groundwater store)
gw2	Double: hillslope gw_loss_coeff (amount of water moving from groundwater to the stream)
vgsen1	Double: Multiplies specific leaf area (SLA – ratio of leaf area to dry weight)
vgsen2	Double: Multiplies ratio of shaded to sunlit leaf area
vgsen3	Double: changes allocation of net photosynthate based on current LAI (only appl. if using Dickenson C allocation if not using Dickenson, set to 1.0)
svalt1	Double: Multiplies psi air entry pressure
svalt2	Double: Multiplies pore size
s_for_sv	True to use the same m parameter for for horizontal as for vertical. Defaults to false (0).

def rhessyscalibrator.calibration_parameters.CalibrationParameters.__init__	(		self,
			s1,
			s2,
			s3,
			sv1,
			sv2,
			gw1,
			gw2,
			vgsen1,
			vgsen2,
			vgsen3,
			svalt1,
			svalt2,
			s_for_sv = False
	)

Parameters

s1	Double: decay of hydraulic conductivity with depth (m)
s2	Double: surface hydraulic conductivity (K)
s3	Double: soil depth (OPTIONAL; default=None)
sv1	Double: m to vertical drainage
sv2	Double: K to vertical drainage
gw1	Double: hillslope sat_to_gw_coeff (amount of water moving from saturated to groundwater store)
gw2	Double: hillslope gw_loss_coeff (amount of water moving from groundwater to the stream)
vgsen1	Double: Multiplies specific leaf area (SLA – ratio of leaf area to dry weight)
vgsen2	Double: Multiplies ratio of shaded to sunlit leaf area
vgsen3	Double: changes allocation of net photosynthate based on current LAI (only appl. if using Dickenson C allocation if not using Dickenson, set to 1.0)
svalt1	Double: Multiplies psi air entry pressure
svalt2	Double: Multiplies pore size
s_for_sv	True to use the same m parameter for for horizontal as for vertical. Defaults to false (0).

def rhessyscalibrator.calibration_parameters.CalibrationParameters.__init__	(		self,
			s1,
			s2,
			s3,
			sv1,
			sv2,
			gw1,
			gw2,
			vgsen1,
			vgsen2,
			vgsen3,
			svalt1,
			svalt2,
			s_for_sv = False
	)

Parameters

s1	Double: decay of hydraulic conductivity with depth (m)
s2	Double: surface hydraulic conductivity (K)
s3	Double: soil depth (OPTIONAL; default=None)
sv1	Double: m to vertical drainage
sv2	Double: K to vertical drainage
gw1	Double: hillslope sat_to_gw_coeff (amount of water moving from saturated to groundwater store)
gw2	Double: hillslope gw_loss_coeff (amount of water moving from groundwater to the stream)
vgsen1	Double: Multiplies specific leaf area (SLA – ratio of leaf area to dry weight)
vgsen2	Double: Multiplies ratio of shaded to sunlit leaf area
vgsen3	Double: changes allocation of net photosynthate based on current LAI (only appl. if using Dickenson C allocation if not using Dickenson, set to 1.0)
svalt1	Double: Multiplies psi air entry pressure
svalt2	Double: Multiplies pore size
s_for_sv	True to use the same m parameter for for horizontal as for vertical. Defaults to false (0).

Member Function Documentation

def rhessyscalibrator.calibration_parameters.CalibrationParameters.newCalibrationParameters

(

cls

)

Create a new instance of CalibrationParameters with all parameters set to None – i.e.

work around Python's fake OOP implementation's inability to have more than one constructor

Returns

New instance of CalibrationParameters

def rhessyscalibrator.calibration_parameters.CalibrationParameters.newCalibrationParameters

(

cls

)

Create a new instance of CalibrationParameters with all parameters set to None – i.e.

work around Python's fake OOP implementation's inability to have more than one constructor

Returns

New instance of CalibrationParameters

def rhessyscalibrator.calibration_parameters.CalibrationParameters.newCalibrationParameters

(

cls

)

Create a new instance of CalibrationParameters with all parameters set to None – i.e.

work around Python's fake OOP implementation's inability to have more than one constructor

Returns

New instance of CalibrationParameters

def rhessyscalibrator.calibration_parameters.CalibrationParameters.toDict

(

self

)

Returns

Dict representation of this CalibrationParameters object. (Maybe there is a non-lazy Pythonic way to do this)

def rhessyscalibrator.calibration_parameters.CalibrationParameters.toDict

(

self

)

Returns

Dict representation of this CalibrationParameters object. (Maybe there is a non-lazy Pythonic way to do this)

def rhessyscalibrator.calibration_parameters.CalibrationParameters.toDict

(

self

)

Returns

Dict representation of this CalibrationParameters object. (Maybe there is a non-lazy Pythonic way to do this)

Member Data Documentation

rhessyscalibrator.calibration_parameters.CalibrationParameters.gw1

rhessyscalibrator.calibration_parameters.CalibrationParameters.gw2

rhessyscalibrator.calibration_parameters.CalibrationParameters.s1

rhessyscalibrator.calibration_parameters.CalibrationParameters.s2

rhessyscalibrator.calibration_parameters.CalibrationParameters.s3

rhessyscalibrator.calibration_parameters.CalibrationParameters.s_for_sv

rhessyscalibrator.calibration_parameters.CalibrationParameters.sv1

rhessyscalibrator.calibration_parameters.CalibrationParameters.sv2

rhessyscalibrator.calibration_parameters.CalibrationParameters.svalt1

rhessyscalibrator.calibration_parameters.CalibrationParameters.svalt2

rhessyscalibrator.calibration_parameters.CalibrationParameters.vgsen1

rhessyscalibrator.calibration_parameters.CalibrationParameters.vgsen2

rhessyscalibrator.calibration_parameters.CalibrationParameters.vgsen3

---

The documentation for this class was generated from the following file:

• build/lib/rhessyscalibrator/calibration_parameters.py