v0.6.0
History
v0.6.0 (2023-05-04)
Contributors to this version: Trevor James Smith (@Zeitsperre), Juliette Lavoie (@juliettelavoie), Pascal Bourgault (@aulemahal), Gabriel Rondeau-Genesse (@RondeauG).
Announcements
xscen
is now offered as a conda package available through Anaconda.org. Refer to the installation documentation for more information. (GH/149, PR/171).- Deprecation: Release 0.6.0 of
xscen
will be the last version to supportxscen.extract.clisops_subset
. Usexscen.spatial.subset
instead. (PR/182, PR/184). - Deprecation: The argument
region
, used in multiple functions, has been slightly reformatted. Release 0.6.0 ofxscen
will be the last version to support the old format. (GH/99, GH/101, PR/184).
New features and enhancements
- New 'cos-lat' averaging in
spatial_mean
. (GH/94, PR/125). - Support for computing anomalies in
compute_deltas
. (PR/165). - Add function
diagnostics.measures_improvement_2d
. (PR/167). - Add function
regrid.create_bounds_rotated_pole
and automatic use inregrid_dataset
andspatial_mean
. This is temporary, while we wait for a functionning method incf_xarray
. (PR/174, GH/96). - Add
spatial
submodule with functionscreep_weights
andcreep_fill
for filling NaNs using neighbours. (PR/174). - Allow passing
GeoDataFrame
instances inspatial_mean
'sregion
argument, not only geospatial file paths. (PR/174). - Allow searching for periods in
catalog.search
. (GH/123, PR/170). - Allow searching and extracting multiple frequencies for a given variable. (GH/168, PR/170).
- New masking feature in
extract_dataset
. (GH/180, PR/182). - New function
xs.spatial.subset
to replacexs.extract.clisops_subset
and add method "sel". (GH/180, PR/182). - Add long_name attribute to diagnostics. ( PR/189).
- Added a new YAML-centric notebook (GH/8, PR/191).
- New
utils.standardize_periods
to standardize that argument across multiple functions. (GH/87, PR/192). - New
coverage_kwargs
argument added tosearch_data_catalogs
to allow modifying the default values ofsubset_file_coverage
. (GH/87, PR/192).
Breaking changes
- 'mean' averaging has been deprecated in
spatial_mean
. (PR/125). - 'interp_coord' has been renamed to 'interp_centroid' in
spatial_mean
. (PR/125). - The 'datasets' dimension of the output of
diagnostics.measures_heatmap
is renamed 'realization'. (PR/167). _subset_file_coverage
was renamedsubset_file_coverage
and moved tocatalog.py
to prevent circular imports. (PR/170).extract_dataset
doesn't fail when a variable is in the dataset, but notvariables_and_freqs
. (PR/185).- The argument
period
, used in multiple function, is now always a single list, whileperiods
is more flexible. (GH/87, PR/192). - The parameters
reference_period
andsimulation_period
ofxscen.train
andxscen.adjust
were renamedperiod/periods
to respect the point above. (GH/87, PR/192).
Bug fixes
- Forbid pandas v1.5.3 in the environment files, as the linux conda build breaks the data catalog parser. (GH/161, PR/162).
- Only return requested variables when using
DataCatalog.to_dataset
. (PR/163). compute_indicators
no longer crashes if less than 3 timesteps are produced. (PR/125).xarray
is temporarily pinned below v2023.3.0 due to an API-breaking change. (GH/175, PR/173).- `xscen.utils.unstack_fill_nan`` can now handle datasets that have non dimension coordinates. (GH/156, PR/175).
extract_dataset
now skips a simulation way earlier if the frequency doesn't match. (PR/170).extract_dataset
now correctly tries to extract in reverse timedelta order. (PR/170).compute_deltas
no longer creates all NaN values if the input dataset is in a non-standard calendar. (PR/188).
Internal changes
xscen
now manages packaging for PyPi and TestPyPI via GitHub workflows. (PR/159).- Pre-load coordinates in
extract.clisops_subset
(PR/163). - Minimal documentation for templates. (PR/163).
xscen
is now indexed in Zenodo, under theouranos
community of projects. (PR/164).- Added a few relevant Shields to the README.rst. (PR/164).
- Better warning messages in
_subset_file_coverage
when coverage is insufficient. (PR/125). - The top-level Makefile now includes a
linkcheck
recipe, and the ReadTheDocs configuration no longer reinstalls thellvmlite
compiler library. (PR/173). - The checkups on coverage and duplicates can now be skipped in
subset_file_coverage
. (PR/170). - Changed the
ProjectCatalog
docstrings to make it more obvious that it needs to be created empty. (GH/99, PR/184). - Added parse_config to
creep_fill
,creep_weights
, andreduce_ensemble
(PR/191).