Release v0.12.0 - HyP3+

.github/dictionary.txt

@@ -37,6 +37,7 @@ aaaaaaaa
 acknowledgement
 adaptively
 adf
+AKT
 al.
 ANF
 antimeridian
@@ -54,6 +55,7 @@ area.tif
 ARIA-S1-GUNW
 ARIA-S1-GUNWs
 ARIA_S1_GUNW
+asf
 ASF
 ASF's
 ASF-specific
@@ -85,6 +87,7 @@ Changelog
 Clauss
 CLI
 CloudFormation
+CloudFront
 CNAME
 conda
 Conda
@@ -127,6 +130,7 @@ E053_1
 E054_1
 Earthdata
 EarthScope
+EDC
 EDL
 EGM2008
 EGM96
@@ -198,10 +202,13 @@ HV
 hydrostatic
 HyP3
 hyp3
+HyP3's
 hyp3-docs
 hyp3-gamma
 HyP3-generated
 HyP3-ISCE2
+HyP3-related
+hyp3_plus_cost
 hyp3_sdk
 IaC
 Iain
@@ -230,6 +237,7 @@ ionosphereBurstRamps
 ISCE2
 ISCE2's
 ISCE3
+ISRO
 iteratively
 IW
 Jinja2
@@ -270,6 +278,7 @@ lv_phi
 lv_theta
 LVθ
 LVφ
+Majeure
 map-centric
 MapReady
 Markert
@@ -278,9 +287,11 @@ mathjax
 MCF
 mcf
 Menz
+merchantability
 Miniconda
 MintPy
 mintpy
+mkdocs
 MkDocs
 mosaicked
 mosaicking
@@ -438,6 +449,7 @@ superpixel
 T115-245714-IW1
 TBD
 tif
+timeframe
 TODO
 TopsApp
 tradeoffs
@@ -448,6 +460,7 @@ troposphereHydrostatic
 troposphereWet
 Twele
 UAF
+UAF's
 UI
 unbuffered
 uncomment

CHANGELOG.md

@@ -6,11 +6,30 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 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.12.0]
+
+### Added
+* Added logos for the HyP3+ deployment
+* Added documentation for [HyP3+](docs/about/hyp3_plus.md), including [Terms and Conditions](docs/about/hyp3_plus_terms.md)
+* Added HyP3+ announcement to the [What's New](docs/whats_new.md) section
+* Amended other documentation topics to include HyP3+ references and guidance
+* Added a column for product cost when using HyP3+ in the [Credit Cost Table](docs/using/credits.md#credit-cost-table)
+
+### Changed
+* Dropped the use of the asf mkdocs theme in favor of the material theme for site rendering
+* Moved reference to the [Usage Guidance](docs/usage_guidelines.md) document from the Products menu to the Using menu with the title *How to Cite HyP3*
+* Updated HyP3 SDK to [v7.7.4](https://github.com/ASFHyP3/hyp3-sdk/blob/main/CHANGELOG.md#774)
+
+### Removed
+* Removed landing page for subscriptions
+
 ## [0.11.2]
+
 ### Removed
 * OPERA RTC-S1 jobs from the credits table as they are not ready for general availability yet.
 
 ## [0.11.1]
+
 ### Added
 * Added a funding credit statement to the ARIA_S1_GUNW product guide.
 
@@ -247,7 +266,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [0.9.2]
 
 ### Added
-* Added [Requesting Access page](docs/using/request_access.md), not yet listed in the site index
+* Added [Requesting Access page](docs/using/requesting_access.md), not yet listed in the site index
 * Added references to requesting access in the [Using HyP3](docs/using-snippet.md) documentation, commented out until new users must apply for access
 
 ### Changed
@@ -860,7 +879,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [0.3.0](https://github.com/ASFHyP3/hyp3-docs/compare/v0.2.2...v0.3.0)
 
 ### Added
-* Added a [Contact Us snippet](docs/contact-snippet.md) that is used on the [Home](docs/index.md) page
+* Added a [Contact Us snippet](docs/contact-snippet.md) that is used on the [Home](docs/about.md) page
   and a new [Contact Us](docs/contact-snippet.md) page
 * Added SAR Basics -> [Introduction to SAR](docs/guides/introduction_to_sar.md) page
 * Added Products -> InSAR -> [InSAR Product Guide](docs/guides/insar_product_guide.md) page

README.md

@@ -2,8 +2,8 @@
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4646138.svg)](https://doi.org/10.5281/zenodo.4646138)
 
-HyP3 documentation is built using [MkDocs](https://www.mkdocs.org/) and the
-[ASF Theme](https://github.com/ASFHyP3/mkdocs-asf-theme).
+HyP3 documentation is built using [MkDocs](https://www.mkdocs.org/) and a customized version of the
+[Material Theme](https://squidfunk.github.io/mkdocs-material/).
 
 ## How to
 

docs/about.md

@@ -0,0 +1,124 @@
+# HyP3: ASF's On Demand Processing Platform
+
+The Alaska Satellite Facility's Hybrid Pluggable Processing Pipeline, or HyP3 (pronounced *"hype"*), is a cloud-native 
+processing platform developed to efficiently process Synthetic Aperture Radar (SAR) imagery. 
+
+Through HyP3, ASF offers a family of cloud-native, scalable product generation services that 
+make its data holdings more accessible. HyP3 primarily runs compute-heavy workflows, which take tens of minutes to 
+hours of compute time, to create products that are easier to use, GIS-ready, and customized to a user’s needs.
+
+## How it Works
+
+HyP3 was designed to address many common issues for users of SAR data:
+
+* Most SAR datasets require at least some processing to remove distortions before they are analysis-ready
+* SAR processing is computing-intensive
+* Software for SAR processing is complicated to use and/or prohibitively expensive
+* Producing analysis-ready SAR data has a steep learning curve that acts as a barrier to entry
+
+HyP3 solves these problems by providing an interface where users can request SAR processing on demand. These
+processing requests are picked up by automated systems, which handle the complexity of SAR processing on behalf of the
+user. Refer to our [Architecture](how_it_works.md "Jump to Architecture Documentation") page to learn more about the 
+structure of the HyP3 platform.
+
+HyP3 doesn't require users to have a lot of knowledge of SAR processing before getting started; they only need to
+submit the input data and set a few optional parameters if desired. With HyP3, analysis-ready products are just a few
+clicks away.
+
+## The HyP3 Service Family
+
+!!! tip "HyP3+ is now available!"
+
+    !["HyP3+ logo"](images/HyP3+_Logo_Icon_Only.png){ width="100";  style="float: left;" }
+
+    For users who need more processing than the 10,000 credit limit allows, ASF now hosts 
+    [HyP3+](about/hyp3_plus.md "Jump to the HyP3+ Landing Page"), a user-supported 
+    version of HyP3 that allows you to purchase as many credits as you need. 
+
+    [Get to know HyP3+!](news/hyp3_plus_introduction.md "Jump to the HyP3+ Introduction")
+
+Explore HyP3 at no cost using [HyP3 Basic](about/hyp3_basic.md "Jump to HyP3 Basic Documentation"), 
+our NASA-supported On Demand processing service, or purchase credits 
+for use with [HyP3+](about/hyp3_plus.md "Jump to HyP3+ Documentation"), 
+our user-supported service that lets you take your application global. Need help scaling your own, in-house workflows? 
+[Contact us](contact.md)!
+
+<table class="tg">
+  <thead>
+    <tr>
+      <th class="tg-fymr">
+          <a href="https://hyp3-docs.asf.alaska.edu/about/hyp3_basic" title="HyP3 Basic"><b>HyP3 Basic</b></a><br><em>Supported by NASA Earthdata</em>
+      </th>
+      <th class="tg-fymr">
+          <a href="https://hyp3-docs.asf.alaska.edu/about/hyp3_plus" title="HyP3+"><b>HyP3+</b></a><br><em>User-supported Deployment</em>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td class="tg-0pky">
+        <a href="https://hyp3-api.asf.alaska.edu" title="HyP3 API" target="_blank">hyp3-api.asf.alaska.edu</a><br><br>Products expire after 14 days<br><br>Round-robin processing queue<br><br><br>Products distributed via CloudFront
+      </td>
+      <td class="tg-0pky">
+        <a href="https://hyp3-plus.asf.alaska.edu" title="HyP3 Plus API" target="_blank">hyp3-plus.asf.alaska.edu</a><br><br>Products expire after 30 days<br><br>Smaller user-queue with higher throughput.<br>Get your products faster!<br><br>Products provided in a public AWS S3 Bucket<br>
+      </td>
+    </tr>
+    <tr>
+      <td class="tg-0pky">10,000 <a href="/using/credits" title="Jump to Credits Documentation">Credits</a> per month free*</td>
+      <td class="tg-0pky">1 Credit = $0.05</td>
+    </tr>
+  </tbody>
+</table>
+<style>
+  .tg {
+    border-collapse: collapse;
+    border-spacing: 0;
+    width: 100%;
+    margin: 20px 0;
+  }
+  .tg th {
+    background-color: #f0f0f0;
+    border: 1px solid #ccc;
+    color: #333;
+    font-size: 20px;
+    font-weight: bold;
+    padding: 10px 10px;
+    text-align: left;
+    vertical-align: top;
+  }
+  .tg td {
+    border: 1px solid #ccc;
+    font-size: 16px;
+    padding: 10px 10px;
+    text-align: left;
+    vertical-align: top;
+  }
+  .tg-0pky {
+    border-color: inherit;
+    text-align: left;
+    vertical-align: top;
+  }
+  .tg-fymr {
+    background-color: #f0f0f0;
+    border-color: inherit;
+    font-weight: bold;
+    text-align: left;
+    vertical-align: top;
+  }
+</style>
+
+*More available by request, as our budget allows. Send requests to ASF User Services: 
+[uso@asf.alaska.edu](mailto:uso@asf.alaska.edu)
+
+## Getting started
+
+{% include 'using-snippet.md' %}
+
+## What's New
+
+Follow [@ASFHyP3](https://twitter.com/ASFHyP3 "https://twitter.com/ASFHyP3" ){target=_blank} on Twitter, or check our
+[What's New](whats_new.md "HyP3 What's New" ){target=_blank} page to keep up to date on all things HyP3!
+
+## Contact Us
+
+{% include 'contact-snippet.md' %}

docs/about/hyp3_basic.md

@@ -0,0 +1,23 @@
+# HyP3 Basic
+
+ASF released HyP3 to the public in 2020, allowing all users to request On Demand products at no cost. 
+This service, now called HyP3 Basic, is funded by NASA, and hosted in 
+NASA's [Earthdata Cloud (EDC)](https://www.earthdata.nasa.gov/about/earthdata-cloud-evolution "https://www.earthdata.nasa.gov/about/earthdata-cloud-evolution" ){target=_blank}. 
+
+Anyone can use HyP3 Basic. All you need are 
+[Earthdata Login credentials](../using/authentication.md#earthdata-login-edl "Jump to EDL Documentation"). 
+
+Each user receives 10,000 credits each month to use for processing any On Demand products. Different HyP3 job types 
+consume different credit amounts, as defined in the 
+[Credit Cost Table](../using/credits.md#credit-cost-table "Jump to the Credit Cost Table on the Credits Documentation page"). 
+If you need to process more data than is possible with this credit allotment, you can purchase additional credits using 
+[HyP3+](hyp3_plus.md "Jump to HyP3+ Documentation"). 
+
+Output products are distributed via Amazon CloudFront, and are retained for 14 days before being deleted. 
+For users who need more time to download products, consider using [HyP3+](hyp3_plus.md "Jump to HyP3+ Documentation"), 
+which has a 30-day retention period.
+
+If you have questions about credit limits, retention policies, or other HyP3-related issues, please contact us at 
+[uso@asf.alaska.edu](mailto:uso@asf.alaska.edu "uso@asf.alaska.edu").
+
+[Get started with HyP3 Basic!](../about.md#getting-started "Jump to the Getting Started section")