38 lines
2.3 KiB
Plaintext
38 lines
2.3 KiB
Plaintext
---
|
||
title: schedule
|
||
description: API reference for qiskit.compiler.schedule
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.compiler.schedule
|
||
---
|
||
|
||
<span id="qiskit-compiler-schedule" />
|
||
|
||
# qiskit.compiler.schedule
|
||
|
||
<Function id="qiskit.compiler.schedule" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/scheduler.py" signature="schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)">
|
||
Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit").
|
||
|
||
**Parameters**
|
||
|
||
* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") *| List\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")*]*) – The quantum circuit or circuits to translate
|
||
* **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.backend.Backend") *| None*) – A backend instance, which contains hardware-specific data required for scheduling
|
||
* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.instruction_schedule_map.InstructionScheduleMap") *| None*) – Mapping of circuit operations to pulse schedules. If `None`, defaults to the `backend`’s `instruction_schedule_map`
|
||
* **meas\_map** (*List\[List\[int]] | None*) – List of sets of qubits that must be measured together. If `None`, defaults to the `backend`’s `meas_map`
|
||
* **dt** (*float | None*) – The output sample rate of backend control electronics. For scheduled circuits which contain time information, dt is required. If not provided, it will be obtained from the backend configuration
|
||
* **method** (*str | List\[str] | None*) – Optionally specify a particular scheduling method
|
||
|
||
**Returns**
|
||
|
||
A pulse `Schedule` that implements the input circuit
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – If `inst_map` and `meas_map` are not passed and `backend` is not passed
|
||
|
||
**Return type**
|
||
|
||
[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") | *List*\[[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")]
|
||
</Function>
|
||
|