Skip to content

Commit

Permalink
Merge pull request #789 from nsidc/readme-quickstart
Browse files Browse the repository at this point in the history
Add quickstart to README
  • Loading branch information
mfisher87 authored Aug 19, 2024
2 parents facef47 + ece3440 commit f5283fa
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,30 @@ To install `earthaccess` go to your terminal and install it using `pip`:
pip install earthaccess
```

Visit [our quick start guide](https://earthaccess.readthedocs.io/en/latest/quick-start/) to learn how to install and see a simple example of using `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.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](https://earthaccess.readthedocs.io/en/latest/quick-start/) for more details.


## Compatibility
Expand Down

0 comments on commit f5283fa

Please sign in to comment.