v0.44.0
Contributors to this version: Éric Dupuis (@coxipi), Trevor James Smith (@Zeitsperre), Pascal Bourgault (@aulemahal), Ludwig Lierhammer (@ludwiglierhammer), David Huard (@huard).
Announcements
xclim: xarray-based climate data analytics
has been published in the Journal of Open Source Software (DOI:10.21105/joss.05415). Users can now make use of theCite this repository
button in the sidebar for academic purposes. Many thanks to our core developers and user base for their fine contributions over the years! (GH/95, PR/250).xclim
now officially supports Python3.11. (PR/1388).
New indicators
- Several new indices and indicators:
snowfall_{frequency | intensity}
for calculating the {percentage of | mean snowfall intensity on} days with snowfall above a threshold. (GH/1352, PR/1358){sfcWind | sfcWindmax}_{max | mean | min}
for calculating the {max | mean | min} daily {mean | max} wind speed. (GH/1352, PR/1358){precip | liquid_precip | solid_precip}_average}
for calculating the mean daily {total precipitation | liquid precipitation | solid precipitation } amount. (GH/1352, PR/1358){cold | dry}_spell_max_length
for calculating maximum length of {cold | dry} spell events. (GH/1352, PR/1359).dry_spell_frequency
for calculating total number of dry spells. (GH/1352, PR/1359).hardiness_zones
with supported methods"usda"
(USA) and"anbg"
(Australia) for calculating hardiness classifications from climatologies. (GH/1290, PR/1396).
- New indicator
late_frost_days
for calculating the number of days where the daily minimum temperature is below a threshold over a given time period. (GH/1352, PR/1361).
New features and enhancements
xclim.sdba.processing.escore
performance was improved with a faster runtime (PR/1360).- New generic function (
flux_and_rate_converter
) converting flux to a rate (and vice-versa) using a density.snw_to_snd
andsnd_to_snw
were refactored using this function. (GH/1352, PR/1358) - New function (
prsn_to_prsnd
) to convert snowfall flux ([mass] / [area] / [time]) to snowfall rate ([length] / [time]) using snow density ([mass] / [volume]). (GH/1352, PR/1358) - New variables: Snowfall rate
prsnd
and surface maximum wind speedsfcWindmax
. (GH/1352, PR/1358). - Docstring for
freq
links to pandas offset aliases documentation. (GH/1310, PR/1392). - New function
xclim.indces.run_length.extract_events
for determining runs whose starting and stopping points are defined through run length conditions. (PR/1256). - Stats functions
frequency_analysis
now takesmethod
parameter to select other fitting methods such as PWM or MOM. (GH/1168, PR/1398). xclim.indices.frost_days
now accepts an**indexer
parameter for calculating frost days over a temporal subset of the given dataset. (GH/1352, PR/1361).- New function
xclim.indices.generic.get_zones
attributing a histogram bin index (a zone) to each value in an input array. (GH/1290, PR/1396).
Bug fixes
- Fixed a bug in
xclim.core.calendar.time_bnds
when usingDataArrayResample
objects, caused by an upstream change in xarray 2023.5.0. (GH/1368, PR/1377). ensembles.change_significance
will returns NaNs when the input values are all NaNs, instead of failing. (GH/1379, PR/1380).- Accelerated import of xclim by caching the compilation of
guvectorize
functions. (PR/1378). - Fixed many issues with
xclim.indices.helpers.cosine_of_solar_zenith_angle
, the signature changed. (GH/1110, PR/1399).
Internal changes
- In order to ensure documentation can be rebuilt at a later time, errors raised by
sphinx
linkcheck are now set to be ignored when building the documentation. (PR/1375). - With the publication of
xclim
, the code repository now offers aCITATION.cff
configuration for users to properly cite the software (APA formatted and raw BibTeX) for academic purposes. (GH/95, PR/250). - Logging messages emitted when redefining units via
pint
(caused bylogging
interactions with dependencies) have been silenced. (GH/1373, PR/1384). - Fixed some annotations and
dev
recipe dependencies issues to allow for the development of xclim inside a python3.11 environment. (GH/1376, PR/1381). - The deprecated
mamba-org/provision-with-micromamba
GitHub Action has been replaced withmamba-org/setup-micromamba
. (PR/1388). xclim
GitHub CI workflows now run builds against Python3.11. (PR/1388).- In indices, verify that all parameters of type
Quantified
that have a default value have their dimension declared. (GH/1293, PR/1393). - Updated
roy_extremeprecip_2021
to the newly published paper. (PR/1394). - Two new GitHub CI Actions have been added to the existing Workflows (PR/1390):
actions/add-to-project
: Automatically adds issues to thexclim
project.saadmk11/github-actions-version-updater
: Updates GitHub Action versions in all Workflows (triggered monthly).
- Added
method
parameter tofrequency_analysis
andfa
. (GH/1168, PR/1398).