dandeliion.client.Simulator

class dandeliion.client.Simulator(api_url: str, api_key: str)[source]

Simulator class that stores authentication details and deals with job submission and result acquisition

api_url

URL to server’s API interface

Type:

str

api_key

API key to access server

Type:

str

__init__(api_url: str, api_key: str) None

Methods

__init__(api_url, api_key)

get_log(prefetched_data)

Returns log file

get_status(prefetched_data)

Returns current status of a simulation (as either stored in prefetched_data if finished/failed or retrieved from server if potentially still queued/running)

restore(filepath[, api_key, api_url])

Loads prefetched/solution data and creates new solution object.

submit(parameters[, is_blocking])

Submit parameters to Simulator instance and returns Solution instance

update_results(prefetched_data[, keys, inline])

Function to (pre)fetch result columns from server and update/append prefetched_data

Attributes

api_url

api_key