name: i.rh description: Water in atmosphere: relative humidity, water vapour (saturated, actual) keywords: [ imagery, atmosphere, humidity, water vapour, precipitable water ]
i.rh
Water in atmosphere: relative humidity, water vapour (saturated, actual)
i.rh [-sae] pw=name pa=name ta=name dem=name output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
i.rh pw=name pa=name ta=name dem=name output=name
grass.script.run_command("i.rh", pw, pa, ta, dem, output, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("i.rh", pw="name", pa="name", ta="name", dem="name", output="name")
grass.tools.Tools.i_rh(pw, pa, ta, dem, output, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.i_rh(pw="name", pa="name", ta="name", dem="name", output="name")
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
pw=name [required]
Name of the Precipitable Water layer
pa=name [required]
Name of the Atmospheric Pressure layer
ta=name [required]
Name of the mean daily air temperature layer
dem=name [required]
Name of the elevation layer
output=name [required]
Name of the output layer
-s
Output the saturated water vapour (esat)
-a
Output the actual water vapour (eact)
-e
Output the atmospheric emissivity (eatm)
--overwrite
Allow output files to overwrite existing files
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
pw : str, required
Name of the Precipitable Water layer
Used as: input, raster, name
pa : str, required
Name of the Atmospheric Pressure layer
Used as: input, raster, name
ta : str, required
Name of the mean daily air temperature layer
Used as: input, raster, name
dem : str, required
Name of the elevation layer
Used as: input, raster, name
output : str, required
Name of the output layer
Used as: output, raster, name
flags : str, optional
Allowed values: s, a, e
s
Output the saturated water vapour (esat)
a
Output the actual water vapour (eact)
e
Output the atmospheric emissivity (eatm)
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
pw : str | np.ndarray, required
Name of the Precipitable Water layer
Used as: input, raster, name
pa : str | np.ndarray, required
Name of the Atmospheric Pressure layer
Used as: input, raster, name
ta : str | np.ndarray, required
Name of the mean daily air temperature layer
Used as: input, raster, name
dem : str | np.ndarray, required
Name of the elevation layer
Used as: input, raster, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
Name of the output layer
Used as: output, raster, name
flags : str, optional
Allowed values: s, a, e
s
Output the saturated water vapour (esat)
a
Output the actual water vapour (eact)
e
Output the atmospheric emissivity (eatm)
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
Returns:
result : grass.tools.support.ToolResult | np.ndarray | tuple[np.ndarray] | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned. If an array type (e.g., np.ndarray) is used for one of the raster outputs, the result will be an array and will have the shape corresponding to the computational region. If an array type is used for more than one raster output, the result will be a tuple of arrays.
DESCRIPTION
i.rh calculates the relative humidity -s will return saturated water vapour instead. -a will return actual water vapour instead.
NOTES
REFERENCES
SEE ALSO
AUTHOR
Yann Chemin, Plumergat, France
SOURCE CODE
Available at: i.rh source code
(history)
Latest change: Friday Feb 21 12:27:42 2025 in commit 8fce680