earthaccess

Search, download or stream NASA Earth science data with just a few lines of code.
https://github.com/nsidc/earthaccess

Category: Sustainable Development
Sub Category: Data Catalogs and Interfaces

Keywords

access climate-data cloud-computing cmr data gis nasa nasa-api nasa-data open-science openscience pangeo remote-sensing

Keywords from Contributors

icesat-2 glacier closember cryosphere zarr earth-observation transforms community-driven archiving observation

Last synced: about 5 hours ago
JSON representation

Repository metadata

Python Library for NASA Earthdata APIs

README.md

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! 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.

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.

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

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

🗨️ If you prefer real-time chat, please visit us in our
Zulip chat space!
We'd love to see you there! 👐

Compatibility

The minimum supported Python version is 3.11.

How to Contribute to earthaccess

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

Contributors

Contributors

Project Board.

Citation (CITATION.cff)

cff-version: 1.2.0
message: |
  Please cite this software using these metadata.
  Authors are listed in alphabetical order.

title: "earthaccess"
doi: "10.5281/zenodo.8365009"
abstract: "Python Library for NASA Earthdata APIs"
contact:
  - name: "The earthaccess community"
    website: "https://github.com/nsidc/earthaccess/discussions"
  - name: "NSIDC"
    email: "nsidc@nsidc.org"
type: "software"
# NOTE: The CFF spec says `license` can be a list, but Zenodo is currently not
#       accepting lists for this key:
#       https://github.com/zenodo/zenodo/issues/2515
license: "MIT"
keywords:
  - "data"
  - "Remote sensing"
  - "Cloud computing"
  - "authentication"
  - "Earthdata Login"

url: "https://earthaccess.readthedocs.io"
repository-code: "https://github.com/nsidc/earthaccess"

version: "0.14.0"
date-released: "2025-02-11"

authors:
  - family-names: "Barrett"
    given-names: "Andrew"
    orcid: "https://orcid.org/0000-0003-4394-5445"
    website: "https://github.com/andypbarrett"
  - family-names: "Battisto"
    given-names: "Chris"
    orcid: "https://orcid.org/0000-0002-9608-3634"
    website: "https://github.com/battistowx"
  - family-names: "Bourbeau"
    given-names: "James"
    orcid: "https://orcid.org/0000-0003-2164-7789"
    website: "https://github.com/jrbourbeau"
  - family-names: "Fisher"
    given-names: "Matt"
    orcid: "https://orcid.org/0000-0003-3260-5445"
    website: "https://mfisher87.github.io/"
  - family-names: "Kaufman"
    given-names: "Daniel"
    orcid: "https://orcid.org/0000-0002-1487-7298"
    website: "https://github.com/danielfromearth"
  - family-names: "Kennedy"
    given-names: "Joseph"
    orcid: "https://orcid.org/0000-0002-9348-693X"
    website: "https://github.com/jhkennedy"
  - family-names: "Lopez"
    given-names: "Luis"
    orcid: "https://orcid.org/0000-0003-4896-3263"
    website: "https://github.com/betolink"
  - family-names: "Lowndes"
    given-names: "Julia"
    orcid: "https://orcid.org/0000-0003-1682-3872"
    website: "https://github.com/jules32"
  - family-names: "Scheick"
    given-names: "Jessica"
    orcid: "https://orcid.org/0000-0002-3421-4459"
    website: "https://github.com/JessicaS11"
  - family-names: "Steiker"
    given-names: "Amy"
    orcid: "https://orcid.org/0000-0002-3039-0260"
    website: "https://github.com/asteiker"



references:
  - type: "grant"
    title: "Openscapes: Supporting better science for future us"
    institution:
      name: "National Aeronautics and Space Administration"
    number: "20-TWSC20-2-0003"
    authors:
      - family-names: "Lowndes"
        given-names: "Julia"
        orcid: "https://orcid.org/0000-0003-1682-3872"
        website: "https://github.com/jules32"
      - family-names: "Robinson"
        given-names: "Erin"
        orcid: "https://orcid.org/0000-0001-9998-0114"
        website: "https://erinrobinson.info/"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 863
Total Committers: 42
Avg Commits per committer: 20.548
Development Distribution Score (DDS): 0.767

Commits in past year: 348
Committers in past year: 26
Avg Commits per committer in past year: 13.385
Development Distribution Score (DDS) in past year: 0.664

Name Email Commits
betolink b****n@g****m 201
Matt Fisher m****7@g****m 172
Joseph H Kennedy me@j****g 59
Sherwin Varghese 1****4 51
James Bourbeau j****u@g****m 51
Chuck Daniels c****4@g****m 34
danielfromearth d****n@n****v 32
betolink:w l****z@n****g 30
doug-newman-nasa d****n@n****v 25
jennifer j****k@c****u 24
Andy Barrett a****t@n****g 19
Ian Carroll i****l@n****v 17
ayushnag 3****g 17
pre-commit-ci[bot] 6****] 16
Matt Fisher m****r@n****g 14
dependabot[bot] 4****] 12
Chris Battisto 3****x 10
karthik venkataramani k****t@v****u 10
Hailiang Zhang h****g@n****v 9
Andy Barrett a****t@g****m 7
Trey Stafford t****d@c****u 6
Doug Newman d****n@n****v 6
asteiker a****r@g****m 6
Amy Steiker 4****r 5
Jessica Scheick j****k@g****m 4
Julia Stewart Lowndes j****a@o****g 3
Nikki 1****t 3
Julia Collins c****j@n****g 2
Wei Ji 2****4 2
jbrownrs 3****s 2
and 12 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 363
Total pull requests: 495
Average time to close issues: 3 months
Average time to close pull requests: 12 days
Total issue authors: 76
Total pull request authors: 43
Average comments per issue: 3.91
Average comments per pull request: 2.89
Merged pull request: 239
Bot issues: 12
Bot pull requests: 227

Past year issues: 154
Past year pull requests: 155
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 11 days
Past year issue authors: 33
Past year pull request authors: 29
Past year average comments per issue: 3.62
Past year average comments per pull request: 4.2
Past year merged pull request: 114
Past year bot issues: 12
Past year bot pull requests: 29

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/nsidc/earthaccess

Top Issue Authors

  • mfisher87 (108)
  • betolink (38)
  • jrbourbeau (18)
  • chuckwondo (18)
  • itcarroll (16)
  • andypbarrett (13)
  • github-actions[bot] (12)
  • MattF-NSIDC (11)
  • asteiker (11)
  • danielfromearth (10)
  • JessicaS11 (7)
  • scottyhq (4)
  • botanical (4)
  • rupesh2 (4)
  • jhkennedy (4)

Top Pull Request Authors

  • dependabot[bot] (215)
  • mfisher87 (53)
  • jrbourbeau (35)
  • betolink (30)
  • chuckwondo (22)
  • Sherwin-14 (22)
  • jhkennedy (19)
  • itcarroll (13)
  • pre-commit-ci[bot] (12)
  • danielfromearth (9)
  • asteiker (7)
  • JessicaS11 (6)
  • MattF-NSIDC (5)
  • andypbarrett (5)
  • jules32 (4)

Top Issue Labels

  • enhancement (60)
  • documentation (52)
  • bug (47)
  • good first issue (30)
  • type: bug (21)
  • automation (19)
  • type: enhancement (16)
  • impact: documentation (13)
  • metrics (12)
  • question (9)
  • help wanted (7)
  • needs: decision (6)
  • needs: help (5)
  • impact: automation (3)
  • feedback requested (3)
  • hackathon (2)
  • needs: feedback requested (2)
  • github_actions (1)
  • impact: dependencies (1)
  • impact: breaking (1)
  • wontfix (1)
  • dependencies (1)
  • impact/governance (1)

Top Pull Request Labels

  • dependencies (209)
  • python (20)
  • github_actions (14)
  • hackathon (8)
  • impact: dependencies (6)
  • help wanted (3)
  • impact: documentation (2)
  • enhancement (1)
  • documentation (1)
  • automation (1)
  • needs: help (1)
  • impact: automation (1)

Package metadata

pypi.org: earthaccess

Client library for NASA Earthdata APIs

  • Homepage:
  • Documentation: https://earthaccess.readthedocs.io
  • Licenses: MIT License
  • Latest release: 0.14.0 (published 3 months ago)
  • Last Synced: 2025-04-29T16:09:23.931Z (1 day ago)
  • Versions: 19
  • Dependent Packages: 8
  • Dependent Repositories: 7
  • Downloads: 69,008 Last month
  • Docker Downloads: 155
  • Rankings:
    • Docker downloads count: 2.317%
    • Dependent packages count: 2.377%
    • Stargazers count: 4.196%
    • Average: 4.412%
    • Dependent repos count: 5.533%
    • Downloads: 5.775%
    • Forks count: 6.275%
  • Maintainers (1)

Dependencies

pyproject.toml pypi
  • autoflake >=1.3 develop
  • black >=21.11b0 develop
  • flake8 >=3.7 develop
  • ipywidgets ^7.7.0 develop
  • isort >=5 develop
  • jupyterlab >=3 develop
  • markdown-include >=0.6 develop
  • mkdocs >=1.2 develop
  • mkdocs-jupyter =0.19.0 develop
  • mkdocs-material >=7.1,<9.0 develop
  • mkdocstrings >=0.18 develop
  • mypy >=0.812 develop
  • pre-commit >=2.4 develop
  • pygments =2.11.1 develop
  • pymdown-extensions =9.2 develop
  • pytest >=6.0 develop
  • pytest-cov >=2.8 develop
  • pytest-watch >=4.2 develop
  • responses >=0.14 develop
  • types-requests >=0.1 develop
  • types-setuptools >=0.1 develop
  • widgetsnbextension ^3.6.0 develop
  • pqdm >=0.1
  • python >=3.8,<4.0
  • python-benedict >=0.25
  • python-cmr >=0.7
  • requests >=2.26
  • s3fs >=2021.11, <2024
  • tinynetrc ^1.3.1
.github/workflows/issue-manager.yml actions
  • tiangolo/issue-manager master composite
.github/workflows/publish.yml actions
  • JRubics/poetry-publish v1.8 composite
  • actions/checkout v2 composite
.github/workflows/test.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • codecov/codecov-action v1 composite
.github/workflows/integration-test.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • codecov/codecov-action v1 composite
poetry.lock pypi
  • 194 dependencies
.github/workflows/pr-rtd-link.yml actions
  • readthedocs/actions/preview v1 composite
.github/workflows/static-analysis.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/test-mindeps.yml actions
  • actions/checkout v4.1.1 composite
  • codecov/codecov-action v1 composite
  • conda-incubator/setup-miniconda v2.2.0 composite
binder/environment.yml conda
  • cartopy >=0.18.0
  • dask >=2022.1
  • geopandas >=0.9
  • h5netcdf >=0.11
  • h5py >=3.2
  • holoviews
  • hvplot
  • ipyleaflet >=0.15
  • jupyterlab >=3
  • matplotlib-base >=3.3
  • netcdf4 >=1.5
  • panel
  • python 3.9.*
  • rioxarray >=0.3
  • xarray >=0.19
  • zarr >=2.9.5

Score: 21.310256428399462