HyP3 SDK v7.7.6

Changed

• The implementation of HyP3.update_jobs has been refactored to use the new PATCH /jobs endpoint that was added with HyP3 v10.12.0, resulting in a significant performance improvement when renaming large batches of jobs.
• HyP3.update_jobs now requires the name parameter and no longer accepts arbitrary keyword arguments.

Warning

If one of your jobs fails to update for any reason, HyP3.update_jobs will raise an exception and all of the jobs that were updated before the failure will have the new name, while all of the remaining jobs will be left with the old name. Additionally, because HyP3.update_jobs returns a new copy of your updated jobs rather than updating them in-place, you will need to manually refresh your local copy of the jobs if you want to see which jobs were successfully updated. You can refresh your jobs with the HyP3.refresh method, e.g:

>>> jobs = hyp3.refresh(jobs)

Fixed

• Batch is now a subclass of collections.abc.Sequence, which allows hyp3_sdk.util.chunk to accept a Batch object without triggering warnings from static type checkers such as mypy.

HyP3 SDK v7.7.5

Changed

• hyp3_sdk.HyP3() now authenticates via cumulus.asf.alaska.edu, rather than auth.asf.alaska.edu.

HyP3 SDK v7.7.4

Added

• Added Connect to the HyP3 API section to the README

HyP3 SDK v7.7.3

Added

• Add alias for hyp3-plus API URL.

HyP3 SDK v7.7.2

Fixed

• HyP3.__init__ no longer attempts to update the domain of the asf-urs cookie for non-.asf.alaska.edu API URLs when the token parameter is given. Fixes #369

HyP3 SDK v7.7.1

Changed

• SDK example notebook now references the HyP3 authentication notebook in the authentication section.
• The hyp3-docs authentication documentation page is linked in the HyP3 authentication notebook.

HyP3 SDK v7.7.0

Added

• Added support for using an Earthdata Login Bearer Token when authenticating the HyP3 object.

HyP3 SDK v7.6.0

Changed

• ARIA-S1-GUNW jobs now uses reference_date and secondary_date as input instead of a list of granules

HyP3 SDK v7.5.0

Added

• Added support for specifying a HyP3 API URL with a non-.asf.alaska.edu domain name. This is accomplished by updating the domain of the asf-urs cookie when creating the HyP3 object.
• Added support for specifying a HyP3 API URL that includes a path after the domain name. All API endpoints will be relative to the given path. For example, specifying https://foo.example.com/api results in the /user endpoint being relative to /api, i.e. https://foo.example.com/api/user.

HyP3 SDK v7.4.0

Added

• Added HyP3.submit_opera_rtc_s1_job and HyP3.prepare_opera_rtc_s1_job methods for submitting OPERA RTC-S1 jobs to HyP3. This job type is under development and is currently only available in https://hyp3-test-api.asf.alaska.edu
• Added hyp3_sdk.exceptions.ServiceUnavailableError for handling 503 errors from HyP3.