Skip to main content

Client library for NASA Earthdata APIs

Project description

earthaccess

earthaccess, a python library to search, download or stream NASA Earth science data with just a few lines of code

DOI Art Designer: Allison Horst Package version Conda Versions Python Versions Documentation Status

earthaccess is a python library to search for, and download or stream NASA Earth science data with just a few lines of code.

Visit our documentation to learn more!

Try it in your browser without installing anything! Binder

Why earthaccess

During several workshops organized by NASA Openscapes, the need to provide easy-to-use tools to our users became evident. Open science is a collaborative effort; it involves people from different technical backgrounds, and the data analysis to solve the pressing problems we face cannot be limited by the complexity of the underlying systems. Therefore, providing easy access to NASA Earthdata regardless of the data storage location (hosted within or outside of the cloud) is the main motivation behind this Python library.

How to Get Started with earthaccess

How to install

To install earthaccess go to your terminal and install it using pip:

python -m pip install earthaccess

How to access NASA Earth Science data

With earthaccess, data is 3 steps away!

import earthaccess

# 1. Login
earthaccess.login()

# 2. Search
results = earthaccess.search_data(
    short_name='ATL06',  # ATLAS/ICESat-2 L3A Land Ice Height
    bounding_box=(-10, 20, 10, 50),  # Only include files in area of interest...
    temporal=("1999-02", "2019-03"),  # ...and time period of interest.
    count=10
)

# 3. Access
files = earthaccess.download(results, "/tmp/my-download-folder")

Visit our quick start guide for more details.

Compatibility

The minimum supported Python version is 3.10.

How to Contribute to earthaccess

If you want to contribute to earthaccess checkout the Contributing Guide.

Contributors

Contributors

Project Board.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

earthaccess-0.14.0.tar.gz (6.3 MB view details)

Uploaded Source

Built Distribution

earthaccess-0.14.0-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file earthaccess-0.14.0.tar.gz.

File metadata

  • Download URL: earthaccess-0.14.0.tar.gz
  • Upload date:
  • Size: 6.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for earthaccess-0.14.0.tar.gz
Algorithm Hash digest
SHA256 8cc0a07ac86077728396f417ae4a137293f78c6b5e30f9d2b97d362151f093a3
MD5 4e5563cbf89cef4586198c60caa1971d
BLAKE2b-256 09bba66d2fa81b06a7dce99b074a9d826bcaebd1aef5f1b7b6d58e3707190a8f

See more details on using hashes here.

File details

Details for the file earthaccess-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: earthaccess-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 64.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for earthaccess-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6553cede23042645d8abe5b0cd7584b73e364128d5a35dcd67da30fd57618602
MD5 8a3a5f47dcfc2beb67d93dff1da712e7
BLAKE2b-256 7ce38597130029c34c62d3de30462d64f8870bc0dee439bdf9bbdf3aba9d4c7e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page