Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

Recent Releases of icepyx

icepyx - v2.0.0

What's new in 2.0.0 (16 May 2025)

These are the changes in icepyx 2.0.0. See https://icepyx.readthedocs.io/en/latest/user_guide/changelog/index.html for a full changelog including other versions of icepyx.

[!WARNING]
This is major release and contains a few breaking changes. Full details will be described in the documentation.

NSIDC (the NASA DAAC that hosts ICESat-2 data) is transitioning their API endpoint from the on-premises EGI system to the cloud-based Harmony services. icepyx has been updated to access these new services; Certain capabilities are temporarily going away

  • Data reformatting: Currently no format transcoding is available for any ICESat-2 products, so users will only get HDF5 files back from the new Harmony API.
  • Variable subsetting: The new cloud subsetter doesn't support variable subsetting (yet), therefore all variables will be included in subsetted orders.

Find more details on all these changes, including their progress, on GitHub issues and discussions.

New Features

  • Adding support for NASA's Harmony subsetter (#657)

    • Data orders can be previewed, stopped and resumed using the library or the Harmony UI.
    • The Harmony trajectory subsetter automatically pauses orders with more than 300 granules, we need to manually resume them or pass the skip_preview=True parameter to the order.
    • Reference: https://harmony.earthdata.nasa.gov/

  • Order class: when an order is placed, icepyx will return an order class instance that will help us keep track of the order progress, pause and eventually download the data.
    We can still use the Query class to download, however using the order instance is probably simpler and more intuitive. (#657)

Bug fixes

  • None

Deprecations

  • EGI API is deprecated (Closes #530)
    • PR #657 implements NASA Harmony support to replace the on-premises EGI service.
    • data reformatting and variable subsetting are not supported in the new API.
      • Users will only get HDF5 files back from the new API.
    • order_vars() is deprecated in favor of variables().
    • fmt_for_EGI() is deprecated.
    • Any EGI specific code is deprecated and has been removed in this release.
  • Drop support for Python 3.9 and 3.10 (#655)
  • Removed existing deprecations for v1.x (#640)

Maintenance

  • Separate CI unit tests and integration tests with their own conftest (#657)
  • Fixed some integration tests that were failing due to the new Harmony API #(657)
  • Updated ruff action (#654)

Documentation

  • Updated notebooks to reflect the new Harmony API usage (#657)
    • The updated notebooks include instructions for making full and subset orders, and show how to use the new Harmony API.
    • The top level API works the same, users only need to update to v2.0.0 and the code should work (unless using variable subsetting or reformatting)
    • Notebooks are in the doc/source/example_notebooks folder, and are also available on the Readthedocs documentation page.
  • Include quest tile in index.rst (#497)

Other

  • None

Contributors

A total of 10 people contributed to this release. People with a “+” by their names contributed for the first time.

  • @cclauss
  • @JessicaS11
  • @betolink +
  • @mfisher87
  • @RomiP
  • @weiji14
  • @rwegener2
  • @trey-stafford
  • @tande-tw +
  • @asteiker

Full Changelog: https://github.com/icesat2py/icepyx/compare/v1.3.0...v2.0.0

Cryosphere - Glacier and Ice Sheets - Python
Published by weiji14 about 1 month ago

icepyx - v1.3.0

Notice on Pending v1 Deprecation

This is anticipated to be the last release in v1 of icepyx.

NSIDC (the NASA DAAC that hosts ICESat-2 data) is transitioning their API endpoint from the on-premises EGI system to the cloud-based Harmony services. icepyx is being updated to access these new services; the only change users will experience concerns services that are no longer available (e.g. reformatting).

The developers plan to use this version change to implement additional breaking changes concerning the Query module, transitioning it's functionality to use the earthaccess library instead.

Find more details on all these changes, including their progress, on GitHub issues and discussions.

What's Changed

New Contributors

Full Changelog: https://github.com/icesat2py/icepyx/compare/v1.2.0...v1.3.0

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 10 months ago

icepyx - v1.2.0

What's Changed

New Contributors

Full Changelog: https://github.com/icesat2py/icepyx/compare/v1.1.0...v1.2.0

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 11 months ago

icepyx - v1.1.0

This release contains lots of changed files, but most of them are linting related (end-of-file newlines, trailing whitespace, max characters). Code changes include bug fixes for bad metadata (not directly an icepyx issue, but caused errors because we use the metadata fields) and not submitting temporal arguments to EGI for ATL11, along with maintenance updates to address changes in actions, packaging, and docs builds. We've also update routine documentation and added more details on QUEST.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 about 1 year ago

icepyx - v1.0.0

Highlights include:

  • read in ICESat-2 data in the cloud
  • access Argo and ICESat-2 using QUEST (including an example)
  • standalone Variables module for ease of use in all ICESat-2 workflows
  • updated GitHub actions, including linting (and work towards meeting PEP standards)

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 1 year ago

icepyx - v0.8.1

v0.8.1 is a minor patch release to address the bug in reading in ATL08 data (needed for an upcoming tutorial). No other commits currently on development, including a few critical updates (e.g. to correct spot calculations), are included in this release.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 1 year ago

icepyx - v0.8.0

v0.8.0 separates date and time functionality into a temporal module. An auth MixIn class enables sharing of authentication between modules, an important step for cloud data access, and allows users to easily customize their auth settings (e.g. for proxies). Use of intake to read in data groups/variables was deprecated in favor of direct reads through Xarray. Clarifications to authorship, citation, and attribution are also included and support for ATL23 was added.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 almost 2 years ago

icepyx - icepyx (v0.6.4) publication in Journal of Open Source Software (JOSS)

This release is for the final JOSS publication. It is based on the reviewed software release v0.6.4 with additions for the edits requested during the review.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 about 2 years ago

icepyx - v0.7.0

icepyx has officially adopted earthaccess (>=0.5.1) for handling authentication and cloud credentialing. This release also includes a number of data product specific (e.g. ATL11 read in, ATL13 s3 urls) and other bug fixes, doc and action updates, and welcomes several new contributors.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 2 years ago

icepyx - v0.6.4

Minor release with refactoring of geospatial into a spatial module, bug fixes (including for cross date line spatial extents), updates for cloud data access, and more testing.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 2 years ago

icepyx - v0.6.3

Minor release with lots of documentation updates and improvements/additions and fix for the data read-in issues due to non-unique datetime indices.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 almost 3 years ago

icepyx - v0.6.2

Minor release with behind-login testing fixes, action updates, and fixes for reading in deeply nested variables and NumPy >= 1.22

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 3 years ago

icepyx - v0.6.1

Minor version release, including a bugfix that caused the attempted (and pulled) release of v0.6.0 to fail with an import error.

Introduces the QUEST colocated data framework, which included turning the Query class into a superclass called GenQuery. Improve gridded product access, docs, and updates to interactions with NSIDC.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 3 years ago

icepyx - v0.5.0

Minor version release includes new data read in capabilities (including an Intake catalog building module).
Also includes updates to tracking info, docs, and default values for NSIDC interactions.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 3 years ago

icepyx - v0.4.1

add missing minor release tag prior to next release

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 3 years ago

icepyx - major release - visualization module and orbital searching

Among a host of small added features, formatting fixes, and updates, we are introducing a new visualization module and the capability to search for ICESat-2 data using orbital parameters.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 about 4 years ago

icepyx - minor release - updates after conda-forge release and traffic action

A minor release to deal with lingering issues after the conda-forge release (namely documentation builds failing). Also updated traffic data and the traffic action to have a higher level of automation.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 4 years ago

icepyx - minor release - conda-forge, automated versioning, metrics

This minor release will enable us to fully test the release of icepyx to conda-forge.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 4 years ago

icepyx - version 0.3.2 minor bug fixes and updates

Provides bug fix for NSIDC update that caused subsetting to fail. Also fixes issue with float inputs. Add contributors and tracking/docs and other minor updates.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 over 4 years ago

icepyx - v0.3.1 post hackweek release

This release is equivalent to v0.3.0 (which is on PyPI but has been deleted as a tag/release from the repo) only with a rewritten history (hence needing to delete the tag) to remove a few large tif files, as per #114.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 almost 5 years ago

icepyx - Second developmental release

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 almost 5 years ago

icepyx - June 2020 ICESat-2 Hackweek

The state of icepyx at the start of the June 2020 ICESat-2 Cryosphere themed [virtual] Hackweek.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 about 5 years ago

icepyx - First developmental release of icepyx

This release is the first official (developmental) release of icepyx, meant to mark its state prior to separating it into separate modules in a coming development release.

Cryosphere - Glacier and Ice Sheets - Python
Published by JessicaS11 about 5 years ago