Using ASF HyP3¶

On Demand products processed by HyP3 can be requested quickly and easily, either by using the Vertex web interface or programmatically. These services are currently only available for Sentinel-1 datasets.

Different HyP3 job types consume different credit amounts. In HyP3 Basic, users are allotted 10,000 credits per month for free. Refer to the Credits page for more information.

If you do not have enough credits to generate all the products you need for your project, you can purchase additional credits in HyP3+.

Authentication¶

HyP3 users must authenticate with Earthdata Login (EDL) credentials before they can submit jobs to HyP3 (either HyP3 Basic or HyP3+) for processing or access information about the resulting On Demand products. Refer to our Authentication page for guidance.

Web Access¶

ASF's Data Search Vertex portal provides a rich interface to explore Sentinel-1 acquisitions and find images to submit for On Demand processing. It also provides tools for selecting pairs and stacks for InSAR analysis.

Vertex

Programmatic Access¶

Requesting and downloading On Demand products can also be done programmatically:

HyP3 API REST Endpoints¶

The HyP3 API REST Endpoints are different for HyP3 Basic and HyP3+. Even though the same EDL username can be used to process On Demand products in HyP3 Basic and HyP3+ deployments, you will not be able to search for products across both APIs.

If you generate products for a single project using both the HyP3 Basic and HyP3+ deployments, you will need to use two separate searches to access all of your products, even if the project names are the same, when using Vertex or the HyP3 API.

When using the HyP3 SDK for Python, you can combine your results into one list using the following approach:

import hyp3_sdk as sdk
hyp3 = sdk.HyP3()
hyp3_plus = sdk.HyP3('https://hyp3-plus.asf.alaska.edu')
jobs = hyp3.find_jobs(...)
jobs += hyp3_plus.find_jobs(...)
jobs.download_files()

Public Visibility of Jobs¶

Warning

All jobs submitted to HyP3, whether via web access or programmatic access, are publicly visible. Anyone with access to HyP3 can potentially:

View your jobs and associated metadata, including job name and user ID.
Download any products generated by your jobs.

In particular, do not include any sensitive information in your job names.

Citing HyP3¶

To reference HyP3 in manuscripts, cite our documentation available at ASF's hyp3-docs GitHub repository:

Hogenson, K., Kristenson, H., Kennedy, J., Johnston, A., Rine, J., Logan, T., Zhu, J., Williams, F., Herrmann, J., Smale, J., & Meyer, F. (2020). Hybrid Pluggable Processing Pipeline (HyP3): A cloud-native infrastructure for generic processing of SAR data [Computer software]. https://doi.org/10.5281/zenodo.4646138

See the Usage Guidelines section for more information on citing and/or acknowledging On Demand products.