HyP3 SDK
A python wrapper around the HyP3 API
>>> from hyp3_sdk import HyP3
>>> hyp3 = HyP3(prompt='password')
>>> granule = 'S1A_IW_SLC__1SSV_20150621T120220_20150621T120232_006471_008934_72D8'
>>> job = hyp3.submit_rtc_job(granule=granule, name='MyNewJob')
>>> job = hyp3.watch(job)
>>> job.download_files()
Install
In order to easily manage dependencies, we recommend using dedicated project environments via Anaconda/Miniconda or Python virtual environments.
The HyP3 SDK can be installed into a conda environment with
conda install -c conda-forge hyp3_sdk
or into a virtual environment with
python -m pip install hyp3_sdk
Quick Usage
There are 3 main classes that the SDK exposes:
HyP3to perform HyP3 operations (find jobs, refresh job information, submitting new jobs)Jobto perform operations on single jobs (downloading products, check status)Batchto perform operations on multiple jobs at once (downloading products, check status)
An instance of the HyP3 class will be needed to interact with the external HyP3 API.
>>> from hyp3_sdk import HyP3
>>> hyp3 = HyP3(username='MyUsername', password='MyPassword')
>>> granule = 'S1A_IW_SLC__1SSV_20150621T120220_20150621T120232_006471_008934_72D8'
>>> job = hyp3.submit_rtc_job(granule=granule, name='MyNewJob')
>>> job = hyp3.watch(job)
>>> job.download_files()
Connect to the HyP3 API
Create a connection to the HyP3 API using the HyP3 class:
import hyp3_sdk as sdk
hyp3 = sdk.HyP3()
This connects to the HyP3 Basic deployment by default. To connect to an
alternate deployment such as HyP3+, specify the corresponding api_url:
hyp3_plus = sdk.HyP3(api_url='https://hyp3-plus.asf.alaska.edu')
Submitting Jobs
hyp3 has member functions for submitting new jobs:
rtc_job = hyp3.submit_rtc_job('granule_id', 'job_name')
insar_job = hyp3.submit_insar_job('reference_granule_id', 'secondary_granule_id', 'job_name')
insar_burst_job = hyp3.submit_insar_isce_burst_job('reference_granule_id', 'secondary_granule_id', 'job_name')
insar_multi_burst_job = hyp3.submit_insar_isce_multi_burst_job(['ref_id_1', 'ref_id_2'], ['sec_id_1', 'sec_id_2'], 'job_name')
autorift_job = hyp3.submit_autorift_job('reference_granule_id', 'secondary_granule_id', 'job_name')
aria_s1_gunw_job = hyp3.submit_aria_s1_gunw_job('ref_date', 'sec_date', 'frame_id', 'job_name')
opera_rtc_s1_job = hyp3.submit_opera_rtc_s1_job('granule_id')
Each of these functions will return an instance of the Job class that represents a new HyP3 job request.
Finding Existing Jobs
To find HyP3 jobs that were run previously, you can use the hyp3.find_jobs()
batch = hyp3.find_jobs()
This will return a Batch instance representing all jobs owned by you. You can also pass parameters to
query to a specific set of jobs
Operations on Job and Batch
If your jobs are not complete you can use the HyP3 instance to update them, and wait from completion
batch = hyp3.find_jobs()
if not batch.complete():
# to get updated information
batch = hyp3.refresh(batch)
# or to wait until completion and get updated information (which will take a fair bit)
batch = hyp3.watch(batch)
Once you have complete jobs you can download the products to your machine
batch.download_files()
These operations also work on Job objects
job = hyp3.submit_rtc_job('S1A_IW_SLC__1SSV_20150621T120220_20150621T120232_006471_008934_72D8', 'MyJobName')
job = hyp3.watch(job)
job.download_files()
Documentation
For the full SDK API Reference, see the HyP3 documentation
Contact Us
Want to talk about the HyP3 SDK? We would love to hear from you!
Found a bug? Want to request a feature? Open an issue
General questions? Suggestions? Or just want to talk to the team? Chat with us on Gitter
2 maintainers
Metadata
2 maintainers
Release files for hyp3-sdk 7.7.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hyp3_sdk-7.7.8.tar.gz | 44.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hyp3_sdk-7.7.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 60.3 kB
Release files / hyp3_sdk-7.7.8.tar.gz
| Download URL | hyp3_sdk-7.7.8.tar.gz |
|---|---|
| Size | 44.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ccf7f9f9123a12797e7b2f5c1393f97589b0f308f2f5c2845d2adcb2ad9b663c
|
|
BLAKE2b-256 checksum How to use checksums |
4a41066851ec4f4d6fa72611983d30dc7b528d7382642ee215690acda5a54b6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / hyp3_sdk-7.7.8-py3-none-any.whl
| Download URL | hyp3_sdk-7.7.8-py3-none-any.whl |
|---|---|
| Size | 16.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
697c24aa15d089850237abfea40f80fa54b00ef9f851d72813ca1804f235b42e
|
|
BLAKE2b-256 checksum How to use checksums |
1f11a4fcb9f59c2a334d7ad4055c42cec44921e88f7aa912f736dc74887fb6bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
