hyp3-sdk 0.2.0

A python wrapper around the HyP3 API

HyP3 SDK

A python wrapper around the HyP3 API

Usage

The HyP3 object

Interactions with the Hyp3 api are done using an instance of the HyP3 class.

from hyp3_sdk import HyP3

api = HyP3()  # Must have credentials for urs.earthdata.nasa.gov in a .netrc file for this to work

If you want to use an api other then the one at https://hyp3-api.asf.alaska.edu, then provide the URL (including scheme) as a parameter.

from hyp3_sdk import HyP3

api = HyP3('https://hyp3.example.com')

If you want to pass in a requests Session object for the API to use, first it must be authenticated, and can be passed into the api.

from hyp3_sdk import HyP3

session = ...

api = HyP3(authenticated_session=session)

Getting jobs

The get_jobs method with request all jobs from the api and return them in a list of dictionaries.

from hyp3_sdk import HyP3

api = HyP3()

jobs = api.get_jobs()

Parmaeters:

• start: datetime -> requests only jobs submitted after given datetime
• end: datetime -> requests only jobs submitted before given datetime
• status: str -> request based on status (SUCCEEDED, FAILED, RUNNING, PENDING)
• name: str -> requests only jobs that have this name

Submitting jobs

The submit_jobs method will submit jobs to the api for processing

from hyp3_sdk import HyP3, make_rtc_gamma_job()

api = HyP3()

jobs = [make_rtc_gamma_job('job_name', 'granule_name')]

api.submit_jobs(jobs)

Parameters

• jobs: list[Job] -> list of job objects to submit to api

The Job object

Job objects represent a job to be submitted to the API, they are made by calling factory functions

Job factories

• make_rtc_gamma_job

  Parameters

  • job_name: str -> name of job
  • granule: str -> name of granule to process
  • extra_parameters: dict -> extra parameters and processing options
• `make_insar_gamma_job

  Parameters

  • job_name: str -> name of job
  • granule1: str -> name of primary granule to process
  • granule2: str -> name of secondary granule to process
  • extra_parameters: dict -> extra parameters and processing options
• `make_autorift_job

  Parameters

  • job_name: str -> name of job
  • granule1: str -> name of primary granule to process
  • granule2: str -> name of secondary granule to process
  • extra_parameters: dict -> extra parameters and processing options