Data

Tools

Indexes

Applications

Experiments

Open Source Science

Recent Releases of xCDAT

xCDAT - v0.10.0

v0.10.0 (27 Aug 2025)

This release introduces a new weight threshold option for temporal operations, improves regridding alignment, and fixes multiple issues with xgcm.Grid and xESMF integration. It also includes a DevOps fix to maintain consistency in handling xgcm.Grid metadata.

Enhancements

  • Add weight threshold option for temporal operations by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/683

Bug Fixes

  • Remove mask from create_grid() output to prevent xESMF issue by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/786
  • Fix xgcm.Grid errors by passing autoparse_metadata=False by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/785
  • Fix regrid2 alignment of output and input dims for final dataarray by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/782

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.9.1...v0.10.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] 4 months ago

xCDAT - v0.9.1

v0.9.1 (08 July 2025)

This patch release includes enhancements to bounds handling, improved error messages, and documentation updates.

Enhancements

  • Update get_bounds_dim() to dynamically get correct dim by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/773

Bug Fixes

  • Fix get_bounds() error message by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/776

Documentation

  • Add create_mask() and create_nan_mask() to API reference page by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/774

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.9.0...v0.9.1

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] 6 months ago

xCDAT - v0.9.0

v0.9.0 (02 June 2025)

This release introduces key functional and performance enhancements across regridding, averaging, and coordinate handling workflows. Users can now output regridding weights and infer vertical target data, improving flexibility in vertical and horizontal transformations. Time frequency inference logic is more robust through median delta computation, and new options for skipna handling and spatial weight thresholds support more accurate and configurable statistical operations. Additional improvements to coordinate handling enable support for curvilinear grids. The release also includes critical bug fixes, expanded documentation, and updated compatibility for modern Python environments by dropping Python 3.9 and adding compatibility with Python 3.13.

Enhancements

  • Adds option to output regridding weights and create mask for regridding by @jasonb5 in https://github.com/xCDAT/xcdat/pull/752
  • Adds ability to infer target data for vertical regridding by @jasonb5 in https://github.com/xCDAT/xcdat/pull/756
  • Use the median of the delta instead of min for time freq inference by @chengzhuzhang in https://github.com/xCDAT/xcdat/pull/768
  • Add weight threshold option for spatial averaging by @pochedls in https://github.com/xCDAT/xcdat/pull/672
  • Enable skipna for spatial and temporal mean operations by @lee1043 in https://github.com/xCDAT/xcdat/pull/655
  • Enhance coordinate handling and add curvilinear dataset support by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/736

Bug Fixes

  • Eliminate performance bottleneck in temporal.group_average() by @will-s-hart in https://github.com/xCDAT/xcdat/pull/767
  • Fix incorrect dimension used for temporal weights generation by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/749

Documentation

  • Add .zenodo.json and CITATION.cff to cite core authors by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/759
  • Replace support section with endorsements by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/757
  • Add xCDAT tutorial datasets and update gallery notebooks by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/705
  • Add endorsement section to docs with Xarray, Pangeo, and WCRP by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/741, https://github.com/xCDAT/xcdat/pull/742, https://github.com/xCDAT/xcdat/pull/757

DevOps

  • Make scipy a required dependency by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/765
  • Drop Python 3.9 support and add compatibility for Python 3.13 by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/721

New Contributors

  • @will-s-hart made their first contribution in https://github.com/xCDAT/xcdat/pull/767

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.8.0...v0.9.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] 7 months ago

xCDAT - v0.8.0

v0.8.0 (14 February 2025)

This minor release introduces a new feature for temporal averaging with custom seasons spanning the calendar year. It also includes the ability to detect and drop incomplete seasons using the drop_incomplete_season config, which will eventually replace drop_incomplete_djf (previously limited to DJF seasons). Additionally, a bug in the regrid2 regridder has been fixed, ensuring coordinates are now preserved correctly.

Enhancements

  • Add support for custom seasons spanning calendar years by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/423

Bug Fixes

  • Fixes preserving coordinates in regrid2 by @jasonb5 and @tomvothecoder in https://github.com/xCDAT/xcdat/pull/716
  • Fix DeprecationWarning and FutureWarning found in test suite by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/724

Documentation

  • Replace Miniconda with Miniforge by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/727
  • Update Miniconda references to Miniforge in HPC docs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/731

DevOps

  • Update pre-commit hooks and add ci config by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/732
  • Fix DeprecationWarning and FutureWarning found in test suite by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/724

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.7.3...v0.8.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] 11 months ago

xCDAT - v0.7.3

v0.7.3 (06 November 2024)

This patch release updates the NumPy constraint to numpy >=2.0.0,<3.0.0 to ensure compatibility with NumPy 2.0 (which introduces breaking changes). It also fixes a bug in the get_bounds() method where bounds could not be found on supported non-CF axes (e.g., "latitude", "longitude", etc.) even with the "bounds" attribute set on the axes.

Bug Fixes

  • Update get_bounds() to support mappable non-CF axes using "bounds" attr by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/708

Documentation

  • Add link to SciPy talk in docs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/704

DevOps

  • Adopt ruff as the central tool for linting, formatting, and import sorting by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/702
  • Update numpy constraint to >=2.0.0,<3.0.0 by @tomvothecoder and @xylar in https://github.com/xCDAT/xcdat/pull/711, https://github.com/xCDAT/xcdat/pull/712
  • Replace setup.py with pyproject.toml for modern Python packaging by @tomvothecoder and @xylar in https://github.com/xCDAT/xcdat/pull/712

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.7.2...v0.7.3

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] about 1 year ago

xCDAT - v0.7.2

v0.7.2 (02 October 2024)

This patch release introduces significant performance improvements to the temporal grouping averaging APIs (group_average, climatology, and departures) and adds support for piControl and other simulations that have time coordinates starting at year 1 (e.g., "0001-01-01") when dropping incomplete seasons.

Enhancements

  • [Refactor] Improve the performance of temporal group averaging by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/689

Bug Fixes

  • Update temporal.py to properly handle piControl and other simulations that start at year 1 when dropping incomplete seasons by @lee1043 in https://github.com/xCDAT/xcdat/pull/696

Documentation

  • Add project logos to README and project overview page on docs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/686
  • Add links to JOSS and DOE EESM content by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/682
  • Add SciPy 2024 talk material by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/658, https://github.com/xCDAT/xcdat/pull/678, https://github.com/xCDAT/xcdat/pull/679, https://github.com/xCDAT/xcdat/pull/680
  • Add JOSS badge to README by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/674

DevOps

  • Update setup.py classifiers by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/691
  • Update build workflow by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/698

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.7.1...v0.7.2

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] about 1 year ago

xCDAT - v0.7.1

v0.7.1 (24 June 2024)

This patch release fixes a bug in the Regrid2 API where a static order of dimensions are incorrectly expected. It updates add_missing_bounds() to convert np.timedelta64 values to pandas.Timedelta objects to support Xarray's datetime component accessor.

This release also includes numerous updates to the documentation, including adding a general guide to parallel computing with Dask notebook. It also ensures all existing notebooks and documentation are up to date with the latest and relevant information.

Bug Fixes

  • Fixes regrid2 mapping output to input ordering by @jasonb5 in https://github.com/xCDAT/xcdat/pull/653
  • Update add_missing_bounds() to convert np.timedelta64 to pd.Timedelta to support Xarray's datetime component accessor by @lee1043 in https://github.com/xCDAT/xcdat/pull/660

Documentation

  • Add JOSS paper by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/567
  • Add Parallel Computing with Dask Jupyter Notebook by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/489
  • Update regridding notebook for v0.7.0 by @chengzhuzhang in https://github.com/xCDAT/xcdat/pull/646-
  • Update FAQs, HPC guide, and Gentle Introduction by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/650
  • Simplify the contributing guide by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/593
  • Update notebook env setup instructions with kernel by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/652
  • Add instructions for setting ESMFMKFILE and update links to xESMF docs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/643
  • Temporal average notebooks maintanance by @lee1043 in https://github.com/xCDAT/xcdat/pull/633
  • Review of spatial averaging and general dataset utilities by @pochedls in https://github.com/xCDAT/xcdat/pull/644

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.7.0...v0.7.1

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] over 1 year ago

xCDAT - v0.7.0

v0.7.0 (10 April 2024)

This minor release includes enhancements to the performance of the Regrid2 API and fixes Regrid2 to align the behavior of how missing values are handled with CDAT. There are various other bug fixes and documentation updates listed below.

Enhancements

  • Improving regrid2 performance by @jasonb5 in https://github.com/xCDAT/xcdat/pull/533
  • Update Regrid2 missing and fill value behaviors to align with CDAT and add unmapped_to_nan arg for output data by @jasonb5 in https://github.com/xCDAT/xcdat/pull/613

Bug Fixes

  • Fix Regrid2 to convert bounds as Dask Arrays to NumPy Arrays for compatibility with NumPy based code by @tomvothecoder and @lee1043 in https://github.com/xCDAT/xcdat/pull/634
  • Fix climo notebook missing T bounds and add notebook env setup in all example notebooks by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/623
  • Update unweighted temporal averages to not require bounds by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/579

Documentation

  • Update documentation styling for easier navigation by @tomvothecoder and @pochedls in https://github.com/xCDAT/xcdat/pull/624 and https://github.com/xCDAT/xcdat/pull/630
  • Add list of projects using xCDAT by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/617
  • [PR]: Update documentation on temporal averaging, usage of bounds, and generation of weights by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/601
  • Fix ESMFMKFILE env variable not set in RTD build by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/577

Deprecations

  • Remove deprecated features and APIs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/628, including:
    • horizontal_xesmf() and horizontal_regrid2()
    • **kwargs from create_grid()
    • add_bounds accepting boolean arg in open_dataset() and open_mfdataset()
    • Remove CDML/XML support from open_dataset() and open_mfdataset() since CDAT is EOL since Dec/2023

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.6.1...0.7.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] over 1 year ago

xCDAT - v0.6.1

v0.6.1 (29 November 2023)

This patch version adds a default value to the axes argument in ds.bounds.add_missing_bounds() (axes=["X", "Y", "T"]). The axes argument was added in v0.6.0 and did not have a default value, which inadvertently introduced a breaking change to the API.

xesmf is now a required dependency because its core library, ESMF, supports Windows as of Feb/2023. More information can be found here.

Bug Fixes

  • Add defaults to addmissingbounds by @acordonez in https://github.com/xCDAT/xcdat/pull/569

DevOps

  • Make xESMF a required dependency by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/566

Documentation

  • Update doc: Add link to the ESFG seminar xCDAT introduction video by @lee1043 in https://github.com/xCDAT/xcdat/pull/571
  • Fix v0.6.0 changelog headers for proper nesting by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/559

Full Changelog:

https://github.com/xCDAT/xcdat/compare/v0.6.0...v0.6.1

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] about 2 years ago

xCDAT - v0.6.0

v0.6.0 (10 October 2023)

This minor version update consists of new features including vertical regridding (extension of xgcm), functions for producing accurate time bounds, and improving the usability of the create_grid API. It also includes bug fixes to preserve attributes when using regrid2 horizontal regridder and fixing multi-file datasets spatial average orientation and weights when lon bounds span prime meridian.

Features

  • Functions to produce accurate time bounds by @pochedls in https://github.com/xCDAT/xcdat/pull/418
  • Add API extending xgcm vertical regridding by @jasonb5 in https://github.com/xCDAT/xcdat/pull/388, https://github.com/xCDAT/xcdat/pull/535, https://github.com/xCDAT/xcdat/pull/525
  • Update create_grid args to improve usability by @jasonb5 in https://github.com/xCDAT/xcdat/pull/507, https://github.com/xCDAT/xcdat/pull/539

Deprecation

  • Add deprecation warnings for add_bounds boolean args by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/548,
  • Add deprecation warning for CDML/XML support in open_mfdataset() by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/503, https://github.com/xCDAT/xcdat/pull/504

Bug Fixes

Horizontal Regridding

  • Improves error when axis is missing/incorrect attributes with regrid2 by @jasonb5 in https://github.com/xCDAT/xcdat/pull/481
  • Fixes preserving ds/da attributes in the regrid2 module by @jasonb5 in https://github.com/xCDAT/xcdat/pull/468
  • Fixes duplicate parameter in regrid2 docs by @jasonb5 in https://github.com/xCDAT/xcdat/pull/532

Spatial Averaging

  • Fix multi-file dataset spatial average orientation and weights when lon bounds span prime meridian by @pochedls in https://github.com/xCDAT/xcdat/pull/495

Documentation

  • Typo fix for climatology code example in docs by @lee1043 in https://github.com/xCDAT/xcdat/pull/491
  • Update documentation in regrid2.py by @lee1043 in https://github.com/xCDAT/xcdat/pull/509
  • Add more fields to GH Discussions question form by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/480
  • Add Q&A GH discussions template by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/479
  • Update FAQs question covering datasets with conflicting bounds by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/474
  • Add Google Groups mailing list to docs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/452
  • Fix README link to CODE-OF-CONDUCT.rst by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/444
  • Replace LLNL E3SM License with xCDAT License by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/443
  • Update getting started and HPC documentation by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/553

DevOps

  • Fix Python deprecation comment in conda env yml files by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/514
  • Simplify conda environments and move configs to pyproject.toml by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/512
  • Update DevOps to cache conda and fix attributes not being preserved with xarray > 2023.3.0 by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/465
  • Update GH Actions to use mamba by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/450
  • Update constraint cf_xarray >=0.7.3 to workaround xarray import issue by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/547

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.5.0...v0.6.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] about 2 years ago

xCDAT - v0.6.0rc1

v0.6.0rc1 (7 July 2023)

This is the first release candidate for the upcoming v0.6.0 release. This version is intended to be used for testing new features, improvements, and bug fixes. Refer to the changelog below for more information.

Features

  • Functions to produce accurate time bounds by @pochedls in https://github.com/xCDAT/xcdat/pull/418
  • Add API extending xgcm vertical regridding by @jasonb5 in https://github.com/xCDAT/xcdat/pull/388
  • Update create_grid args to improve usability by @jasonb5 in https://github.com/xCDAT/xcdat/pull/507

Bug Fixes

  • Improves error when axis is missing/incorrect attributes by @jasonb5 in https://github.com/xCDAT/xcdat/pull/481
  • Fix multi-file dataset spatial average orientation and weights when lon bounds span prime meridian by @pochedls in https://github.com/xCDAT/xcdat/pull/495
  • Fixes preserving ds/da attributes in the regrid2 module by @jasonb5 in https://github.com/xCDAT/xcdat/pull/468

Deprecations

  • Add deprecation warning for CDML/XML support in open_mfdataset() by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/503

Documentation

  • Typo fix for doc by @lee1043 in https://github.com/xCDAT/xcdat/pull/491
  • Update documentation in regrid2.py by @lee1043 in https://github.com/xCDAT/xcdat/pull/509
  • Remove cdms-filemap references in API docstrings by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/504
  • Add more fields to GH Discussions question form by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/480
  • Add Q&A GH discussions template by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/479
  • Update FAQs question covering datasets with conflicting bounds by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/474
  • Add Google Groups mailing list to docs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/452
  • Fix README link to CODE-OF-CONDUCT.rst by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/444
  • Replace LLNL E3SM License with xCDAT License by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/443

DevOps

  • Fix Python deprecation comment in conda env yml files by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/514
  • Simplify conda environments and move configs to pyproject.toml by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/512
  • Update DevOps to cache conda and fix attributes not being preserved with xarray > 2023.3.0 by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/465
  • Update GH Actions to use mamba by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/450
  • Bump to 0.6.0rc1 by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/515

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.5.0...v0.6.0rc1

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder over 2 years ago

xCDAT - v0.5.0

v0.5.0 (27 March 2023)

This long-awaited minor release includes feature updates to support an optional user-specified climatology reference period when calculating climatologies and departures, support for opening datasets using the directory key of the legacy CDAT Climate Data Markup Language (CDML) format (an XML dialect), and improved support for using custom time coordinates in temporal APIs.

This release also includes a bug fix for singleton coordinates breaking the swap_lon_axis() function. Additionally, Jupyter Notebooks for presentations and demos have been added to the documentation.

Features

  • Update departures and climatology APIs with reference period by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/417
  • Wrap open_dataset and open_mfdataset to flexibly open datasets by @pochedls in https://github.com/xCDAT/xcdat/pull/385
  • Add better support for using custom time coordinates in temporal APIs by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/415

Bug Fixes

  • [Doc]: Fix missing xesmf APIs and update slides in intro notebook by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/428
  • Raise warning if no time coords found with decode_times by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/409
  • Bump conda env dependencies by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/408
  • Fix swap_lon_axis() breaking when sorting with singleton coords by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/392

Documentation

  • Bump to v0.5.0 by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/436
  • Update xsearch-xcdat-example.ipynb by @pochedls in https://github.com/xCDAT/xcdat/pull/425
  • Updates xesmf docs by @jasonb5 in https://github.com/xCDAT/xcdat/pull/432
  • [Doc]: Fix missing xesmf APIs and update slides in intro notebook by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/428
  • Add presentations and demos to sphinx toctree by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/422
  • [Doc]: Add xsearch demo notebook for CWSS Presentation by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/398
  • Update temporal .average and .departures docstrings by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/407

DevOps

  • Bump conda env dependencies by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/408

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.4.0...0.5.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] almost 3 years ago

xCDAT - v0.4.0

v0.4.0 (9 November 2022)

This minor release includes a feature update to support datasets that have N dimensions mapped to N coordinates to represent an axis. This means xcdat APIs are able to intelligently select which axis's coordinates and bounds to work with if multiple are present within the dataset. Decoding time is now a lazy operation, leading to significant upfront runtime improvements when opening datasets with decode_times=True.

A new notebook called "A Gentle Introduction to xCDAT" was added to the documentation gallery to help guide new xarray/xcdat users. xCDAT is now hosted on Zenodo with a DOI for citations.

There are various bug fixes for bounds, naming of spatial weights, and a missing flag for xesmf that broke curvilinear regridding.

Features

  • Support for N axis dimensions mapped to N coordinates by @tomvothecoder and @pochedls in https://github.com/xCDAT/xcdat/pull/343
    • Rename get_axis_coord() to get_dim_coords() and get_axis_dim() to get_dim_keys()
    • Update spatial and temporal accessor class methods to refer to the dimension coordinate variable on the data_var being operated on, rather than the parent dataset
  • Decoding times (decode_time()) is now a lazy operation, which results in significant runtime improvements by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/343

Bug Fixes

  • Fix add_bounds() not ignoring 0-dim singleton coords by @tomvothecoder and @pochedls in https://github.com/xCDAT/xcdat/pull/343
  • Fix name of spatial weights with singleton coord by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/379
  • Fixes xesmf flag that was missing which broke curvilinear regridding by @jasonb5 and @pochedls in https://github.com/xCDAT/xcdat/pull/374

Documentation

  • Add FAQs section for temporal metadata by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/383
  • Add gentle introduction notebook by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/373
  • Link repo to Zenodo and upload GitHub releases by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/367
  • Update project overview, FAQs, and add a link to xarray tutorials by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/365
  • Update feature list, add metadata interpretation to FAQs, and add ipython syntax highlighting for notebooks by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/362

DevOps

  • Update release-drafter template by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/371 and https://github.com/xCDAT/xcdat/pull/370
  • Automate release notes generation by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/368

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.3.3...v0.4.0

Scientific Software - Peer-reviewed - Python
Published by github-actions[bot] about 3 years ago

xCDAT - v0.3.3

v0.3.3 (12 October 2022)

This patch release fixes a bug where calculating daily climatologies/departures for specific CF calendar types that have leap days breaks when using cftime. It also includes documentation updates.

Bug Fixes

  • Drop leap days based on CF calendar type to calculate daily climatologies and departures by @tomvothecoder and @lee1043 in https://github.com/xCDAT/xcdat/pull/350
    • Affected CF calendar types include gregorian, proleptic_gregorian, and standard
    • Since a solution implementation for handling leap days is generally opinionated, we decided to go with the route of least complexity and overhead (drop the leap days before calculations). We may revisit adding more options for the user to determine how they want to handle leap days (based on how valuable/desired it is).

Documentation

  • Add horizontal regridding gallery notebook by @jasonb5 in https://github.com/xCDAT/xcdat/pull/328
  • Add doc for staying up to date with releases by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/355

Dependencies

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.3.2...v0.3.3

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder about 3 years ago

xCDAT - v0.3.2

v0.3.2 (16 September 2022)

This patch release focuses on bug fixes related to temporal averaging, spatial averaging, and regridding. xesmf is now an optional dependency because it is not supported on osx-arm64 and windows at this time. There is a new documentation page for HPC/Jupyter guidance.

Bug Fixes

Temporal Average

  • Fix multiple temporal avg calls on same dataset breaking by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/329
  • Fix incorrect results for group averaging with missing data by @pochedls in https://github.com/xCDAT/xcdat/pull/320

Spatial Average

  • Fix spatial bugs: handle datasets with domain bounds out of order and zonal averaging by @pochedls in https://github.com/xCDAT/xcdat/pull/340

Horizontal Regridding

  • Fix regridder storing NaNs for bounds by @pochedls in https://github.com/xCDAT/xcdat/pull/344

Documentation

  • Update README and add HPC/Jupyter Guidance by @pochedls in https://github.com/xCDAT/xcdat/pull/331

Dependencies

  • Make xesmf an optional dependency by @durack1 in https://github.com/xCDAT/xcdat/pull/334
    • This is required because xesmf (and esmpy which is a dependency) are not supported on osx-arm64 and windows at this time.
    • Once these platforms are supported, xesmf can become a direct dependency of xcdat.

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.3.1...v0.3.2

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder over 3 years ago

xCDAT - v0.3.1

v0.3.1 (18 August 2022)

This patch release focuses on bug fixes including handling bounds generation with singleton coordinates and the use of cftime to represent temporal averaging outputs and non-CF compliant time coordinates (to avoid the pandas Timestamp limitations).

Bug Fixes

Bounds

  • Ignore singleton coordinates without dims when attempting to generate bounds Stephen Po-Chedley in https://github.com/xCDAT/xcdat/pull/281
  • Modify logic to not throw error for singleton coordinates (with no bounds) by Stephen Po-Chedley in https://github.com/xCDAT/xcdat/pull/313

Time Axis and Coordinates

  • Fix TypeError with Dask Arrays from multifile datasets in temporal averaging by Stephen Po-Chedley in https://github.com/xCDAT/xcdat/pull/291
  • Use cftime to avoid out of bounds datetime when decoding non-CF time coordinates by Stephen Po-Chedley and Tom Vo in https://github.com/xCDAT/xcdat/pull/283
  • Use cftime for temporal averaging operations to avoid out of bounds datetime by Stephen Po-Chedley and Tom Vo in https://github.com/xCDAT/xcdat/pull/302
  • Fix open_mfdataset() dropping time encoding attrs by Tom Vo in https://github.com/xCDAT/xcdat/pull/309
  • Replace "time" references with self._dim in class TemporalAccessor by Tom Vo in https://github.com/xCDAT/xcdat/pull/312

Internal Changes

  • Filters safe warnings. by Jason Boutte in https://github.com/xCDAT/xcdat/pull/276

Documentation

  • update conda install to conda create by Paul Durack in https://github.com/xCDAT/xcdat/pull/294
  • Update project overview and planned features list by Tom Vo in https://github.com/xCDAT/xcdat/pull/298
  • Fix bullet formatting in README.rst andindex.rst by Tom Vo in https://github.com/xCDAT/xcdat/pull/299
  • Fix Jupyter headings not rendering with pandoc by Tom Vo in https://github.com/xCDAT/xcdat/pull/318

DevOps

  • Unify workspace settings with settings.json by Tom Vo in https://github.com/xCDAT/xcdat/pull/297
  • Run CI/CD on "push" and "workflow_dispatch" by Tom Vo in https://github.com/xCDAT/xcdat/pull/287 and https://github.com/xCDAT/xcdat/pull/288
  • Pin numba=0.55.2 in dev env and constrain numba>=0.55.2 in ci env by Tom Vo in https://github.com/xCDAT/xcdat/pull/280
  • Update conda env yml files and add missing dependencies by Tom Vo in https://github.com/xCDAT/xcdat/pull/307

New Contributors

  • Paul Durack made their first contribution in https://github.com/xCDAT/xcdat/pull/294

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.3.0...v0.3.1

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder over 3 years ago

xCDAT - v0.3.0

v0.3.0 (27 June 2022)

New Features

  • Add horizontal regridding by @jasonb5 in https://github.com/xCDAT/xcdat/pull/164
  • Add averages with time dimension removed by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/236
  • Update _get_weights() method in class SpatialAccessor and class TemporalAccessor by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/252
    • Add keep_weights keyword attr to reduction methods
    • Make _get_weights() public in class SpatialAccessor
  • Update get_axis_coord() to interpret more keys by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/262
    • Along with the axis attr, it also now interprets standard_name and the dimension name

Bug Fixes

  • Fix add_bounds() breaking when time coords are cftime objects by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/241
  • Fix parsing of custom seasons for departures by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/246
  • Update swap_lon_axis to ignore same systems, which was causing odd behaviors for (0, 360) by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/257

Breaking Changes

  • Remove class XCDATAccessor by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/222
  • Update spatial axis arg supported type and keys by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/226
    • Now only supports CF-compliant axis names (e.g., "X", "Y")
  • Remove center_times kwarg from temporal averaging methods by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/254

Documentation

  • Revert official project name from "XCDAT" to "xCDAT" by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/231
  • [DOC] Add CDAT API mapping table and gallery examples by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/239

Internal Changes

  • Update time coordinates object type from MultiIndex to datetime/cftime for TemporalAccessor reduction methods and add convenience methods by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/221
  • Extract method _postprocess_dataset() and make bounds generation optional by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/223
  • Update add_bounds kwarg default value to True by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/230
  • Update decode_non_cf_time to return input dataset if the time "units" attr can't be split into unit and reference date by @pochedls in https://github.com/xCDAT/xcdat/pull/263

New Contributors

  • @jasonb5 made their first contribution in https://github.com/xCDAT/xcdat/pull/164

Full Changelog: https://github.com/xCDAT/xcdat/compare/v0.2.0...v0.3.0

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder over 3 years ago

xCDAT - v0.2.0

v0.2.0 (24 March 22)

New Features

  • Add support for spatial averaging parallelism via Dask by @pochedls in https://github.com/XCDAT/xcdat/pull/132
  • Refactor spatial averaging with more robust handling of longitude spanning prime meridian by @pochedls in https://github.com/XCDAT/xcdat/pull/152
  • Update xcdat.open_mfdataset time decoding logic by @pochedls in https://github.com/XCDAT/xcdat/pull/161
  • Add function to swap dataset longitude axis orientation by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/145
  • Add utility functions by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/205
  • Add temporal utilities and averaging functionalities by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/107

Bug Fixes

  • Add exception for coords of len <= 1 or multidimensional coords in fill_missing_bounds() by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/141
  • Update open_mfdataset() to avoid data vars dim concatenation by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/143
  • Fix indexing on axis keys using generic map (related to spatial averaging) by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/172

Breaking Changes

  • Rename accessor classes and methods for API consistency by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/142
  • Rename fill_missing_bounds() to add_missing_bounds() by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/157
  • Remove data variable inference API by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/196
  • Rename spatial file and class by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/207

Documentation

  • update README by @chengzhuzhang in https://github.com/XCDAT/xcdat/pull/127
  • Update readme by @lee1043 in https://github.com/XCDAT/xcdat/pull/129
  • Update HISTORY.rst and fix docstrings by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/139
  • Update README.rst content and add logo by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/153
  • Update API Reference docs to list all APIs by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/155
  • Add config.yml for issue templates with link to discussions by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/176
  • Add FAQs page to docs by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/181
  • Fix syntax of code examples from PR #181 by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/182
  • Replace markdown issue templates with GitHub yml forms by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/186
  • Update README.rst, index.rst, and project_maintenance.rst by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/211

Deprecations

Internal Changes

  • Update logger levels to debug by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/148
  • Update and remove logger debug messages by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/193

DevOps

  • Add requires_dask decorator for tests by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/177
  • Update dependencies in setup.py and dev.yml by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/174
  • Add matrix testing and ci specific conda env by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/178
  • Suppress xarray warning in test suite by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/179
  • Drop support for Python 3.7 by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/187
  • Update conda env dependencies by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/189
  • Add deps to pre-commit mypy and fix issues by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/191
  • Add matplotlib to dev env, update ci.yml and add Python 3.10 to build workflow by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/203
  • Replace conda with mamba in rtd build by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/209
  • Bump to 0.2.0 by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/212

New Contributors

  • @chengzhuzhang made their first contribution in https://github.com/XCDAT/xcdat/pull/127
  • @lee1043 made their first contribution in https://github.com/XCDAT/xcdat/pull/129
  • @pochedls made their first contribution in https://github.com/XCDAT/xcdat/pull/132

Full Changelog: https://github.com/XCDAT/xcdat/compare/v0.1.0...v0.2.0

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder almost 4 years ago

xCDAT - v0.1.0

Below is a summary of changes in this version. In subsequent changelogs, the exact commits will be listed.

Features - Add geospatial averaging API through DatasetSpatialAverageAccessor class by @pochedls and @tomvothecoder in #87 - Does not support parallelism with Dask yet - Add wrappers for xarray's open_dataset and open_mfdataset to apply common operations such as: - If the dataset has a time dimension, decode both CF and non-CF time units - Generate bounds for supported coordinates if they don’t exist - Option to limit the Dataset to a single regular (non-bounds) data variable while retaining any bounds data variables - Add DatasetBoundsAccessor class for filling missing bounds, returning mapping of bounds, returning names of bounds keys - Add BoundsAccessor class for accessing xcdat public methods from other accessor classes - This will be probably be the API endpoint for most users, unless they prefer importing the individual accessor classes - Add ability to infer data variables in xcdat APIs based on the "xcdatinfer" Dataset attr - This attr is set in `xcdat.opendataset(),xcdatmfdataset(), or manually - Utilizescfxarray` package (https://github.com/xarray-contrib/cf-xarray)

Docs - Visit the docs here: https://xcdat.readthedocs.io/en/latest/index.html

CI/CD - 100% code coverage (https://app.codecov.io/gh/XCDAT/xcdat) - GH Actions for CI/CD build (https://github.com/XCDAT/xcdat/actions) - Pytest and pytest-cov for test suite

Full Changelog: https://github.com/XCDAT/xcdat/commits/v0.1.0

Scientific Software - Peer-reviewed - Python
Published by tomvothecoder about 4 years ago