earthaccess

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

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

Last synced: about 21 hours ago
JSON representation

Repository metadata

Python Library for NASA Earthdata APIs

• Host: GitHub
• URL: https://github.com/nsidc/earthaccess
• Owner: nsidc
• License: mit
• Created: 2021-08-25T15:25:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T20:26:41.000Z (17 days ago)
• Last Synced: 2024-04-24T10:56:24.774Z (17 days ago)
• Topics: access, climate-data, cloud-computing, cmr, data, gis, nasa, nasa-api, nasa-data, open-science, openscience, pangeo, remote-sensing
• Language: Python
• Homepage: https://earthaccess.readthedocs.io/
• Size: 9.11 MB
• Stars: 345
• Watchers: 10
• Forks: 63
• Open Issues: 113
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

README

        










    





    





    





    





    





    





## **Overview**

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

In the age of cloud computing, the power of open science only reaches its full potential if we have easy-to-use workflows that facilitate research in an inclusive, efficient and reproducible way. Unfortunately —as it stands today— scientists and students alike face a steep learning curve adapting to systems that have grown too complex and end up spending more time on the technicalities of the tools, cloud and NASA APIs than focusing on their important science.

During several workshops organized by [NASA Openscapes](https://nasa-openscapes.github.io/events.html), 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.

## **Installing earthaccess**

You will need Python 3.8 or higher installed.

Install the latest release using conda

```bash

conda install -c conda-forge earthaccess

```

Using Pip

```bash

pip install earthaccess

```

Try it in your browser without installing anything! [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nsidc/earthaccess/main)

## **Usage**

With *earthaccess* we can login, search and download data with a few lines of code and even more relevant, our code will work the same way if we are running it in the cloud or from our laptop. ***earthaccess*** handles authentication with [NASA's Earthdata Login (EDL)](https://urs.earthdata.nasa.gov), search using NASA's [CMR](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html) and access through [`fsspec`](https://github.com/fsspec/filesystem_spec).

The only requirement to use this library is to open a free account with NASA [EDL](https://urs.earthdata.nasa.gov).

### **Authentication**

By default, `earthaccess` with automatically look for your EDL account credentials in two locations:

1. A `~/.netrc` file

2. `EARTHDATA_USERNAME` and `EARTHDATA_PASSWORD` environment variables

If neither of these options are configured, you can authenticate by calling the `earthaccess.login()` method

and manually entering your EDL account credentials.

```python

import earthaccess

earthaccess.login()

```

Note you can pass `persist=True` to `earthaccess.login()` to have the EDL account credentials you enter

automatically saved to a `~/.netrc` file for future use.

Once you are authenticated with NASA EDL you can:

* Get a file from a DAAC using a `fsspec` session.

* Request temporary S3 credentials from a particular DAAC (needed to download or stream data from an S3 bucket in the cloud).

* Use the library to download or stream data directly from S3.

* Regenerate CMR tokens (used for restricted datasets)

### **Searching for data**

Once we have selected our dataset we can search for the data granules using *doi*, *short_name* or *concept_id*.

If we are not sure or we don't know how to search for a particular dataset, we can start with the ["Introducing NASA earthaccess"](https://nsidc.github.io/earthaccess/tutorials/demo/#querying-for-datasets) tutorial or through the [NASA Earthdata Search portal](https://search.earthdata.nasa.gov/). For a complete list of search parameters we can use visit the extended [API documentation](https://earthaccess.readthedocs.io/en/latest/user-reference/api/api/).

```python

results = earthaccess.search_data(

    short_name='SEA_SURFACE_HEIGHT_ALT_GRIDS_L4_2SATS_5DAY_6THDEG_V_JPL2205',

    cloud_hosted=True,

    bounding_box=(-10, 20, 10, 50),

    temporal=("1999-02", "2019-03"),

    count=10

)

```

Now that we have our results we can do multiple things: We can iterate over them to get HTTP (or S3) links, we can download the files to a local folder, or we can open these files and stream their content directly to other libraries e.g. xarray.

### **Accessing the data**

**Option 1: Using the data links**

If we already have a workflow in place for downloading our data, we can use *earthaccess* as a search-only library and get HTTP links from our query results. This could be the case if our current workflow uses a different language and we only need the links as input.

```python

# if the data set is cloud hosted there will be S3 links available. The access parameter accepts "direct" or "external", direct access is only possible if you are in the us-west-2 region in the cloud.

data_links = [granule.data_links(access="direct") for granule in results]

# or if the data is an on-prem dataset

data_links = [granule.data_links(access="external") for granule in results]

```

> Note: *earthaccess* can get S3 credentials for us, or auhenticated HTTP sessions in case we want to use them with a different library.

**Option 2: Download data to a local folder**

This option is practical if you have the necessary space available on disk. The *earthaccess* library will print out the approximate size of the download and its progress.

```python

files = earthaccess.download(results, "./local_folder")

```

**Option 3: Direct S3 Access - Stream data directly to xarray**

This method works best if you are in the same Amazon Web Services (AWS) region as the data (us-west-2) and you are working with gridded datasets (processing level 3 and above).

```python

import xarray as xr

files = earthaccess.open(results)

ds = xr.open_mfdataset(files)

```

And that's it! Just one line of code, and this same piece of code will also work for data that are not hosted in the cloud, i.e. located at NASA storage centers.

> More examples coming soon!

### Compatibility

Only **Python 3.8+** is supported.

## Contributors

[![Contributors](https://contrib.rocks/image?repo=nsidc/earthaccess)](https://github.com/nsidc/earthaccess/graphs/contributors)

## Contributing Guide

Welcome! 😊👋

> Please see the [Contributing Guide](CONTRIBUTING.md).

### [Project Board](https://github.com/nsidc/earthdata/discussions).

### Glossary

NASA Earth Science Glossary

## License

earthaccess is licensed under the MIT license. See [LICENSE](LICENSE.txt).

## Level of Support








 This repository is supported by a joint effort of NSIDC, NASA DAACs, and the Earth science community, and we welcome any contribution in the form of issue submissions, pull requests, or discussions. Issues labeled as https://github.com/nsidc/earthaccess/labels/good%20first%20issue are a great place to get started.


      

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: "[email protected]"
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.9.0"
date-released: "2024-02-28"

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

• Name: National Snow and Ice Data Center
• Login: nsidc
• Email: [email protected]
• Kind: organization
• Description: University of Colorado Boulder
• Website: http://www.nsidc.org/
• Location: Boulder, Colorado
• Twitter: NSIDC
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1874284?v=4
• Repositories: 119
• Last ynced at: 2024-04-16T01:06:28.908Z
• Profile URL: https://github.com/nsidc

---

GitHub Events

Total

• Create event: 109
• Issues event: 165
• Release event: 13
• Watch event: 191
• Delete event: 91
• Member event: 5
• Issue comment event: 723
• Push event: 306
• Pull request review comment event: 183
• Pull request review event: 258
• Pull request event: 282
• Fork event: 30

Last Year

• Create event: 90
• Delete event: 79
• Fork event: 27
• Issue comment event: 658
• Issues event: 159
• Member event: 4
• Pull request event: 249
• Pull request review comment event: 183
• Pull request review event: 254
• Push event: 237
• Release event: 10
• Watch event: 172

---

Committers metadata

Last synced: 1 day ago

Name	Email	Commits
betolink	b****n@g****m	186
Matt Fisher	m****7@g****m	76
James Bourbeau	j****u@g****m	51
betolink:w	l****z@n****g	30
doug-newman-nasa	d****n@n****v	25
jennifer	j****k@c****u	24
danielfromearth	d****n@n****v	23
Joseph H Kennedy	m****e@j****g	20
Andy Barrett	a****t@n****g	19
Matt Fisher	m****r@n****g	14
Chris Battisto	3****x	10
karthik venkataramani	k****t@v****u	10
Andy Barrett	a****t@g****m	7
Doug Newman	d****n@n****v	6
dependabot[bot]	4****]	5
Amy Steiker	4****r	5
Chuck Daniels	c****k@d****g	4
Ian Carroll	c****n@g****m	3
pre-commit-ci[bot]	6****]	3
Trey Stafford	t****d@c****u	3
Julia Stewart Lowndes	j****a@o****g	3
Jessica Scheick	j****k@g****m	3
Ian Carroll	i****l@n****v	3
vincentsarago	v****o@g****m	2
luz paz	l****z	2
Aimee Barciauskas	a****e@d****g	1
Chelle Gentemann	c****n@e****g	1
Paulius Sarka	p****a@g****m	1
rsignell	1****l	1
Rupesh Shrestha	r****a@g****m	1

Committer domains:

• nasa.gov: 4
• nsidc.org: 3
• developmentseed.org: 2
• colorado.edu: 2
• esr.org: 1
• openscapes.org: 1
• vt.edu: 1
• jhkennedy.org: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

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

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 4,339 last-month
• Total docker downloads: 155
• Total dependent packages: 3
• Total dependent repositories: 7
• Total versions: 14
• Total maintainers: 1

---

Dependencies

Score: 17.941453588466988