From ece34405e7193d8f1b94674f59bc1a2ed2c2f116 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 19 Aug 2024 14:26:56 -0600 Subject: [PATCH] Add quickstart to README --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a136d5a7..1cad47f3 100644 --- a/README.md +++ b/README.md @@ -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