Parameter

class rameau.core.Parameter(value=0.0, opti=False, lower=0.0, upper=0.0, sameas=0)

Physical parameter.

Parameters:

• value (float, optional) – Parameter value.

• opti (bool, optional) – True for optimising the parameter.

• lower (float, optional) – Lower bound value in case of bound-constrained optimisation.

• upper (float, optional) – Upper bound value in case of bound-constrained optimisation.

• sameas (int, optional) – Watershed identifier to which this parameter must be equal when running an optimisation. A value of zero means an independent parameter value.

Returns:

Parameter

Examples

A minimal working example is shown below:

>>> p = rm.Parameter(value=2, opti=True, lower=-0.2, upper=0.2)
>>> p.value
2.0

Attributes

lower	Float descriptor.
opti	Bool descriptor.
sameas	Integer descriptor.
upper	Float descriptor.
value	Float descriptor.