v0.7.0
v0.7.0 (2023-08-22)
Contributors to this version: Gabriel Rondeau-Genesse (@RondeauG), Pascal Bourgault (@aulemahal), Trevor James Smith (@Zeitsperre), Juliette Lavoie (@juliettelavoie), Marco Braun (@vindelico).
Announcements
- Dropped support for Python 3.8, added support for 3.11. (PR/199, PR/222).
xscen
is now available onconda-forge <https://anaconda.org/conda-forge/xscen>
_, and can be installed withconda install -c conda-forge xscen
. (PR/241)
New features and enhancements
xscen
now tracks code coverage using coveralls. (PR/187).- New function
get_warming_level
to search within the IPCC CMIP global temperatures CSV without requiring data. (GH/208, PR/210). - File re-structuration from catalogs with
xscen.catutils.build_path
. (PR/205, PR/237). - New scripting functions
save_and_update
andmove_and_delete
. (PR/214). - Spatial dimensions can be generalized as X/Y when rechunking and will be mapped to rlon/rlat or lon/lat accordingly. (PR/221).
- New argument
var_as_string
forget_cat_attrs
to return variable names as strings. (PR/233). - New argument
copy
formove_and_delete
. (PR/233). - New argument
restrict_year
forcompute_indicators
. (PR/233). - Add more comments in the template. (PR/233, GH/232).
generate_weights
now allows to split weights between experiments, and make them vary along the time/horizon axis. (GH/108, PR/231).- New independence_level,
institution
, added togenerate_weights
. (PR/231). - Updated
produce_horizon
so it can accept multiple periods or warming levels. (PR/231, PR/240). - Add more comments in the template. (PR/233, PR/235, GH/232).
- New function
diagnostics.health_checks
that can perform multiple checkups on a dataset. (PR/238).
Breaking changes
- Columns
date_start
anddate_end
now use adatetime64[ms]
dtype. (PR/222). - The default output of
date_parser
is nowpd.Timestamp
(output_dtype='datetime'
). (PR/222). date_parser(date, end_of_period=True)
has time "23:59:59", instead of "23:00". (PR/222, PR/237).driving_institution
was removed from the "default" xscen columns. (PR/222).- Folder parsing utilities (
parse_directory
) moved toxscen.catutils
. Signature changed :globpattern
removed,dirglob
added, newpatterns
specifications. See doc for all changes. (PR/205). compute_indicators
now returns all outputs produced by indicators with multiple outputs (such asrain_season
). (PR/228).- In
generate_weights
, independence_levelall
was renamedmodel
. (PR/231). - In response to a bugfix, results for
generate_weights(independence_level='GCM')
are significantly altered. (GH/230, PR/231). - Legacy support for
stats_kwargs
inensemble_stats
was dropped. (PR/231). period
inproduce_horizon
has been deprecated and replaced withperiods
. (PR/231).- Some automated
to_level
were updated to reflect more recent changes. (PR/231). - Removed
diagnostics.fix_unphysical_values
. (PR/238).
Bug fixes
- Fix bug in
unstack_dates
with seasonal climatological mean. (GH/202, PR/202). - Added NotImplemented errors when trying to call
climatological_mean
andcompute_deltas
with daily data. (PR/187). - Minor documentation fixes. (GH/223, PR/225).
- Fixed a bug in
unstack_dates
where it failed for anything other than seasons. (PR/228). cleanup
withcommon_attrs_only
now works even when nocat
attribute is present in the datasets. (PR/231).
Internal changes
- Removed the pin on xarray's version. (GH/175, PR/199).
- Folder parsing utilities now in pure python, platform independent. New dependency
parse
. (PR/205). - Updated ReadTheDocs configuration to prevent
--eager
installation of xscen (PR/209). - Implemented a template to be used for unit tests. (PR/187).
- Updated GitHub Actions to remove deprecation warnings. (PR/187).
- Updated the cookiecutter used to generate boilerplate documentation and code via
cruft
. (PR/212). - A few changes to
subset_warming_level
so it doesn't needdriving_institution
. (PR/215). - Added more tests. (PR/228).
- In
compute_indicators
, the logic to manage indicators returning multiple outputs was simplified. (PR/228).