---
title: quimb (latest version)
description: API reference for qiskit_addon_aqc_tensor.simulation.quimb in the latest version of qiskit-addon-aqc-tensor
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit-addon-aqc-tensor/simulation-quimb
---

# Quimb simulation backend

`qiskit_addon_aqc_tensor.simulation.quimb`

Quimb as a tensor network backend.

|                                                                                                                                                                                              |                                                                                                |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [`QuimbCircuitFactory`](/docs/api/qiskit-addon-aqc-tensor/simulation-quimb-quimb-circuit-factory "qiskit_addon_aqc_tensor.simulation.quimb.QuimbCircuitFactory")                             | Quimb circuit factory.                                                                         |
| [`QuimbSimulator`](/docs/api/qiskit-addon-aqc-tensor/simulation-quimb-quimb-simulator "qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator")                                             | Settings for Quimb simulator.                                                                  |
| [`QiskitQuimbConversionContext`](/docs/api/qiskit-addon-aqc-tensor/simulation-quimb-qiskit-quimb-conversion-context "qiskit_addon_aqc_tensor.simulation.quimb.QiskitQuimbConversionContext") | Contains information about Qiskit-to-Quimb conversion, necessary to recover Qiskit parameters. |

## Functions

### is\_quimb\_available

`is_quimb_available()`

[GitHub](https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.3/qiskit_addon_aqc_tensor/simulation/quimb/__init__.py#L61-L67)

Return `True` is qiskit-quimb is installed, `False` otherwise.

**Return type**

[`bool`](https://docs.python.org/3/library/functions.html#bool)

### qiskit\_ansatz\_to\_quimb

`qiskit_ansatz_to_quimb(qc, initial_parameters, /)`

[GitHub](https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.3/qiskit_addon_aqc_tensor/simulation/quimb/__init__.py#L216-L302)

Convert a Qiskit ansatz to a Quimb parametrized circuit.

**Return type**

[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple)\[`Circuit`, [`QiskitQuimbConversionContext`](/docs/api/qiskit-addon-aqc-tensor/simulation-quimb-qiskit-quimb-conversion-context "qiskit_addon_aqc_tensor.simulation.quimb.QiskitQuimbConversionContext")]

**Parameters**

- **qc** ([*QuantumCircuit*](/docs/api/qiskit/qiskit.circuit.QuantumCircuit))
- **initial\_parameters** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence)*\[*[*float*](https://docs.python.org/3/library/functions.html#float)*]*)

### recover\_parameters\_from\_quimb

`recover_parameters_from_quimb(circ_opt, ctx, /)`

[GitHub](https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.3/qiskit_addon_aqc_tensor/simulation/quimb/__init__.py#L305-L319)

Recover Qiskit circuit parameters from a Quimb circuit.

**Return type**

[`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`float`](https://docs.python.org/3/library/functions.html#float)]

**Parameters**

- **circ\_opt** (*Circuit*)
- **ctx** ([*QiskitQuimbConversionContext*](/docs/api/qiskit-addon-aqc-tensor/simulation-quimb-qiskit-quimb-conversion-context "qiskit_addon_aqc_tensor.simulation.quimb.QiskitQuimbConversionContext"))

### tnoptimizer\_objective\_kwargs

`tnoptimizer_objective_kwargs(objective, /)`

[GitHub](https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.3/qiskit_addon_aqc_tensor/simulation/quimb.py)

Return keyword arguments for use with `TNOptimizer()`.

- `loss_fn`
- `loss_kwargs`

**Return type**

[`dict`](https://docs.python.org/3/library/stdtypes.html#dict)\[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)]

**Parameters**

**objective** ([*MaximizeStateFidelity*](/docs/api/qiskit-addon-aqc-tensor/objective#qiskit_addon_aqc_tensor.objective.MaximizeStateFidelity "qiskit_addon_aqc_tensor.objective.MaximizeStateFidelity"))