Skip to content

Commit

Permalink
add user guide page stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy Barrett committed Apr 2, 2024
1 parent bd0bf69 commit b5648d7
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/user_guide/access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Access

**Access** includes downloading files from a NASA DAAC or Earthdata Cloud to a local computer, a laptop, workstation or the storage space for a high-performace-computer (HPC); and also streaming data.


## Downloading data


## Streaming data
3 changes: 3 additions & 0 deletions docs/user_guide/authenticate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Authentication

Introduces the `earthaccess.login` method for managing Earthdata Login and cloud credentials.
13 changes: 13 additions & 0 deletions docs/user_guide/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Overview

`earthaccess` enables authentication, search and access for NASA Earth science data. The package enables users to find, and download or stream data archived both at NASA DAACs and in the AWS-hosted Earthdata Cloud. The User Guide introduces these three functions.

The [Authentication](user_guide/authentication.md) section shows how `earthaccess` can be used to manage Earth Data Login and also Earthdata Cloud credentials.

The [Search](user_guide/search.md) section introduces how to search for NASA datasets (collections) and specific data granules.

The [Access](user_guide/access.md) section introduces how to use `earthaccess` to download data to a local machine or stream data by opening it directly in memory.

Additional usage information can be found in the User Reference section. The How-To sections contains short code examples for specific workflows. Longer tutorials for working with particular datasets are in the Tutorials section.

The Glossary section contains definitions for NASA terminology and Cloud computing.
5 changes: 5 additions & 0 deletions docs/user_guide/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Search

## `search_datasets`

## `search_data`

0 comments on commit b5648d7

Please sign in to comment.