earthaccess

Python Library for NASA Earthdata APIs

https://github.com/nsidc/earthaccess

Science Score: 64.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
11 of 43 committers (25.6%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary

Keywords

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

Keywords from Contributors

closember icesat-2 community-driven mesh geospatial-data gdal cython parallel energy-system-model distributed

Last synced: 4 months ago · JSON representation ·

Repository

Python Library for NASA Earthdata APIs

Basic Info

Host: GitHub
Owner: nsidc
License: mit
Language: Python
Default Branch: main
Homepage: https://earthaccess.readthedocs.io/
Size: 14.7 MB

Statistics

Stars: 534
Watchers: 13
Forks: 121
Open Issues: 135
Releases: 25

Topics

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

Created over 4 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Governance

earthaccess

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

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!

```python import earthaccess

1. Login

earthaccess.login()

2. Search

results = earthaccess.searchdata( shortname='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.

:leftspeechbubble: 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.11.

How to Contribute to `earthaccess`

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

Contributors

Project Board.

Owner

Name: National Snow and Ice Data Center
Login: nsidc
Kind: organization
Email: nsidc@nsidc.org
Location: Boulder, Colorado

Website: http://www.nsidc.org/
Twitter: NSIDC
Repositories: 119
Profile: https://github.com/nsidc

University of Colorado Boulder

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"
  - family-names: "Varghese"
    given-names: "Sherwin"
    orcid: "https://orcid.org/0009-0005-7030-213X"
    website: "https://github.com/Sherwin-14"



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/"

GitHub Events

Total

Create event: 51
Release event: 3
Issues event: 111
Watch event: 99
Delete event: 40
Issue comment event: 746
Member event: 5
Push event: 225
Pull request event: 158
Pull request review comment event: 269
Pull request review event: 359
Fork event: 35

Last Year

Create event: 51
Release event: 3
Issues event: 111
Watch event: 100
Delete event: 40
Issue comment event: 746
Member event: 5
Push event: 225
Pull request event: 158
Pull request review comment event: 269
Pull request review event: 359
Fork event: 35

Committers

Last synced: 5 months ago

All Time

Total Commits: 943
Total Committers: 43
Avg Commits per committer: 21.93
Development Distribution Score (DDS): 0.785

Past Year

Commits: 303
Committers: 23
Avg Commits per committer: 13.174
Development Distribution Score (DDS): 0.779

Top Committers

Name	Email	Commits
betolink	b**n@g**m	203
Matt Fisher	m**7@g**m	173
Sherwin Varghese	1****4	62
Joseph H Kennedy	me@j****g	61
danielfromearth	d**n@n**v	52
James Bourbeau	j**u@g**m	51
Chuck Daniels	c**k@d**g	39
betolink:w	l**z@n**g	30
Andy Barrett	a**t@n**g	26
doug-newman-nasa	d**n@n**v	25
jennifer	j**k@c**u	24
Andy Barrett	a**t@g**m	21
pre-commit-ci[bot]	6****]	20
Ian Carroll	i**l@n**v	17
ayushnag	3****g	17
dependabot[bot]	4****]	16
Matt Fisher	m**r@n**g	14
karthik venkataramani	k**t@v**u	10
Chris Battisto	3****x	10
Hailiang Zhang	h**g@n**v	9
Kevin Grimes	K**s@j**v	7
Amy Steiker	4****r	6
Trey Stafford	t**d@c**u	6
Doug Newman	d**n@n**v	6
asteiker	a**r@g**m	6
Jessica Scheick	j**k@g**m	4
Aimee Barciauskas	a**e@d**g	3
Julia Stewart Lowndes	j**a@o**g	3
Nikki	1****t	3
Julia Collins	c**j@c**u	2
and 13 more...

Committer Domains (Top 20 + Academic)

nasa.gov: 6 colorado.edu: 3 nsidc.org: 3 developmentseed.org: 2 esr.org: 1 viasat.com: 1 openscapes.org: 1 jpl.nasa.gov: 1 vt.edu: 1 jhkennedy.org: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 402
Total pull requests: 690
Average time to close issues: 4 months
Average time to close pull requests: 14 days
Total issue authors: 109
Total pull request authors: 70
Average comments per issue: 2.21
Average comments per pull request: 2.9
Merged pull requests: 352
Bot issues: 15
Bot pull requests: 262

Past Year

Issues: 81
Pull requests: 207
Average time to close issues: 8 days
Average time to close pull requests: 11 days
Issue authors: 27
Pull request authors: 32
Average comments per issue: 0.67
Average comments per pull request: 3.29
Merged pull requests: 129
Bot issues: 11
Bot pull requests: 37

View more stats

Top Authors

Issue Authors

mfisher87 (88)
betolink (35)
andypbarrett (16)
github-actions[bot] (15)
itcarroll (15)
chuckwondo (15)
jrbourbeau (14)
danielfromearth (11)
asteiker (10)
MattF-NSIDC (9)
alrolfchamberlin3 (5)
JessicaS11 (5)
scottyhq (4)
gonfgbfgbhf (3)
sertuitrew (3)

Pull Request Authors

dependabot[bot] (234)
mfisher87 (73)
Sherwin-14 (45)
betolink (41)
chuckwondo (38)
jhkennedy (35)
pre-commit-ci[bot] (28)
jrbourbeau (24)
itcarroll (21)
danielfromearth (13)
asteiker (11)
JessicaS11 (9)
andypbarrett (9)
weiji14 (6)
jules32 (5)

Top Labels

Issue Labels

enhancement (34) bug (33) documentation (27) good first issue (20) impact: documentation (13) metrics (13) automation (12) type: enhancement (12) type: bug (11) question (8) impact: automation (6) feedback requested (4) needs: help (4) needs: decision (4) needs: triage (4) help wanted (3) hackathon (2) type: experience report (2) impact: governance (2) dependencies (1) github_actions (1) needs: feedback requested (1) wontfix (1) impact/governance (1)

Pull Request Labels

dependencies (223) python (29) github_actions (28) hackathon (13) impact: dependencies (11) help wanted (6) impact: documentation (5) enhancement (2) documentation (2) automation (2) impact: governance (2) needs: help (1) impact: automation (1) type: decision record (1)

Packages

Total packages: 2
Total downloads:
- pypi 74,593 last-month
Total docker downloads: 155

Total dependent packages: 8
(may contain duplicates)
Total dependent repositories: 7
(may contain duplicates)
Total versions: 53
Total maintainers: 1

pypi.org: earthaccess

Client library for NASA Earthdata APIs

Documentation: https://earthaccess.readthedocs.io
License: MIT License
Latest release: 0.14.0
published 11 months ago

Versions: 19
Dependent Packages: 8
Dependent Repositories: 7
Downloads: 74,593 Last month
Docker Downloads: 155

Rankings

Docker downloads count: 2.3%

Dependent packages count: 2.4%

Stargazers count: 4.2%

Average: 4.4%

Dependent repos count: 5.5%

Downloads: 5.8%

Forks count: 6.3%

Maintainers (1)

betolink

Last synced: 4 months ago

proxy.golang.org: github.com/nsidc/earthaccess

Documentation: https://pkg.go.dev/github.com/nsidc/earthaccess#section-documentation
License: mit
Latest release: v0.14.0
published 11 months ago

Versions: 34
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 4 months ago

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

earthaccess

Science Score: 64.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

earthaccess

Why earthaccess

How to Get Started with earthaccess

How to install

How to access NASA Earth Science data

1. Login

2. Search

3. Access

Help!

Compatibility

How to Contribute to earthaccess

Contributors

Project Board.

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: earthaccess

Rankings

Maintainers (1)

proxy.golang.org: github.com/nsidc/earthaccess

Rankings

Dependencies

Why `earthaccess`

How to Get Started with `earthaccess`

How to Contribute to `earthaccess`