sdk.analysis_computation.create()

elements.sdk.api.analysis_computation

Create an Analysis Computation.

Create the runnable component in the system, by specifying the Analysis Config to be run, the set of AOIs to be run on, and the TOI to specify the recurrence. The Analysis Computation ID is returned so that it can be run. Note that until an Analysis Computation has been run, its underlying resources are NOT locked and therefore can be changed.

Parameters

  • analysis_config_id (str) - Analysis Config to use in computation
  • aoi_collection_id (str) - AOI Collection to use in computation
  • toi_id (str) - TOI to use in computation

Returns

AnalysisComputation

Example(s)

# Create an Analysis Computation
await sdk.analysis_computation.create(
  analysis_config_id="ac9f25c2-48ba-48b1-b096-ac3d0ec83c21",
  toi_id="12847bf4-2c77-4468-a1ef-dd67566954e3",
  aoi_collection_id="41e3fb68-fa89-4e20-b4d1-2884ef3cb0ce"
)

# Output (AnalysisComputation)
id: "cf880d7e-8a4d-4c0e-a946-9b8e8a6f225d"
analysis_id: "96b49764-007d-4166-9a5f-600b9bfa9ba6"
toi_id: "12847bf4-2c77-4468-a1ef-dd67566954e3"
aoi_collection_id: "41e3fb68-fa89-4e20-b4d1-2884ef3cb0ce"
analysis_config_id: "ac9f25c2-48ba-48b1-b096-ac3d0ec83c21"
submitted_on {
  seconds: 1667410620
  nanos: 73823000
}
computation_nodes {
  name: "device-visits"
  computation_id: "e60657cf-aa8d-4086-98c0-a1f2538f85be"
  children: "device-tracks"
}
computation_nodes {
  name: "device-tracks"
  computation_id: "027f2a18-3478-478e-8533-ef947492f809"
}