magnet_square

MagnetSquare - Magnetization Square on Specific Direction (qurry.qurries.magnet_square)

Formerly known as qurmagsq

arguments

MagnetSquare - Arguments (qurry.qurries.magnet_square.arguments)

class qurry.qurries.magnet_square.arguments.MagnetSquareAnalyzeArgs[source]

The input of the analyze method.

class qurry.qurries.magnet_square.arguments.MagnetSquareArguments(exp_name: str = 'exps', num_qubits: int = 0, unitary_operator: Operator | Gate | Literal['x', 'y', 'z'] = 'z')[source]

Arguments for the experiment.

exp_name: str = 'exps'

The name of the experiment. Naming this experiment to recognize it when the jobs are pending to IBMQ Service. This name is also used for creating a folder to store the exports. Defaults to ‘experiment’.

num_qubits: int = 0

The number of qubits.

unitary_operator: Operator | Gate | Literal['x', 'y', 'z'] = 'z'

The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’). Defaults to ‘z’.

class qurry.qurries.magnet_square.arguments.MagnetSquareMeasureArgs[source]

Output arguments for output().

unitary_operator: Operator | Gate | Literal['x', 'y', 'z']

The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’). Defaults to ‘z’.

wave: QuantumCircuit | Hashable | None

The key or the circuit to execute.

class qurry.qurries.magnet_square.arguments.MagnetSquareOutputArgs[source]

Output arguments for output().

unitary_operator: Operator | Gate | Literal['x', 'y', 'z']

The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’). Defaults to ‘z’.

analysis

MagnetSquare - Analysis (qurry.qurries.magnet_square.analysis)

class qurry.qurries.magnet_square.analysis.MSAnalysisContent(magnet_square: float | float64, num_qubits: int, shots: int, unitary_operator: str | ndarray[tuple[int, ...], dtype[float64]] | ndarray[tuple[int, ...], dtype[complex128]], magnet_square_cells: dict[int, float64], taking_time: float | None = None)[source]

The content of the analysis.

magnet_square: float | float64

Magnetic Square.

magnet_square_cells: dict[int, float64]

Magnetic Square cells.

num_qubits: int

The number of qubits.

shots: int

The number of shots.

taking_time: float | None

Taking time.

unitary_operator: str | ndarray[tuple[int, ...], dtype[float64]] | ndarray[tuple[int, ...], dtype[complex128]]

The numpy array of the unitary operator or a string representing the axis of rotation.

class qurry.qurries.magnet_square.analysis.MSAnalysisInput[source]

To set the analysis.

class qurry.qurries.magnet_square.analysis.MagnetSquareAnalysis(*, serial: int, log: dict[str, Any] | None = None, datatime: str | None = None, **other_kwargs)[source]

The container for the analysis of :cls:`MagnetSquareExperiment`.

classmethod content_type() → Type[MSAnalysisContent][source]

The content instance type.

classmethod input_type() → Type[MSAnalysisInput][source]

The input instance type.

property side_product_fields: Iterable[str]

The fields that will be stored as side product.

utils

Magnetic Square - Utility (qurry.qurries.magnet_square.utils)

qurry.qurries.magnet_square.utils.circuit_method(idx: int, target_circuit: QuantumCircuit, target_key: str, exp_name: str, unitary_operator: Operator | Gate | Literal['x', 'y', 'z'], i: int, j: int) → QuantumCircuit[source]

Build the circuit for the experiment.

Parameters:

  • idx (int) – Index of the quantum circuit.

  • target_circuit (QuantumCircuit) – Target circuit.

  • target_key (Hashable) – Target key.

  • exp_name (str) – Experiment name.

  • unitary_operator (Union[Operator, Gate, Literal["x", "y", "z"]]) – The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’).

  • i (int) – The index of the target qubit.

  • j (int) – The index of the target qubit.

Returns:

The circuit for the experiment.

Return type:

QuantumCircuit

experiment

MagnetSquare - Experiment (qurry.qurries.magnet_square.experiment)

class qurry.qurries.magnet_square.experiment.MagnetSquareExperiment(arguments: _A | dict[str, Any], commonparams: Commonparams | dict[str, Any], outfields: dict[str, Any], beforewards: Before | None = None, afterwards: After | None = None, reports: AnalysesContainer | None = None)[source]

The instance of experiment.

property analysis_instance: Type[MagnetSquareAnalysis]

The analysis instance for this experiment.

analyze(pbar: tqdm | None = None) → MagnetSquareAnalysis[source]

Calculate magnet square with more information combined.

Parameters:

pbar (Optional[tqdm.tqdm], optional) – The progress bar. Defaults to None.

Returns:

The result of the analysis.

Return type:

MagnetSquareAnalysis

property arguments_instance: Type[MagnetSquareArguments]

The arguments instance for this experiment.

classmethod method(targets: list[tuple[Hashable, QuantumCircuit]], arguments: MagnetSquareArguments, pbar: tqdm | None = None, multiprocess: bool = True) → tuple[list[QuantumCircuit], dict[str, Any]][source]

The method to construct circuit.

Parameters:

  • targets (list[tuple[Hashable, QuantumCircuit]]) – The circuits of the experiment.

  • arguments (MagnetSquareArguments) – The arguments of the experiment.

  • pbar (Optional[tqdm.tqdm], optional) – The progress bar for showing the progress of the experiment. Defaults to None.

  • multiprocess (bool, optional) – Whether to use multiprocessing. Defaults to True.

Returns:

The circuits of the experiment and the side products.

Return type:

tuple[list[QuantumCircuit], dict[str, Any]]

classmethod params_control(targets: list[tuple[Hashable, QuantumCircuit]], exp_name: str = 'exps', unitary_operator: Operator | Gate | Literal['x', 'y', 'z'] = 'z', **custom_kwargs: Any) → tuple[MagnetSquareArguments, Commonparams, dict[str, Any]][source]

Handling all arguments and initializing a single experiment.

Parameters:

  • targets (list[tuple[Hashable, QuantumCircuit]]) – The circuits of the experiment.

  • unitary_operator (Union[Operator, Gate, Literal["x", "y", "z"]]) – The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’).

  • exp_name (str, optional) – The name of the experiment. Naming this experiment to recognize it when the jobs are pending to IBMQ Service. This name is also used for creating a folder to store the exports. Defaults to ‘exps’.

  • custom_kwargs (Any) – The custom parameters.

Returns:

The arguments of the experiment, the common parameters, and the custom parameters.

Return type:

tuple[MagnetSquareArguments, Commonparams, dict[str, Any]]

classmethod quantities(shots: int | None = None, counts: list[dict[str, int]] | None = None, num_qubits: int | None = None, unitary_operator: str | ndarray[tuple[int, ...], dtype[float64]] | ndarray[tuple[int, ...], dtype[complex128]] | None = None, backend: Literal['Cython', 'Rust', 'Python'] | str = 'Rust', pbar: tqdm | None = None) → MagnetSquare[source]

Calculate magnet square with more information combined.

Parameters:

  • shots (int) – The number of shots.

  • counts (list[dict[str, int]]) – The counts of the experiment.

  • num_qubits (int) – The number of qubits.

  • unitary_operator (Union[str, npt.NDArray[np.float64], npt.NDArray[np.complex128]]) – The numpy array of the unitary operator or a string representing the axis of rotation.

  • backend (PostProcessingBackendLabel, optional) – The backend label. Defaults to DEFAULT_PROCESS_BACKEND.

  • pbar (Optional[tqdm.tqdm], optional) – The progress bar. Defaults to None.

Returns:

The result of the magnet square.

Return type:

MagnetSquare

qurry

MagnetSquare - Qurrium (qurry.qurries.magnet_square.qurry)

class qurry.qurries.magnet_square.qurry.MagnetSquare[source]

Magnetization Square Qurry.

property experiment_instance: Type[MagnetSquareExperiment]

The container class responding to this Qurrium class.

measure(wave: QuantumCircuit | Hashable | None = None, unitary_operator: Operator | Gate | Literal['x', 'y', 'z'] | None = None, shots: int = 1024, backend: Backend | None = None, exp_name: str = 'experiment', run_args: BaseRunArgs | dict[str, Any] | None = None, transpile_args: TranspileArgs | None = None, passmanager: str | PassManager | tuple[str, PassManager] | None = None, tags: tuple[str, ...] | None = None, qasm_version: Literal['qasm2', 'qasm3'] = 'qasm3', export: bool = False, save_location: Path | str | None = None, pbar: tqdm | None = None) → str[source]

Execute the experiment.

Parameters:

  • wave (Union[QuantumCircuit, Hashable]) – The key or the circuit to execute.

  • unitary_operator (Union[Operator, Gate, Literal["x", "y", "z"]]) – The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’).

  • shots (int, optional) – Shots of the job. Defaults to 1024.

  • backend (Optional[Backend], optional) – The quantum backend. Defaults to None.

  • exp_name (str, optional) – The name of the experiment. Naming this experiment to recognize it when the jobs are pending to IBMQ Service. This name is also used for creating a folder to store the exports. Defaults to ‘exps’.

  • run_args (RunArgsType, optional) – Arguments for Backend.run(). Defaults to None.

  • transpile_args (Optional[TranspileArgs], optional) – Arguments of transpile() from qiskit.compiler.transpiler. Defaults to None.

  • passmanager (Optional[Union[str, PassManager, tuple[str, PassManager]], optional) – The passmanager. Defaults to None.

  • tags (Optional[tuple[str, ...]], optional) – The tags of the experiment. Defaults to None.

  • qasm_version (Literal["qasm2", "qasm3"], optional) – The version of OpenQASM. Defaults to “qasm3”.

  • export (bool, optional) – Whether to export the experiment. Defaults to False.

  • save_location (Optional[Union[Path, str]], optional) – The location to save the experiment. Defaults to None.

  • pbar (Optional[tqdm.tqdm], optional) – The progress bar for showing the progress of the experiment. Defaults to None.

Returns:

The ID of the experiment

Return type:

str

measure_to_output(wave: QuantumCircuit | Hashable | None = None, unitary_operator: Operator | Gate | Literal['x', 'y', 'z'] | None = None, shots: int = 1024, backend: Backend | None = None, exp_name: str = 'experiment', run_args: BaseRunArgs | dict[str, Any] | None = None, transpile_args: TranspileArgs | None = None, passmanager: str | PassManager | tuple[str, PassManager] | None = None, tags: tuple[str, ...] | None = None, qasm_version: Literal['qasm2', 'qasm3'] = 'qasm3', export: bool = False, save_location: Path | str | None = None, pbar: tqdm | None = None) → MagnetSquareOutputArgs[source]

Trasnform measure() arguments form into output() form.

Parameters:

  • wave (Union[QuantumCircuit, Hashable]) – The key or the circuit to execute.

  • unitary_operator (Union[Operator, Gate, Literal["x", "y", "z"]]) – The unitary operator to apply. It can be a qiskit.quantum_info.Operator, a qiskit.circuit.Gate, or a string representing the axis of rotation (‘x’, ‘y’, or ‘z’).

  • shots (int, optional) – Shots of the job. Defaults to 1024.

  • backend (Optional[Backend], optional) – The quantum backend. Defaults to None.

  • exp_name (str, optional) – The name of the experiment. Naming this experiment to recognize it when the jobs are pending to IBMQ Service. This name is also used for creating a folder to store the exports. Defaults to ‘exps’.

  • run_args (RunArgsType, optional) – Arguments for Backend.run(). Defaults to None.

  • transpile_args (Optional[TranspileArgs], optional) – Arguments of transpile() from qiskit.compiler.transpiler. Defaults to None.

  • passmanager (Optional[Union[str, PassManager, tuple[str, PassManager]], optional) – The passmanager. Defaults to None.

  • tags (Optional[tuple[str, ...]], optional) – The tags of the experiment. Defaults to None.

  • qasm_version (Literal["qasm2", "qasm3"], optional) – The version of OpenQASM. Defaults to “qasm3”.

  • export (bool, optional) – Whether to export the experiment. Defaults to False.

  • save_location (Optional[Union[Path, str]], optional) – The location to save the experiment. Defaults to None.

  • pbar (Optional[tqdm.tqdm], optional) – The progress bar for showing the progress of the experiment. Defaults to None.

Returns:

The output arguments.

Return type:

MagnetSquareOutputArgs

short_name = 'qurmagsq_magnet_square'

The short name of Qurrium.