Skip to content

CHANGELOG.md

Latest commit

 

History

History
673 lines (493 loc) · 39.7 KB

CHANGELOG.md

File metadata and controls

673 lines (493 loc) · 39.7 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Common Changelog and this project uses Semantic Versioning.

Unreleased

Changed

  • Relocated community resources section from overview page to resources page (#1253) (@Sherwin-14)

Added

  • Added the NASA Atmospheric Science Data Center's cloud provider to the integration tests. (#460) (@danielfromearth)

Removed

[v0.17.0] - 2026-04-02

Changed

  • Fixed mypy type errors for missing stubs (virtualizarr, obstore, requests, xarray, etc.) (@betolink)
  • While downloading, files will have temporary names until download completes. (@WeatherGod)
  • BREAKING: refactored virtualization, now we have a unified virtualize() method that's compatible with VirtualiZarr 2.x and is open to most parsers not just dmrpp (#1271) (@betolink)

Added

  • Added FutureWarning to DataCollections and DataGranules methods in preparation for merge of #1187 in version 1.0. (#1267) (@andypbarrett)
  • Added force kwarg to download() to force redownloads. (@WeatherGod)

Removed

  • consolidate_metadata(), open_virtual_dataset() and open_virtual_mfdataset() have been removed in favor of a single virtualize() method (@betolink)

0.16.0 - 2026-01-30

Changed

  • Improved performance of fetching temporary S3 credentials (roughly 4x speedup) by using EDL user token rather than EDL username/password in request (#1182) (@chuckwondo)
  • open_virtual_datasets now accepts load=False to avoid materializing indexes when they are not needed (e.g. xarray pre-processing metadata). Fixes (#1185) (@betolink)

Added

Removed

  • Breaking: Remove default automatic login behavior. This removes previously undocumented behavior, where a user would be logged in automatically (i.e., without having to call earthdata.login explicitly) if the user had valid EDL credentials specified either via environment variables or a netrc file. This led to potentially unexpected behavior.

    Removing this automatic behavior breaks existing user code that does not make an explicit call to earthdata.login before streaming/downloading data, but used to succeed due to the (perhaps unknown) automatic login behavior.

    Users must now explicitly call earthdata.login in order to access data that requires EDL authentication.

    Removing this automatic behavior was necessary to fix #945.

Fixed

  • Ignore environment variables EARTHDATA_USERNAME and EARTHDATA_PASSWORD when EARTHDATA_TOKEN is set (#1121) (@chuckwondo)
  • Use only specified login strategy to attempt login, when strategy other than "all" is specified (#945) (@chuckwondo)
  • Fix undesirable pre-commit changes when running on Windows (#1143) (@ana-sher)
  • No longer erroneously strip authorization header for valid hosts (#1130) (@chuckwondo)
  • Fix AttributeError raised by Auth.get_s3_credentials when EARTHDATA_TOKEN environment variable is set, which prevented the username attribute from being defined on the Auth instance (#1181) (@chuckwondo)

0.15.1 - 2025-09-16

Fixed

0.15.0 - 2025-09-16

Changed

  • Populated glossary section under USER-REFERENCE. (#1027) (@Sherwin-14)
  • Change default cache behavior in fsspec from readahead to blockcache. Allow user defined config with open_kwargs in the .open() method. This improves performance by an order of magnitude. (#251) (#771) (@betolink)
  • Add show_progress argument to earthaccess.download() to let the user control display of progress bars. Defaults to true for interactive sessions, otherwise false. (#612) (#1065) (@Sherwin-14)
  • Updated bug and triage label names in bug Issue template. (#998) (@asteiker)
  • download now raises DownloadFailure exception on failure. (#612) (@Sherwin-14)
  • GESDISC should be GES_DISC in docstrings. (#1037) (@abarciauskas-bgse)
  • open_virtual_mfdataset now uses virtualizarr v2, and obstore in place of fsspec. Updated Zarr to V3 xref #967. (#1074) (@owenlittlejohns)
  • Populate search and access user guides. (#1035) (@andypbarrett)

Added

  • Added tenacity to retry downloads up to 3 times with exponential backoff time, replaces #1016 (#481) (@betolink)
  • Add notebook demonstrating workflow with TEMPO Level 3 data as a virtual dataset (#924) (@danielfromearth)
  • get_s3_filesystem now accepts an endpoint argument for specifying a credentials url. (#602) (@rwegener2)
  • s3 download now checks for existing files. (#807) (@Sherwin-14)
  • Added triaging guide (#754) (@Sherwin-14, @mfisher87)
  • download now returns Path consistently. ([#595])(#595) (@Sherwin-14)
  • Users may now authenticate with an existing Earthdata login token with environment variable EARTHDATA_TOKEN (#484) (@kgrimes2)
  • Added top level status function to check the statuses of NASA Earthdata services (#161) (@Sherwin-14)

Removed

  • Breaking: Removed has_granules=true and include_granule_counts=true as default parameters upon creation of a DataCollections instance. (#884) (@Sherwin-14)
  • Python 3.10 is no longer supported. (#966) (@weiji14)

Fixed

0.14.0 - 2025-02-11

Added

  • search_datasets now accepts a has_granules keyword argument. Use has_granules=False to search for metadata about collections with no associated granules. The default value set in DataCollections remains True. (#939) (@juliacollins)

Changed

  • Breaking: earthaccess will now raise an exception when login credentials are rejected. If you need the old behavior, please use a try block. (#946) (@mfisher87, @chuckwondo, @jhkennedy)

0.13.0 - 2025-01-28

Added

  • VirtualiZarr: earthaccess can open archival formats (NetCDF, HDF5) as if they were Zarr by leveraging VirtualiZarr In order to use this capability the collection needs to be supported by OPeNDAP and have dmrpp files. See example notebooks! (@ayushnag, @TomNicholas)

Fixed

  • earthaccess.download will let requests automatically decode compressed content (#887) (@itcarroll)

  • earthaccess.download now shares the authenticated session cookie among threads to avoid overloading EDL. (#913) (@hailiangzhang)

0.12.0 - 2024-11-13

Changed

  • Refactored our development guide to clarify development environment setup and how to run tests (@jhkennedy)
  • Use built-in assert statements instead of unittest assertions in integration tests (#743) (@chuckwondo)

Added

  • Add support for opening data files with virtualizarr and NASA dmrpp with open_virtual_dataset (#605) (@ayushnag)
  • Add support for NETRC environment variable to override default .netrc file location (#480) (@chuckwondo)
  • Add nox session for running integration tests locally (#815; #872) (@chuckwondo, @jhkennedy)
  • Auto-add comment to PR that requires maintainer to review and re-run integration tests (#824) (@chuckwondo)
  • Add authentication to User Guide documentation. (#763) (@andypbarrett)

Removed

  • The scripts/integration-test.sh script has been removed in favor of the integration-tests nox session. (#872) (@jhkennedy)
  • Python 3.9 is no longer supported. (#876) (@mfisher87)

Fixed

0.11.0 2024-10-01

Changed

  • Automatically refresh EDL token and deprecate the Auth.refresh_tokens method with no replacement, as there is no longer a need to explicitly refresh (#484) (@fwfichtner)
  • Deprecate earthaccess.get_s3fs_session and Store.get_s3fs_session. Use earthaccess.get_s3_filesystem and Store.get_s3_filesystem, respectively, instead (#766) (@Sherwin-14, @chuckwondo)

Added

Removed

  • Remove binder/ directory, as we no longer need a special binder environment with the top-level environment.yml introduced in #733 (@jhkennedy)

Fixed

  • Remove broken link "Introduction to NASA earthaccess" (#779) (@Sherwin-14)
  • Restore automation for tidying notebooks used in documentation (#788) (@itcarroll)
  • Remove the base class on EarthAccessFile to fix method resolution (#610) (@itcarroll)

0.10.0 2024-07-19

Changed

Added

Removed

Fixed

0.9.0 - 2024-02-28

Added

Fixed

0.8.2 - 2023-12-06

Changed

Added

Removed

Fixed

0.8.1 - 2023-12-01

Changed

Added

0.8.0 - 2023-11-29

Changed

Fixed

0.7.1 - 2023-11-08

Fixed

  • Treat granules without RelatedUrls as not cloud-hosted (#339) (@mfisher87)

0.7.0 - 2023-10-31

Changed

  • earthaccess.download now accepts a single granule as input in addition to a list of granules (#317) (@jrbourbeau)
  • earthaccess.download now returns fully qualified local file paths (#317) (@jrbourbeau)

Added

  • Earthaccess will now automatically search for Earthdata authentication. earthaccess.login() still works as before, but is no longer required if you have a ~/.netrc file for have set EARTHDATA_USERNAME and EARTHDATA_PASSWORD environment variables (#300) (@jrbourbeau, @mfisher87)
  • Add earthaccess.auth_environ() utility for getting Earthdata authentication environment variables (#316) (@jrbourbeau, @mfisher87)

Fixed

0.6.0 - 2023-09-20

Added

  • earthaccess.get_s3fs_session() can use the results to find the right set of S3 credentials (#296) (@betolink)

Fixed

0.5.3 - 2023-08-01

Added

Changed

Fixed

0.5.2 - 2023-04-21

Removed

  • Remove Benedict (core dependency) as the default dict for JSON coming from CMR (#229, #230) (@psarka)

Fixed

  • S3 credentials endpoints are tried with tokens and basic auth until all the DAACs accept the same auth (#234) (@betolink)

0.5.1 - 2023-03-20

Changed

  • For CI, documentation for readthedocs fixed by including poetry as the default tool (#214) (@betolink)
  • For CI, injected new secrets to test Auth using the icepyx convention (EARTHDATA_USERNAME) (#214) (@JessicaS11, @betolink)

Added

  • Add ability to get the user's profile with auth.user_profile which includes the user email (#214) (@betolink)
  • Add LAAD as a supported DAAC (#214) (@betolink)

Removed

  • Remove magic from dependencies (not available in windows and not used but just in tests) (#214) (@betolink)

Fixed

0.5.0 - 2023-02-23

Changed

  • For CI, documentation is now only built for the main, dev and documentation branches (#202) (@betolink)
  • For CI, notebooks are executed every time the documentation gets published! (#202) (@betolink, @asteiker)

Added

  • Add ability to use the top level API to get S3 credentials, authenticated fsspec and requests sessions! (#202) (@betolink)
  • Make available ASF direct access for Sentinel1 products (#202) (@betolink)

Fixed

  • Fix a bug where the Auth class is invoked without the proper parameters (#202) (@JessicaS11)
  • Raise and exception if a user specifies the netrc strategy and there is no netrc (#202) (@betolink)
  • S3 URLs broke the Store class when opened outside AWS (#202) (@betolink)
  • Opening files using URLs was not working properly on AWS, thanks to @amfriesz for reporting it! (#202) (@betolink, @amfriesz)

0.4.7 - 2022-12-11

Fixed

0.4.6 - 2022-12-08

Changed

  • For CI, only run the publish workflow after a release on GitHub (#183) (@betolink)

Added

  • Add feature to search collections by DOI (#183) (@betolink)
  • Add new API documentation and simplify notation to access data (#183) (@jroebuck932)

0.4.1 - 2022-11-02

Changed

  • For CI, install Poetry using the new script (#131) (@betolink)
  • For CI, change dependabot alerts to monthly (#131) (@betolink)
  • Improve documentation by reimplementing python_cmr methods for docstring compatibility (#131) (@betolink)
  • Use CMR-Search-After (#145) (@betolink)

Added

[0.4.0] - 2022-08-17

Added

  • Add store, auth to docs and update mkdocs config (#119) (@betolink)
  • For auth, add the ability to persist credentials into a .netrc file (#119) (@betolink)
  • For store, use fsspec s3fs for in cloud access and https sessions for out of region access (#43) (@betolink)
  • For store, can open files with fsspec in and out of region (stream into xarray) (#41) (@betolink)

0.3.0 - 2022-04-28

Changed

  • Update python-cmr to NASA fork (#75) (@jhkennedy)
  • Drop unused pydantic dependency (5761548) (@jhkennedy)
  • Auth can refresh CMR tokens (#82) (@betolink)
  • Verify git tag and poetry version are the same before publishing to PyPI

Added

  • Add documentation for readthedocs and GitHub (#82) (@betolink)

Removed

Fixed

  • Fix bug with CMR tokens
  • Add missing python-datutil dependency (747e992) (@jhkennedy)

0.2.2 - 2022-03-23

Fixed

0.2.1 - 2022-03-19

Changed

Added

  • Add basic classes to interact with NASA CMR, EDL and cloud access.
  • Basic object formatting.