openprotein.fold.FoldComplexResultFuture#

class openprotein.fold.FoldComplexResultFuture(session, job=None, metadata=None, model_id=None, proteins=None, ligands=None, dnas=None, rnas=None)[source]#

Future for manipulating results of a fold complex request.

Parameters:
  • session (APISession)

  • job (FoldJob)

  • metadata (FoldMetadata | None)

  • model_id (str | None)

  • proteins (list[Protein] | None)

  • ligands (list[Ligand] | None)

  • dnas (list[DNA] | None)

  • rnas (list[RNA] | None)

job#

The fold job associated with this future.

Type:

FoldJob

__init__(session, job=None, metadata=None, model_id=None, proteins=None, ligands=None, dnas=None, rnas=None)[source]#

Initialize a FoldComplexResultFuture instance.

Parameters:
  • session (APISession) – The API session to use for requests.

  • job (FoldJob) – The fold job associated with this future.

  • model_id (str, optional) – Model ID used for the fold request.

  • proteins (list[Protein], optional) – List of proteins submitted for fold request.

  • ligands (list[Ligand], optional) – List of ligands submitted for fold request.

  • dnas (list[DNA], optional) – List of DNAs submitted for fold request.

  • rnas (list[RNA], optional) – List of RNAs submitted for fold request.

  • metadata (FoldMetadata | None)

Methods

__init__(session[, job, metadata, model_id, ...])

Initialize a FoldComplexResultFuture instance.

cancelled()

Check if the job has been cancelled.

create(session[, job_id, job, response])

Create an instance of the appropriate Future class based on the job type.

done()

Check if the job has completed.

get([format, verbose])

Retrieve the fold results as a single bytestring.

refresh()

Refresh the job status and internal job object.

wait([interval, timeout, verbose])

Wait for the job to complete, then fetch results.

wait_until_done([interval, timeout, verbose])

Wait for the job to complete.

Attributes

affinity

Retrieve the predicted binding affinities.

confidence

Retrieve the confidences of the structure prediction.

created_date

The creation timestamp of the job.

dnas

Get the DNAs submitted for the fold request.

end_date

The end timestamp of the job.

id

Get the ID of the fold request.

job_id

The unique identifier of the job.

job_type

The type of the job.

ligands

Get the ligands submitted for the fold request.

metadata

The fold metadata.

metrics

Get the predicted metrics.

model_id

Get the model ID used for the fold request.

pae

Get the Predicted Aligned Error (PAE) matrix.

pde

Get the Predicted Distance Error (PDE) matrix.

plddt

Get the Predicted Local Distance Difference Test (pLDDT) scores.

progress_counter

The progress counter of the job.

proteins

Get the proteins submitted for the fold request.

rnas

Get the RNAs submitted for the fold request.

score

Get the predicted scores.

start_date

The start timestamp of the job.

status

The current status of the job.

job

session