Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
e17e8ad
add comment reminder to update whitelist email template
jtherrmann Apr 20, 2026
2eb66b3
add quickstart for HyP+ and Vertex+
jacquelynsmale Apr 20, 2026
778cd4d
add in Vertex+ to HyP3+ about
jacquelynsmale Apr 20, 2026
4fc57b0
update using snippet
jacquelynsmale Apr 20, 2026
2587fad
remove extra header
jacquelynsmale Apr 20, 2026
db96fa2
Merge pull request #712 from ASFHyP3/add-comment
jtherrmann Apr 21, 2026
e5b1ce0
Merge branch 'develop' into hyp3-plus-getstarted
jacquelynsmale Apr 21, 2026
dde8485
move vertex+ into intro section
hjkristenson Apr 22, 2026
e12c9c8
fix broken link
hjkristenson Apr 22, 2026
f73cb8e
change using vertex page to include Vertex+
hjkristenson Apr 22, 2026
0d3c40b
add hyp3+ link
hjkristenson Apr 22, 2026
ca12360
reorganize vertex deployments section
hjkristenson Apr 22, 2026
03c7b91
reference main using vertex page in using snippet
hjkristenson Apr 22, 2026
eb41a61
add vertex plus image
hjkristenson Apr 22, 2026
556c2b8
starting draft of reducing daac credit allotment to 4,000 per month
asjohnston-asf Apr 23, 2026
251092e
enhance vertex+ documentation
hjkristenson Apr 23, 2026
d741587
edits links for consistency
hjkristenson Apr 23, 2026
0fd0155
break up long link into multiples
hjkristenson Apr 23, 2026
2ec4089
edit links for consistency
hjkristenson Apr 23, 2026
0c368d8
edit changelog
hjkristenson Apr 23, 2026
0172fc5
add hyphen
hjkristenson Apr 23, 2026
4266902
remove capitalization
hjkristenson Apr 23, 2026
6f72b5d
Merge pull request #713 from ASFHyP3/hyp3-plus-getstarted
jacquelynsmale Apr 23, 2026
71b194c
Merge remote-tracking branch 'origin/develop' into daac-credits
hjkristenson Apr 23, 2026
ea90c12
update changelog
hjkristenson Apr 23, 2026
709a10c
expand whats new entry for April 24
hjkristenson Apr 23, 2026
feb121f
edit admonition
hjkristenson Apr 23, 2026
c412c6e
edits to whats_new.md blurb
hjkristenson Apr 23, 2026
30ec3a7
more edits to whats_new.md blurb
hjkristenson Apr 23, 2026
c3eb7bf
edit links in whats_new.md blurb
hjkristenson Apr 23, 2026
c00c8e7
add comma
hjkristenson Apr 23, 2026
d43100d
change link text
hjkristenson Apr 23, 2026
74ff5b3
Merge pull request #714 from ASFHyP3/daac-credits
asjohnston-asf Apr 23, 2026
1bc379a
change absolute link to relative link
hjkristenson Apr 24, 2026
8f99fd4
Merge pull request #716 from ASFHyP3/abs-link
hjkristenson Apr 24, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [0.13.4]

### Added
* Vertex+ documentation
* [What's New](docs/whats_new.md#apr-24-2026) entry about credit limit reduction

### Changed
* Credit limit reduced from 8,000 to 4,000

## [0.13.3]

### Changed
Expand Down
48 changes: 34 additions & 14 deletions docs/about/hyp3_plus.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,48 @@
# HyP3+

For users who need to process more
[On Demand products](../products.md "Jump to the Products landing page of the documentation") than their
[HyP3 Basic credit limit](../using/credits.md "Jump to the Credits page of the documentation")
[On Demand products](../products.md "Products Documentation") than their
[HyP3 Basic credit limit](../using/credits.md "Credits Documentation")
allows, ASF provides HyP3+, a separate
[HyP3 deployment](../about.md) where users can purchase additional credits.
[HyP3 deployment](../about.md "About HyP3") where users can purchase additional credits.

HyP3+ offers the same
[On Demand products](../products.md "Jump to the Products landing page of the documentation")
as [HyP3 Basic](hyp3_basic.md "Jump to HyP3 Basic Documentation"),
[On Demand products](../products.md "Products Documentation")
as [HyP3 Basic](hyp3_basic.md "HyP3 Basic Documentation"),
and users access their purchased credits by logging in with the same
[Earthdata Login Credentials](../using/authentication.md#earthdata-login-edl)
[Earthdata Login Credentials](../using/authentication.md#earthdata-login-edl "Earthdata Login Documentation")
used for ordering free On Demand products from HyP3 Basic.

## Vertex+

[Vertex+](https://vertex-plus.asf.alaska.edu/ "https://vertex-plus.asf.alaska.edu" ){target=_blank}
is a separate deployment of ASF's Data Search Vertex interface, designed specifically for working with HyP3+. It
provides the same functionality as the standard deployment of Vertex, but is set to use the
[HyP3+ API Endpoint](#hyp3-api-endpoint "HyP3 API Endpoint Documentation").

You can use the Vertex+ interface to search for available datasets, submit HyP3+ On Demand jobs for processing,
and access finished products.

## HyP3+ API Endpoint

HyP3+ has a different API Endpoint than the standard HyP3 Basic deployment:
The lowest-level interface for using HyP3 is the Application Programming Interface (API). All other access methods,
including Vertex and the HyP3 Python SDK, are built upon the
[HyP3 API](../using/api.md "Using HyP3 API Documentation").

HyP3+ has a different API Endpoint than the standard HyP3 Basic deployment, so HyP3+ users will interact with the
following API URL:
<https://hyp3-plus.asf.alaska.edu>

Users can interact with HyP3+ using the same methods as HyP3 Basic, but will need to change the API URL.
See the [Using HyP3](../using.md) section for more information on how to request On Demand products with HyP3+ using
[Vertex](../using/vertex.md#1-select-your-hyp3-api-optional "Jump to Using Vertex Documentation"), the
[HyP3 Python SDK](https://hyp3-docs.asf.alaska.edu/using/sdk/#connect-to-the-hyp3-api "Jump to Using SDK Documentation"),
or by using the [HyP3 API](../using/api.md "Jump to Using API Documentation") directly.
See [Using HyP3](../using.md "Using HyP3 Documentation")
for more information on how to request On Demand products with HyP3+ using the
[HyP3 Python SDK](https://hyp3-docs.asf.alaska.edu/using/sdk/#connect-to-the-hyp3-api "Using SDK Documentation")
or by using the [HyP3 API](../using/api.md "Using API Documentation") directly.

You can also submit jobs to HyP3+ using the standard version of Vertex by
[updating the HyP3 API in Vertex](../using/vertex.md#hyp3-api-endpoints "Update API Documentation").
It is more straightforward to use Vertex+ to interact with HyP3+ jobs, however, as it eliminates the
need to manually set the API Endpoint.

## Purchasing Credits

Expand All @@ -39,14 +59,14 @@ Credit purchases will be processed within two business days, and purchased credi
1. Enter the desired quantity of 1000-credit bundles, and click the **Add to Cart** button.
![Credit purchase interface](../images/hyp3-credit-purchase.png "Credit purchase interface")
Refer to the
[credit cost table](../using/credits.md#credit-cost-table)
[credit cost table](../using/credits.md#credit-cost-table "Credit Cost Table")
to calculate the number of credits you will need to process the products you require.

2. Enter your
[Earthdata Login (EDL)](../using/authentication.md#earthdata-login-edl) username.
**It is very important to enter your username correctly**, as the credits you purchase will be associated with
this username. Type `yes` in the **terms of service field** to indicate that you accept the HyP3+
[Terms of Service](hyp3_plus_terms.md "Jump to HyP3+ Terms of Service page"), then click **Continue**.
[Terms of Service](hyp3_plus_terms.md "HyP3+ Terms of Service"), then click **Continue**.
![Enter EDL Prompt](../images/purchase-credits-edl.png "Enter EDL Username when prompted")

- You can purchase credits for multiple EDL usernames in one order. To add additional credits linked to a
Expand Down Expand Up @@ -93,7 +113,7 @@ ASF User Services, [uso@asf.alaska.edu](mailto:uso@asf.alaska.edu "uso@asf.alask
you to understand and resolve the issue. Any refunds granted will be credited to the original method of payment.

For more information about the HyP3+ refund policy, refer to the
[HyP3+ Terms of Service](hyp3_plus_terms.md#6-refunds "Jump to HyP3+ Terms of Service").
[HyP3+ Terms of Service](hyp3_plus_terms.md#6-refunds "HyP3+ Terms of Service").

## Contact Us

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/gunw_product_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ for the **ARIA S1 GUNW** Dataset and activate the **On Demand** toggle switch to

4. Click on the **On Demand** icon for a desired date pair, click the **ARIA_S1_GUNW** job type, and click
**Add 1 SLC Pair** to
[add it to the On Demand Queue](../using/vertex.md#2-select-your-scenes "Jump to the Using Vertex page of this documentation").
[add it to the On Demand Queue](../using/vertex.md#1-select-your-scenes "Jump to the Using Vertex page of this documentation").

![Submit an ARIA GUNW job](../images/aria-gunw-submit-job.png "Submit an ARIA S1 GUNW Job for On Demand Processing")

Expand Down
Binary file added docs/images/vertex-plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 26 additions & 22 deletions docs/using-snippet.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
On Demand products processed by HyP3 can be requested quickly and easily, either by
using the [Vertex web interface](#web-access "Jump to Web Access section")
or [programmatically](#programmatic-access "Jump to Programmatic Access section").
using the [Vertex web interface](#web-access "Web Access Documentation")
or [programmatically](#programmatic-access "Programmatic Access Documentation").
These services are currently only available for
[Sentinel-1 datasets](sentinel1.md "Sentinel-1 Mission" ){target=_blank}.
[Sentinel-1 datasets](sentinel1.md "Sentinel-1 Mission Documentation").

Different HyP3 job types consume different credit amounts. In
[HyP3 Basic](about/hyp3_basic.md "Jump to HyP3 Basic Documentation"),
[HyP3 Basic](about/hyp3_basic.md "HyP3 Basic Documentation"),
users are allotted {{ CREDITS_PER_MONTH }} credits per month for free. Refer to the
[Credits page](using/credits.md "Jump to the Credits documentation page")
[Credits page](using/credits.md "Credits Documentation")
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+](about/hyp3_plus.md "Jump to HyP3+ Documentation").
project, you can purchase additional credits in [HyP3+](about/hyp3_plus.md "HyP3+ Documentation").

<!-- TODO TOOL-2787: uncomment this block and update snippet language if we ever decide to require that new users
request access to HyP3 Basic:
Expand All @@ -23,16 +23,19 @@ request access to HyP3 Basic:
HyP3 users must authenticate with
[Earthdata Login (EDL)](https://urs.earthdata.nasa.gov/ "https://urs.earthdata.nasa.gov/" ){target=_blank}
credentials before they can submit jobs to HyP3 (either HyP3 Basic or HyP3+) for processing or access information
about the resulting [On Demand products](products.md "hyp3-docs.asf.alaska.edu/products"). Refer to our
[Authentication](using/authentication.md "Jump to Authentication Documentation") page for guidance.
about the resulting [On Demand products](products.md "Products Documentation"). Refer to our
[Authentication](using/authentication.md "Authentication Documentation") 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.
ASF's Data Search [Vertex](using/vertex.md "Using Vertex Documentation") portal provides a rich interface to explore Sentinel-1
acquisitions and find images to submit for [HyP3 Basic](about/hyp3_basic "HyP3 Basic Documentation")
On Demand processing. It also provides tools for selecting pairs and stacks for InSAR analysis.

* [Vertex](using/vertex.md "Using Vertex")
The [Vertex+](using/vertex.md#vertex_1 "Vertex Deployments Documentation")
interface is optimized for [HyP3+](about/hyp3_plus.md "HyP3+ Documentation") users. It provides the same
functionality as the standard Vertex portal, but connects to the
[HyP3+ API Endpoint](about/hyp3_plus.md#hyp3-api-endpoint "HyP3 API Endpoint Documentation") by default.

### Programmatic Access
Requesting and downloading On Demand products can also be done programmatically:
Expand All @@ -42,22 +45,23 @@ Requesting and downloading On Demand products can also be done programmatically:

### HyP3 API REST Endpoints

The [HyP3 API REST Endpoints](using/api.md "Jump to Using HyP3 API Documentation")
are different for HyP3 Basic and HyP3+. Even though the same
[EDL username](using/authentication.md#earthdata-login-edl "Jump to Earthdata Login Documentation")
The [HyP3 API REST Endpoints](using/api.md "Using HyP3 API Documentation")
are different for [HyP3 Basic](about/hyp3_basic.md "HyP3 Basic Documentation")
and [HyP3+](about/hyp3_plus.md "HyP3+ Documentation"). Even though the same
[EDL username](using/authentication.md#earthdata-login-edl "Earthdata Login Documentation")
can be used to process On Demand products in
[HyP3 Basic](about/hyp3_basic.md "Jump to HyP3 Basic Documentation") and
[HyP3+](about/hyp3_plus.md "Jump to HyP3+ Documentation")
[HyP3 Basic](about/hyp3_basic.md "HyP3 Basic Documentation") and
[HyP3+](about/hyp3_plus.md "HyP3+ Documentation")
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](about/hyp3_basic.md "Jump to HyP3 Basic Documentation")
and [HyP3+](about/hyp3_plus.md "Jump to HyP3+ Documentation") deployments,
[HyP3 Basic](about/hyp3_basic.md "HyP3 Basic Documentation")
and [HyP3+](about/hyp3_plus.md "HyP3+ Documentation") 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](using/vertex.md "Jump to Using Vertex Documentation") or the
[HyP3 API](using/api.md "Jump to Using HyP3 API Documentation").
when using [Vertex](using/vertex.md "Using Vertex Documentation") or the
[HyP3 API](using/api.md "Using HyP3 API Documentation").

When using the [HyP3 SDK for Python](using/sdk.md "Jump to Using HyP3 SDK Documentation"), you can combine your results
When using the [HyP3 SDK for Python](using/sdk.md "Using HyP3 SDK Documentation"), you can combine your results
into one list using the following approach:
```
import hyp3_sdk as sdk
Expand Down
Loading
Loading