Skip to content

Commit

Permalink
[update] readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mc-Zen committed Feb 17, 2024
1 parent 1c8a4da commit 5909c7d
Show file tree
Hide file tree
Showing 2 changed files with 1,920 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ You can clone the [repository][repository] and include it in your project. Soon,

A total of 19 connectivities are currently supported, ranging from 2 to 6 qubits. For each supported number of qubits, circuits for full connectivity and line connectivity are available. Additionally, other connectivities that occur in current quantum chips or which are subgraphs of existing hardware are supported.

The following graphics show all currently available connectivities.
All currently available connectivities are shown below.

### 2 qubits
![][hardware-connectivities]

<!-- ### 2 qubits
![][2-qubit-con]
### 3 qubits
Expand All @@ -35,11 +37,11 @@ The following graphics show all currently available connectivities.
![][5-qubit-con]
### 6 qubits
![][6-qubit-con]
![][6-qubit-con] -->

## Usage

```
```py
from htstabilizer.stabilizer_circuits import *

pqc = get_preparation_circuit(Stabilizer(["XZZ", "ZXI", "ZIX"]), "linear")
Expand Down Expand Up @@ -73,6 +75,7 @@ View examples for exploring the functionality:
[4-qubit-con]: docs/images/4-qubit%20connectivities.png
[5-qubit-con]: docs/images/5-qubit%20connectivities.png
[6-qubit-con]: docs/images/6-qubit%20connectivities.png
[hardware-connectivities]: docs/images/Hardware_Connectivities.svg

[example-compress]: https://github.com/Mc-Zen/htstabilizer/blob/master/examples/compress_preparation_circuit.py
[example-readout]: https://github.com/Mc-Zen/htstabilizer/blob/master/examples/readout_circuit.py
Expand Down
Loading

0 comments on commit 5909c7d

Please sign in to comment.