get_results¶

caliber.get_results(workload: int = -1, project_id: str | None = None, model_name: str | None = None) → Dict | None[source]¶

Get results that are stored after running a workflow.

Note that this requires that either a local or a remote workflow queue was used while running the workflow.

Parameters:

workload (int) – The index of the workload in the workflow queue. Defaults to the latest, i.e. workload = -1.
project_id (Optional[str]) – The ID of the project to use for data exchange.
model_name (Optional[str]) – The name of the Speckle model to get results from.

Returns:

The returns from the workflow.

Return type:

results (dict)