xscen.xclim_modules package
An xclim extension module.
Submodules
xscen.xclim_modules.conversions module
Conversion functions for when datasets are missing particular variables and that xclim doesn’t already implement.
- xscen.xclim_modules.conversions.dtr_from_minmax(tasmin, tasmax)[source]
DTR computed from tasmin and tasmax.
DTR as tasmin subtracted from tasmax.
- Parameters:
tasmin (xr.DataArray) – Daily minimal temperature.
tasmax (xr.DataArray) – Daily maximal temperature.
- Return type:
- Returns:
xr.DataArray – Daily temperature range.
- xscen.xclim_modules.conversions.hurs_from_hurslogit(hurslogit)[source]
Hurslogit computed from hurs.
- Parameters:
hurslogit (xr.DataArray) – Daily relative humidity in logit space.
- Return type:
- Returns:
xr.DataArray – Daily relative humidity.
Notes
This converts the range of hurslogit from ]-np.inf, np.inf[ to [0,100].
- xscen.xclim_modules.conversions.hurslogit_from_hurs(hurs)[source]
Hurslogit computed from hurs.
- Parameters:
hurs (xr.DataArray) – Daily relative humidity.
- Return type:
- Returns:
xr.DataArray – Hurslogit.
Notes
This converts the range of hurs from [0,100] to ]-np.inf, np.inf[.
- xscen.xclim_modules.conversions.orog_from_z(z)[source]
Orography computed from geopotential ‘z’.
- Parameters:
z (xr.DataArray) – Geopotential ‘z’.
- Return type:
- Returns:
xr.DataArray – Orography.
Notes
This converts geopotential in m2 s-2 to orography in m by dividing by standard gravity (9.80665 m s-2). Reference: https://codes.ecmwf.int/grib/param-db/129.
- xscen.xclim_modules.conversions.precipitation(prsn, prlp)[source]
Precipitation of all phases.
Compute the precipitation flux from all phases by adding solid and liquid precipitation.
- Parameters:
prsn (xr.DataArray) – Solid precipitation flux.
prlp (xr.DataArray) – Liquid precipitation flux.
- Return type:
- Returns:
xr.DataArray, [same as prsn] – Surface precipitation flux (all phases).
- xscen.xclim_modules.conversions.tas_midpoint(tasmin, tasmax)
Average temperature from minimum and maximum temperatures.
We assume a symmetrical distribution for the temperature and retrieve the average value as Tg = (Tx + Tn) / 2.
- Parameters:
tasmin (xarray.DataArray) – Minimum (daily) Temperature.
tasmax (xarray.DataArray) – Maximum (daily) Temperature.
- Return type:
- Returns:
xarray.DataArray – Mean (daily) Temperature [same units as tasmin].
Examples
>>> from xclim.indices import tas >>> tas = tas(tasmin_dataset, tasmax_dataset)
- xscen.xclim_modules.conversions.tasmax_from_dtr(dtr, tasmin)[source]
Tasmax computed from DTR and tasmin.
Tasmax as dtr added to tasmin.
- Parameters:
dtr (xr.DataArray) – Daily temperature range.
tasmin (xr.DataArray) – Daily minimal temperature.
- Return type:
- Returns:
xr.DataArray, [same as tasmin] – Daily maximum temperature.
- xscen.xclim_modules.conversions.tasmin_from_dtr(dtr, tasmax)[source]
Tasmin computed from DTR and tasmax.
Tasmin as dtr subtracted from tasmax.
- Parameters:
dtr (xr.DataArray) – Daily temperature range.
tasmax (xr.DataArray) – Daily maximal temperature.
- Return type:
- Returns:
xr.DataArray, [same as tasmax] – Daily minimum temperature.