T1#

class T1(physical_qubits, delays, backend=None)[source]#

An experiment to measure the qubit relaxation time.

Overview

This experiment estimates the \(T_1\) relaxation time of the qubit by generating a series of circuits that excite the qubit then wait for different intervals before measurement. The resulting data of excited population versus wait time is fitted to an exponential curve to obtain an estimate for \(T_1\).

User manual

T1 Characterization

Analysis class reference

T1Analysis

Experiment options

These options can be set by the set_experiment_options() method.

Options
  • Defined in the class T1:

    • delays (Iterable[float])

      Default value: None
      Delay times of the experiments in seconds.
  • Defined in the class BaseExperiment:

    • max_circuits (Optional[int])

      Default value: None
      The maximum number of circuits per job when running an experiment on a backend.

Initialization

Initialize the T1 experiment class.

Parameters:
  • physical_qubits (Sequence[int]) – a single-element sequence containing the qubit whose T1 is to be estimated.

  • delays (List[float] | array) – Delay times of the experiments in seconds.

  • backend (Backend | None) – Optional, the backend to run the experiment on.

Raises:

ValueError – If the number of delays is smaller than 3

Attributes

analysis#

Return the analysis instance for the experiment

backend#

Return the backend for the experiment

experiment_options#

Return the options for the experiment.

experiment_type#

Return experiment type.

num_qubits#

Return the number of qubits for the experiment.

physical_qubits#

Return the device qubits for the experiment.

run_options#

Return options values for the experiment run() method.

transpile_options#

Return the transpiler options for the run() method.

Methods

circuits()[source]#

Return a list of experiment circuits

Returns:

The experiment circuits

Return type:

List[QuantumCircuit]

config()#

Return the config dataclass for this experiment

Return type:

ExperimentConfig

copy()#

Return a copy of the experiment

Return type:

BaseExperiment

classmethod from_config(config)#

Initialize an experiment from experiment config

Return type:

BaseExperiment

job_info(backend=None)#

Get information about job distribution for the experiment on a specific backend.

Parameters:

backend (Backend) – Optional, the backend for which to get job distribution information. If not specified, the experiment must already have a set backend.

Returns:

A dictionary containing information about job distribution.

  • ”Total number of circuits in the experiment”: Total number of circuits in the experiment.

  • ”Maximum number of circuits per job”: Maximum number of circuits in one job based on backend and experiment settings.

  • ”Total number of jobs”: Number of jobs needed to run this experiment on the currently set backend.

Return type:

dict

Raises:

QiskitError – if backend is not specified.

run(backend=None, analysis='default', timeout=None, **run_options)#

Run an experiment and perform analysis.

Parameters:
  • backend (Backend | None) – Optional, the backend to run the experiment on. This will override any currently set backends for the single execution.

  • analysis (BaseAnalysis | None) – Optional, a custom analysis instance to use for performing analysis. If None analysis will not be run. If "default" the experiments analysis() instance will be used if it contains one.

  • timeout (float | None) – Time to wait for experiment jobs to finish running before cancelling.

  • run_options – backend runtime options used for circuit execution.

Returns:

The experiment data object.

Raises:

QiskitError – If experiment is run with an incompatible existing ExperimentData container.

Return type:

ExperimentData

set_experiment_options(**fields)#

Set the experiment options.

Parameters:

fields – The fields to update the options

Raises:

AttributeError – If the field passed in is not a supported options

set_run_options(**fields)#

Set options values for the experiment run() method.

Parameters:

fields – The fields to update the options

See also

The Setting options for your experiment guide for code example.

set_transpile_options(**fields)#

Set the transpiler options for run() method.

Parameters:

fields – The fields to update the options

Raises:

QiskitError – If initial_layout is one of the fields.

See also

The Setting options for your experiment guide for code example.