Skip to content

Commit

Permalink
Merge pull request #302 from cassienickles/patch-1
Browse files Browse the repository at this point in the history
Abstract unused how to's #300
  • Loading branch information
stefaniebutland authored Feb 1, 2024
2 parents e9a4547 + 30d7fd1 commit ef3d4c3
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 23 deletions.
16 changes: 8 additions & 8 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@ website:
href: how-tos/read_data.qmd
- text: "subset data"
href: how-tos/subset.qmd
- text: "reformat data files"
href: how-tos/reformat.qmd
- text: "reproject and regrid"
href: how-tos/reproject_regrid.qmd
- text: "aggregate data"
href: how-tos/aggregate.qmd
- text: "plot data"
href: how-tos/plot.qmd
#- text: "reformat data files"
# href: how-tos/reformat.qmd
#- text: "reproject and regrid"
# href: how-tos/reproject_regrid.qmd
#- text: "aggregate data"
# href: how-tos/aggregate.qmd
#- text: "plot data"
# href: how-tos/plot.qmd
- section: "use APIs"
href: how-tos/use_apis.qmd
contents:
Expand Down
8 changes: 7 additions & 1 deletion how-tos/how_to_guide_parking_lot.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ How-To. Also suggest changes to the wording. Following the Divio
documentation guide, I've tried to name how-tos with descriptive names
that start "How do I... ?".

_We need a page to explain terminology; collections, granules, ..._
How do I reformat data files?

How do I reproject and regrid?

How do I aggregate data?

How do I plot data?

How do I use Harmony to reproject a data file?

Expand Down
28 changes: 14 additions & 14 deletions how-tos/use_apis.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,36 @@ title: How do I access data using APIs?

## Using APIs

*Coming soon: Intro with short explicit description. APIs - What are they? Borrow from get-started/api-primer.md*
API stands for Application Programming Interface, and is basically "like a digital mediator that enables different software applications to talk to each other and exchange information. It defines the methods, parameters, and data formats you can use to access certain features or retrieve data from an application or service." ([How to Use An API](https://zapier.com/blog/how-to-use-api/#what))

## How do I know?

How do I know what API services are available for a dataset?

Some but not all datasets have API services that can reproject, resample or reformat files on the server file. This How-To shows how to find which services are available.
Some but not all datasets have API services that can reproject, resample or reformat files on the server file. These How-To's below show how to find which services are available:

### Services using EarthData Search
### Finding Services using EarthData Search

Finding services associated with a dataset using EarthData
After selecting a dataset and the needed files using Earthdata Search ([tutorial here](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/how-tos/find-data/earthdata_search.html)), when the download files button is selected, it will navigate users to a new page on the sidebar. If the dataset is customizable through APIs, different options will pop up under "Select a data access method" or "Configure data customization options"

### Services using CMR
### Finding Services using CMR

Find services associated with a dataset using CMR

### Services using `earthaccess`

Find services associated with a dataset using `earthaccess`
Follow [this link](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#c-service-parameters) to see how to programmatically discover what services are associated with what NASA Earthdata.

# NASA API Examples

## Harmony

short description, when to use it

[Harmony](https://harmony.earthdata.nasa.gov/) allows you to seamlessly analyze Earth observation data from different NASA data centers with services that offer data reduction and common access mechanisms across all NASA data centers. There is a python client library called [harmony-py](https://github.com/nasa/harmony-py) that exists as a wrapper for the Harmony services, and [this notebook](https://github.com/nasa/harmony/blob/main/docs/Harmony%20API%20introduction.ipynb) gives a brief introduction to the Harmony API services.

## OPeNDAP

short description, when to use it
OPeNDAP, or the [Open-source Project for a Network Data Access Protocol](https://www.earthdata.nasa.gov/engage/open-data-services-and-software/api/opendap), is a data server that allows for accessing scientific datasets through the public internet. OPeNDAP links can be acquired through dataset landing pages or the [common metadata repository](https://cmr.earthdata.nasa.gov/search/site/collections/directory/eosdis). For more information, see the [OPeNDAP Data Access Client Tutorials](https://opendap.github.io/documentation/tutorials/DataAccessTutorials.html).

## `earthaccess`

[`earthaccess`](https://earthaccess.readthedocs.io/en/latest/) is a python library to search, download or stream NASA Earth science data with just a few lines of code that also abstracts a lot of other APIs developed by NASA.

## AppEEARS

The [Application for Extracting and Exploring Analysis Ready Samples (AρρEEARS)](https://appeears.earthdatacloud.nasa.gov/) offers users a simple and efficient way to perform data access and transformation processes. By enabling users to subset data spatially, temporally, and by layer, the volume of data downloaded for analysis is greatly reduced. AppEEARS requests can be submitted in website and via API. In a same way, outputs generated can also be accessed from AppEEARS website and through API. View [AppEEARS documentation](https://appeears.earthdatacloud.nasa.gov/help) and [API documentation](https://appeears.earthdatacloud.nasa.gov/api/) for more information. Additionally, you can work with the data in the cloud using provided S3 links. Visit [AppEEARS Data Resources Repository](https://github.com/nasa/AppEEARS-Data-Resources) for more tutorials on how to work with AppEEARS programaticaly.
The [Application for Extracting and Exploring Analysis Ready Samples (AρρEEARS)](https://appeears.earthdatacloud.nasa.gov/) offers users a simple and efficient way to perform data access and transformation processes. By enabling users to subset data spatially, temporally, and by layer, the volume of data downloaded for analysis is greatly reduced. AppEEARS requests can be submitted in website and via API. In a same way, outputs generated can also be accessed from AppEEARS website and through API. View [AppEEARS documentation](https://appeears.earthdatacloud.nasa.gov/help) and [API documentation](https://appeears.earthdatacloud.nasa.gov/api/) for more information. Additionally, you can work with the data in the cloud using provided S3 links. Visit [AppEEARS Data Resources Repository](https://github.com/nasa/AppEEARS-Data-Resources) for more tutorials on how to work with AppEEARS programaticaly.

0 comments on commit ef3d4c3

Please sign in to comment.