sdk.result.download()

elements.sdk.api.result

Get the Downloaded Result(s) of an Algorithm Computation.

Retrieve the Downloaded Result for the specified Algorithm Computations that match the specified filters.

Parameters

  • Same as result.get() minus the include_export_files since that is defaulted to True
  • [Optional]download_dir str - directory to download the merged files to

Returns

Dict[str, Dict[str, List[str]]]: mapping of algorithm_computation_id_to_data_type_to_downloaded_paths

Each downloaded path will be for one observation in the computation.

The path will have the structure {algorithm_computation_id}/{data_type}/{observation_id}

Example(s)

# Download results by Algorithm Computation ID
await sdk.result.download(
  algorithm_computation_ids=["1115760f-5b74-4b53-94aa-4e1b2df7a4ae"]
)

# Dict[str, Dict[str, List[str]]]: mapping of algorithm_computation_id_to_data_type_to_downloaded_paths
{
  'gnss_clusters': [
    '/1115760f-5b74-4b53-94aa-4e1b2df7a4ae/gnss_clusters/f59a801c-7bfc-44bc-807a-56750c2fe673/results.zip', 
    '/1115760f-5b74-4b53-94aa-4e1b2df7a4ae/gnss_clusters/32b198cb-38cf-4a51-95e2-ebc5db46b872/results.zip'
  ]
}