Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for credits release #433

Merged
merged 23 commits into from
Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
931b6e7
update docs for credits release
forrestfwilliams Mar 29, 2024
16c3ea9
fix capitalization
forrestfwilliams Mar 29, 2024
dad33ed
update vertex page
forrestfwilliams Mar 29, 2024
4cd7db2
update credits page
jtherrmann Mar 29, 2024
bf1e363
changelog
jtherrmann Mar 29, 2024
0b2fb02
Update docs/using/vertex.md
jtherrmann Mar 29, 2024
32bcfc3
update the pixel spacing of the InSAR jobs in the table
hjkristenson Mar 29, 2024
99c0d22
credits system -> credit system
jtherrmann Mar 29, 2024
be27a99
Merge branch 'jth-credits-updates' of github.com:ASFHyP3/hyp3-docs in…
jtherrmann Mar 29, 2024
c7ba2d6
dictionary
jtherrmann Mar 29, 2024
c091a52
move key long-term information out of the attention box
hjkristenson Mar 29, 2024
ed350e0
set links external to the page to open in new browser tabs
hjkristenson Mar 29, 2024
6e397bd
hyphenate pixel spacing values
hjkristenson Mar 29, 2024
91acbd1
Merge remote-tracking branch 'origin/jth-credits-updates' into credit…
hjkristenson Mar 29, 2024
955c54a
remove extra s
hjkristenson Mar 29, 2024
490fb45
add comma to 1000
hjkristenson Mar 29, 2024
241d707
set hyp3-docs links to open in same tab
hjkristenson Mar 29, 2024
9bff60d
move to process out of link text
hjkristenson Mar 29, 2024
cc91707
Merge pull request #435 from ASFHyP3/credits-updates-hjk
hjkristenson Mar 29, 2024
0095710
Merge pull request #434 from ASFHyP3/jth-credits-updates
jtherrmann Mar 29, 2024
0bbc4cf
Update CHANGELOG.md
jtherrmann Mar 29, 2024
f866f8b
Update CHANGELOG.md
jtherrmann Mar 29, 2024
3e5b228
Update CHANGELOG.md
jtherrmann Mar 29, 2024
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
1 change: 1 addition & 0 deletions .github/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
20x4-look
160m
80m
40m
30m
20m
10m
Expand Down
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ 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.9.0]

### Changed
* Updated language to reflect release of the full credit system to production HyP3.

### Removed
* Quota page now redirects to [Credits](using/credits.md) page.

## [0.8.9]

### Added
Expand Down
56 changes: 30 additions & 26 deletions docs/using/credits.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,48 @@
# Credits

!!! warning "Attention"
Beginning **April 1st**, ASF's On Demand [Monthly Processing Quota](/using/quota)
will be replaced by a new **credits system**.
You will be given an allotment of **10,000 credits per month**,
and each type of job will cost a different number of credits,
as shown in the table below.
Notably, you will now be able to run up to 10,000 Burst InSAR jobs per month—a 10x increase!

This change will affect all ASF On Demand users,
On **April 1st 2024**, ASF's On Demand Monthly Processing Quota (1,000 jobs per
month) was replaced by a new **credit system**.
You are now given an allotment of **10,000 credits per month**,
and each type of job costs a [different number of credits](#credit-cost-table) to process.
Notably, you can now run up to 10,000 Burst InSAR jobs per month —
a 10x increase!

This change affects all ASF On Demand users,
whether you are accessing our service via [Vertex](/using/vertex),
the [HyP3 SDK](/using/sdk), or the [HyP3 API](/using/api).

If this change adversely impacts your current workflows, or doesn't meet your needs,
please [let us know!](/contact)

The table below displays the credit cost for each type of job.
The "Maximum Jobs Per Month" column displays the maximum number of jobs that you would be able to run
in a single month if you spent your entire monthly credit allotment on jobs of the given type.

| Job Type | Cost (credits) | Maximum Jobs Per Month |
|-------------------------------------------------------------------------------|----------------:|-----------------------:|
| [**InSAR**](/guides/insar_product_guide/) | | |
|          160m pixel size (20x4 looks) | 10 | 1,000 |
|          80m pixel size (10x2 looks) | 15 | 666 |
| [**RTC**](/guides/rtc_product_guide/) | | |
|          30m pixel size | 5 | 2,000 |
|          20m pixel size | 15 | 666 |
|          10m pixel size | 60 | 166 |
| [**AutoRIFT**](https://its-live.jpl.nasa.gov/){target=_blank} | 25 | 400 |
| [**Burst InSAR**](/guides/burst_insar_product_guide/) | 1 | 10,000 |
On Demand users are given an allotment of **10,000 credits per month** to use for
processing jobs, and each type of job costs a different number of credits, as shown in the [Credit Cost Table](#credit-cost-table).

The "Maximum Jobs Per Month" column displays the maximum number of jobs that you
would be able to run in a single month if you spent your entire monthly credit
allotment on jobs of that particular type.

## Credit Cost Table
| Job Type | Cost (credits) | Maximum Jobs Per Month |
|----------------------------------------------------------------------------------|----------------:|-----------------------:|
| [**InSAR**](/guides/insar_product_guide/) | | |
|          80-m pixel spacing (20x4 looks) | 10 | 1,000 |
|          40-m pixel spacing (10x2 looks) | 15 | 666 |
| [**RTC**](/guides/rtc_product_guide/) | | |
|          30-m pixel spacing | 5 | 2,000 |
|          20-m pixel spacing | 15 | 666 |
|          10-m pixel spacing | 60 | 166 |
| [**AutoRIFT**](https://its-live.jpl.nasa.gov/){target=_blank} | 25 | 400 |
| [**Burst InSAR**](/guides/burst_insar_product_guide/) | 1 | 10,000 |

The credit cost of a given job is roughly proportional to the computational resources required to process the job.
Transitioning to a credits system allows us to distribute our resources more equitably.
This change supports our mission of [making remote-sensing data accessible](https://asf.alaska.edu/about-asf/),
Transitioning to a credit system allows us to distribute our resources more equitably.
This change supports our mission of [making remote-sensing data accessible](https://asf.alaska.edu/about-asf/ 'asf.alaska.edu/about-asf' ){target=_blank},
with the goal of providing valuable products to the widest breadth of users possible.

If your monthly credit allotment doesn't meet your needs,
please contact us and let us know how you would like to use our service.
We have several options available for increased processing.
We may be able to support increased processing, depending on your requirements.
All requests will be balanced against our mission: to make remote-sensing data accessible to the community.

## Contact Us
Expand Down
24 changes: 0 additions & 24 deletions docs/using/quota.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/using/vertex.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To request On Demand products, visit [ASF Data Search - Vertex](https://search.a

1. **Select your scenes** - RTC processing is available for Sentinel-1 GRD-H and SLC scenes with a beam mode of IW. InSAR processing requires pairs of IW SLC scenes. Use the Geographic Search in Vertex to find individual scenes to submit for RTC processing, or reference scenes to use for generating InSAR pairs. For InSAR, once you find a reference scene, use either the [Baseline](https://docs.asf.alaska.edu/vertex/baseline/ "Vertex Baseline Documentation" ){target=_blank} or [SBAS](https://docs.asf.alaska.edu/vertex/sbas/ "Vertex SBAS Documentation" ){target=_blank} Search to find scene pairs to submit for processing.

2. **Submit your request** - After selecting your scenes, access the *On Demand* <img width="30" src="https://user-images.githubusercontent.com/17994518/95892024-588b9280-0d32-11eb-8734-f1a54a9d2a20.png" /> queue to submit your processing request. You may process up to 1000 jobs per month.
2. **Submit your request** - After selecting your scenes, access the *On Demand* <img width="30" src="https://user-images.githubusercontent.com/17994518/95892024-588b9280-0d32-11eb-8734-f1a54a9d2a20.png" /> queue to submit your processing request. You may process jobs worth up to 10,000 credits per month. See our [Credits](./credits.md) page for more details.

3. **Monitor your request** - The *On Demand Products* search type displays your running and completed requests. New requests are typically available for download within an hour, but wait time will depend on processing load.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ nav:
- API Reference: using/sdk_api.md
- API: using/api.md
- Credits: using/credits.md
- Processing Quota: using/quota.md
- Subscriptions: using/subscriptions.md
- Products:
- products.md
Expand Down Expand Up @@ -119,3 +118,4 @@ plugins:
# See: https://github.com/datarobot/mkdocs-redirects/issues/16
getting_started.md: 'https://hyp3-docs.asf.alaska.edu/#getting-started'
tutorials/mintpy.md: 'https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-docs/blob/main/docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb'
using/quota.md: 'using/credits.md'
2 changes: 1 addition & 1 deletion overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{% block announce %}
<div id="announcement-content">
⚠️ Monthly processing quotas will be replaced by a credits system on April 1st.<br />
⚠️ Monthly processing quotas were replaced by a credit system on April 1st.<br />
<a class="announcement-link" href="/using/credits">Read the full announcement.</a>
</div>
{% endblock %}
Loading