HyP3 SDK v7.0.2

Changed

• The static-analysis Github Actions workflow now uses ruff rather than flake8 for linting.

HyP3 SDK v7.0.1

Removed

• Removed the unapproved user warning implemented in v6.2.0 (see #276). This feature had unintended consequences which broke some processing pipelines that rely on the HyP3 SDK (see #285 for more details).

HyP3 SDK v7.0.0

Removed

• Support for Python 3.9 has been removed.

HyP3 SDK v6.2.0

Added

• Job.priority attribute
• Unapproved hyp3-sdk users receive an error message when connecting to HyP3

HyP3 SDK v6.1.0

Added

• HyP3.costs method to retrieve the job cost lookup table, following the addition of the /costs API endpoint in HyP3 v6.2.0
• Batch.total_credit_cost method to calculate the total credit cost for a batch of jobs

HyP3 SDK v6.0.0

This release accommodates changes to the HyP3 API schema introduced in HyP3 v6.0.0

Added

• credit_cost attribute to the Job class
• HyP3.check_credits method to determine your remaining processing credits

Changed

• HyP3.my_info(): A new remaining_credits field replaces the quota field in the return value
• HyP3.check_quota may return a float or an integer if the user has processing credits

Deprecated

• HyP3.check_quota has been deprecated in favor of HyP3.check_credits

HyP3 SDK v5.0.0

Removed

• legacy option for the dem_name argument of HyP3.prepare_rtc_job() and HyP3.submit_rtc_job().

HyP3 SDK v4.0.0

Added

• The HyP3 SDK now explicitly supports Python 3.9-3.12
• Added HyP3.submit_insar_isce_burst_job and HyP3.prepare_insar_isce_burst_job methods for submitting
  InSAR ISCE burst jobs to HyP3.
• A pending method to the Job class.
• A pending argument to the Batch.filter_jobs() method.

Changed

• The order of the arguments for Batch.filter_jobs(). The new order is succeeded, pending, running, failed, include_expired.

Removed

• Support for Python 3.8 has been dropped.

Fixed

• The running method of the Job class now only returns True if job has status RUNNING. Jobs in the PENDING state now return True when calling the pending method of Job.

HyP3 SDK v3.1.0

Added

• Added the phase_filter_parameter keyword argument for the HyP3.submit_insar_job and HyP3.prepare_insar_job methods.

HyP3 SDK v3.0.0

Removed

• Removed the Job.subscription_id attribute in response to the Subscriptions feature being removed from HyP3.