earthaccess 0.18.0

Client library for NASA Earthdata APIs

earthaccess

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!

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.

Help!

We're here for you! Before you open a new issue/discussion/topic, please search to see if anyone else has opened a similar one.

:bug: If you've found a bug or mistake, please use GitHub issues.

:bulb: If you'd like to request a feature or ask a question, please use GitHub discussions.

:left_speech_bubble: If you prefer real-time chat, please visit us in our Zulip chat space! We'd love to see you there! :open_hands:

Compatibility

The minimum supported Python version is 3.12.

How to Contribute to earthaccess

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

Contributors