Simulator API¶

qm.simulate.interface.SimulationConfig ¶

SimulationConfig(
    duration: int = 0,
    include_analog_waveforms: bool = False,
    include_digital_waveforms: bool = False,
    simulation_interface: Optional[
        SimulationInterfaceTypes
    ] = None,
    controller_connections: Optional[
        List[ControllerConnection]
    ] = None,
    extraProcessingTimeoutInMs: int = -1,
)

Creates a configuration object to pass to qm.quantum_machines_manager.QuantumMachinesManager.simulate

PARAMETER	DESCRIPTION
`duration`	The duration to run the simulation for, in clock cycles TYPE: `int` DEFAULT: `0`
`include_analog_waveforms`	True to collect simulated analog waveform names TYPE: `bool` DEFAULT: `False`
`include_digital_waveforms`	True to collect simulated digital waveform names TYPE: `bool` DEFAULT: `False`
`simulation_interface`	Interface for to simulator. Currently supported interfaces - `None` - Zero inputs - qm.simulate.loopback.LoopbackInterface - Loopback output to input - qm.simulate.raw.RawInterface - Specify samples for inputs TYPE: `SimulatorInterface` DEFAULT: `None`
`controller_connections`	A list of connections between the controllers in the config TYPE: `List[ControllerConnection]` DEFAULT: `None`
`extraProcessingTimeoutInMs`	timeout in ms to wait for stream processing to finish. Default is -1, which is disables the timeout TYPE: `int` DEFAULT: `-1`

qm.simulate.loopback.LoopbackInterface ¶

LoopbackInterface(
    connections: List[SupportedConnectionTypes],
    latency: int = 24,
    noisePower: float = 0.0,
)

Creates a loopback interface for use in qm.simulate.interface.SimulationConfig. A loopback connects the output of the OPX into it's input. This can be defined directly using the ports or through the elements.

PARAMETER	DESCRIPTION
`connections`	List of tuples with loopback connections. Each tuple should represent physical connection between ports: ``(from_controller: str, from_port: int, to_controller: str, to_port: int)`` TYPE: `list`
`latency`	The latency between the OPX outputs and its input. TYPE: `int` DEFAULT: `24`
`noisePower`	How much noise to add to the input. ``(fromController: str, fromFEM: int, fromPort: int, toController: str, toFEM: int, toPort: int)`` Virtual connection between elements: `(fromElement: str, toElement: str, toElementInput: int)` TYPE: `float` DEFAULT: `0.0`
`latency`	The latency between the OPX outputs and its input. TYPE: `int` DEFAULT: `24`
`noisePower`	How much noise to add to the input. TYPE: `float` DEFAULT: `0.0`

Example

job = qmm.simulate(config, prog, SimulationConfig(
duration=20000,
# loopback from output 1 to input 2 of controller 1:
simulation_interface=LoopbackInterface([("con1", 1, "con1", 2)])

qm.simulate.raw.RawInterface ¶

RawInterface(
    connections: List[SupportedConnectionTypes],
    noisePower: float = 0.0,
)

Creates a raw interface for use in qm.simulate.interface.SimulationConfig. A raw interface defines samples that will be inputted into the OPX inputs.

PARAMETER	DESCRIPTION
`connections`	List of tuples with the connection. Each tuple should be: ``(toController: str, toFEM: int, toPort: int, toSamples: List[float])`` TYPE: `list`
`noisePower`	How much noise to add to the input. TYPE: `float` DEFAULT: `0.0`

Example

job = qmm.simulate(config, prog, SimulationConfig(
                  duration=20000,
                  # 500 ns of DC 0.2 V into con1 input 1
                  simulation_interface=RawInterface([("con1", 1, [0.2]*500)])

qm.results.simulator_samples.SimulatorControllerSamples ¶

SimulatorControllerSamples(
    analog: Mapping[str, Sequence[Union[float, complex]]],
    digital: Mapping[str, Sequence[bool]],
    analog_sampling_rate: Optional[
        Mapping[str, float]
    ] = None,
)

plot ¶

plot(
    analog_ports: Optional[
        Union[str, int, List[Union[str, int]]]
    ] = None,
    digital_ports: Optional[
        Union[str, int, List[Union[str, int]]]
    ] = None,
) -> None

Plots the simulated output of the OPX in the given ports. If no ports are given, all active ports are plotted.

PARAMETER	DESCRIPTION
`analog_ports`	Union[None, str, list[str]] TYPE: `Optional[Union[str, int, List[Union[str, int]]]]` DEFAULT: `None`
`digital_ports`	Union[None, str, list[str]] TYPE: `Optional[Union[str, int, List[Union[str, int]]]]` DEFAULT: `None`

Cloud Simulator API¶

qm_saas.client ¶

ClusterConfig ¶

ClusterConfig()

A configuration of the cluster and its controllers.

controllers `property` ¶

controllers: dict

Get the controllers' configuration.

RETURNS	DESCRIPTION
`dict`	A dictionary of the controllers and their configuration.

controller ¶

controller() -> ControllerConfig

Add a controller to the cluster configuration.

RETURNS	DESCRIPTION
`ControllerConfig`	The controller configuration.

to_dict ¶

to_dict() -> dict

Convert the cluster configuration to a dictionary.

RETURNS	DESCRIPTION
`dict`	A dictionary of the cluster controllers and their FEM.

ControllerConfig ¶

ControllerConfig()

A configuration of a controller and its FEMs in the cluster.

slots `property` ¶

slots: dict

Get the slots' FEM configuration.

RETURNS	DESCRIPTION
`dict`	A dictionary of the slots and their FEM types.

lf_fems ¶

lf_fems(*slots: int)

Add LF FEMs to numbered slots in the cluster configuration.

PARAMETER	DESCRIPTION
`*slots`	The slots for the LF FEMs. TYPE: `int` DEFAULT: `()`

mw_fems ¶

mw_fems(*slots: int)

Add MW FEMs to numbered slots in the cluster configuration.

PARAMETER	DESCRIPTION
`*slots`	The slots for the MW FEMs. TYPE: `int` DEFAULT: `()`

FemType ¶

An enum containing the available Front-End Module (FEM) types.

QOPVersion ¶

QOPVersion(name: str)

Represents a Quantum Orchestration Platform (QOP) version.

PARAMETER	DESCRIPTION
`name`	The name of the version. TYPE: `str`

ATTRIBUTE	DESCRIPTION
`name`	The name of the version. TYPE: `str`
`major`	The major version number. TYPE: `int`
`minor`	The minor version number. TYPE: `int`
`patch`	The patch version number. TYPE: `int`

Initialize a QmSaasInstanceVersion instance.

PARAMETER	DESCRIPTION
`name`	The name of the version in the format 'vX_Y_Z'. TYPE: `str`

major `property` ¶

major: int

Get the major version number.

RETURNS	DESCRIPTION
`int`	The major version number.

minor `property` ¶

minor: int

Get the minor version number.

RETURNS	DESCRIPTION
`int`	The minor version number.

name `property` ¶

name: str

Get the name of the version.

RETURNS	DESCRIPTION
`str`	The name of the version.

patch `property` ¶

patch: int

Get the patch version number.

RETURNS	DESCRIPTION
`int`	The patch version number.

QmSaas ¶

QmSaas(
    host: str = "qm-saas.quantum-machines.co",
    port: int = 443,
    email: str = None,
    password: str = None,
    auto_cleanup: bool = True,
    log: Logger = None,
)

A simulator client for QmSaas - The Quantum Orchestration Platform (QoP) on the cloud.

Create a QmSaas client.

PARAMETER	DESCRIPTION
`host`	The host of the endpoint of the cloud platform api TYPE: `str` DEFAULT: `'qm-saas.quantum-machines.co'`
`port`	The port of the endpoint of the cloud platform api TYPE: `int` DEFAULT: `443`
`email`	The user's email TYPE: `str` DEFAULT: `None`
`password`	The user's password TYPE: `str` DEFAULT: `None`
`auto_cleanup`	If true (default), automatically delete the simulator instance when the context manager exits otherwise it will be left running until it timeouts or is manually closed. TYPE: `bool` DEFAULT: `True`
`log`	The logger to use for logging messages. If not provided, a default logger will be used. TYPE: `Logger` DEFAULT: `None`

host `property` ¶

host: str

Get the host of the endpoint of the cloud platform api

RETURNS	DESCRIPTION
`str`	The host of the endpoint of the cloud platform api

port `property` ¶

port: int

Get the port of the endpoint of the cloud platform api

RETURNS	DESCRIPTION
`int`	The port of the endpoint of the cloud platform api

close_all ¶

close_all()

Close all the simulator instances created by this client

latest_version ¶

latest_version() -> QOPVersion

Get latest available QoP version.

RETURNS	DESCRIPTION
`QOPVersion`	Latest QoP version.

simulator ¶

simulator(
    version: any = None,
    cluster_config: ClusterConfig = None,
) -> QmSaasInstance

Create a simulator instance on the cloud platform.

PARAMETER	DESCRIPTION
`version`	The QOP version to use for the simulator instance. Defaults to the latest version TYPE: `any` DEFAULT: `None`
`cluster_config`	The cluster configuration for the simulator instance for QoP v3.x.x TYPE: `ClusterConfig` DEFAULT: `None`

versions ¶

versions() -> list[QOPVersion]

Get the available QoP versions.

RETURNS	DESCRIPTION
`list[QOPVersion]`	List of available QoP versions.

QmSaasInstance ¶

QmSaasInstance(
    client: Client,
    version: any,
    cluster_config: ClusterConfig = None,
    auto_cleanup: bool = True,
    log: Logger = None,
)

A simulator instance on the cloud platform.

Create a simulator instance on the cloud platform.

PARAMETER	DESCRIPTION
`client`	The client to use for the simulator instance TYPE: `Client`
`version`	The version to use for the simulator instance TYPE: `QoPVersion \| QOPVersion \| str`
`cluster_config`	The cluster configuration for the simulator instance for QoP v3.x.x TYPE: `ClusterConfig` DEFAULT: `None`
`auto_cleanup`	If true (default), automatically delete the simulator instance when the context manager exits otherwise it will be left running until it timeouts or is manually closed. TYPE: `bool` DEFAULT: `True`
`log`	The logger to use for logging messages. If not provided, a default logger will be used. TYPE: `Logger` DEFAULT: `None`

cluster_config `property` ¶

cluster_config: dict

Get the cluster configuration.

RETURNS	DESCRIPTION
`dict`	The cluster configuration.

expires_at `property` ¶

expires_at: datetime

Get the expiration time of the simulator instance.

RETURNS	DESCRIPTION
`datetime`	The expiration time of the simulator instance.

host `property` ¶

host: str

Get the host of the simulator instance.

RETURNS	DESCRIPTION
`str`	The host of the simulator instance.

id `property` ¶

id: str

Get the ID of the simulator instance.

RETURNS	DESCRIPTION
`str`	The ID of the simulator instance.

is_alive `property` ¶

is_alive: bool

Check if the simulator instance is alive.

RETURNS	DESCRIPTION
`bool`	True if the simulator instance is alive, False otherwise.

is_spawned `property` ¶

is_spawned: bool

Check if the simulator instance is spawned.

RETURNS	DESCRIPTION
`bool`	True if the simulator instance is spawned, False otherwise.

port `property` ¶

port: int

Get the port of the host of the simulator instance.

RETURNS	DESCRIPTION
`int`	port of the host of the simulator instance.

token `property` ¶

token: str

Get the token of the simulator instance.

RETURNS	DESCRIPTION
`str`	The token of the simulator instance.

close ¶

close()

Closes the remote simulator and the session. This operation is idempotent and can be called multiple times.

spawn ¶

spawn()

Spawns the simulator instance on the QmSaaS platform. This is a blocking operation.

The simulator is spawned only once, subsequent calls to this method will not spawn a new simulator, unless the current one is closed.

QoPVersion ¶

QoPVersion(_: str)

An enum containing the available Quantum Orchestration Platform (QoP) versions.

Simulator API¶

qm.simulate.interface.SimulationConfig ¶

qm.simulate.loopback.LoopbackInterface ¶

qm.simulate.raw.RawInterface ¶

qm.results.simulator_samples.SimulatorControllerSamples ¶

plot ¶

Cloud Simulator API¶

qm_saas.client ¶

ClusterConfig ¶

controllers property ¶

controller ¶

to_dict ¶

ControllerConfig ¶

slots property ¶

lf_fems ¶

mw_fems ¶

FemType ¶

QOPVersion ¶

major property ¶

minor property ¶

name property ¶

patch property ¶

QmSaas ¶

host property ¶

port property ¶

close_all ¶

latest_version ¶

simulator ¶

versions ¶

QmSaasInstance ¶

cluster_config property ¶

expires_at property ¶

host property ¶

id property ¶

is_alive property ¶

is_spawned property ¶

port property ¶

token property ¶

close ¶

spawn ¶

QoPVersion ¶

controllers `property` ¶

slots `property` ¶

major `property` ¶

minor `property` ¶

name `property` ¶

patch `property` ¶

host `property` ¶

port `property` ¶

cluster_config `property` ¶

expires_at `property` ¶

host `property` ¶

id `property` ¶

is_alive `property` ¶

is_spawned `property` ¶

port `property` ¶

token `property` ¶