openworld_radio_twin.main#

Functions

batch_index()

batch_manifest(request, job_id)

batch_status(request, job_id)

building_context(request[, latitude, ...])

building_sources(request)

compile_scene_endpoint(request, payload)

Compile a geographic scene into the cache shared with rt.load_scene.

compiled_scene(request, scene_id)

Read a previously compiled scene back from the cache.

engines()

health()

index()

lifespan(app)

list_batches(request)

plan_batch(payload)

search(request[, q])

simulate(request, payload)

simulation_artifacts(request, simulation_id)

simulation_raster(request, simulation_id[, ...])

start_batch(request, payload[, resume])

openworld_radio_twin.main.lifespan(app)[source]#
Return type:

AsyncIterator[None]

async openworld_radio_twin.main.index()[source]#
Return type:

FileResponse

async openworld_radio_twin.main.batch_index()[source]#
Return type:

FileResponse

async openworld_radio_twin.main.health()[source]#
Return type:

dict[str, object]

async openworld_radio_twin.main.engines()[source]#
Return type:

list[dict[str, object]]

async openworld_radio_twin.main.plan_batch(payload)[source]#
Return type:

BatchPlan

async openworld_radio_twin.main.start_batch(request, payload, resume=Query(False))[source]#
Return type:

dict[str, object]

async openworld_radio_twin.main.list_batches(request)[source]#
Return type:

list[dict[str, object]]

async openworld_radio_twin.main.batch_status(request, job_id)[source]#
Return type:

dict[str, object]

async openworld_radio_twin.main.batch_manifest(request, job_id)[source]#
Return type:

FileResponse

async openworld_radio_twin.main.search(request, q=Query(PydanticUndefined))[source]#
Return type:

list[SearchResult]

async openworld_radio_twin.main.building_sources(request)[source]#
Return type:

list[dict[str, object]]

async openworld_radio_twin.main.building_context(request, latitude=Query(PydanticUndefined), longitude=Query(PydanticUndefined), radius_m=Query(750), building_source=Query(auto))[source]#
Return type:

BuildingContextResponse

async openworld_radio_twin.main.compile_scene_endpoint(request, payload)[source]#

Compile a geographic scene into the cache shared with rt.load_scene.

Return type:

SceneResponse

async openworld_radio_twin.main.compiled_scene(request, scene_id)[source]#

Read a previously compiled scene back from the cache.

Return type:

SceneResponse

async openworld_radio_twin.main.simulate(request, payload)[source]#
Return type:

SimulationResponse

async openworld_radio_twin.main.simulation_raster(request, simulation_id, metric=Query(rss), mask_buildings=True, feather_edges=True)[source]#
Return type:

Response

async openworld_radio_twin.main.simulation_artifacts(request, simulation_id)[source]#
Return type:

Response