Skip to content

Commit 666eec2

Browse files
authored
Update README to enhance project description and highlight features (#42)
1 parent fdf2559 commit 666eec2

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Qubit Simulator
22

3-
Qubit Simulator is a simple and lightweight library that provides a quantum statevector simulator for simulating qubits and quantum gates. It supports basic quantum operations and gates using NumPy.
3+
A simple yet flexible statevector-based quantum circuit simulator for Python. It supports common single-, two-, and three-qubit gates (including parameterized gates), measurement (shot-based sampling), state resetting, and basic circuit visualization.
4+
5+
## Features
6+
7+
- **Statevector Simulation**: Maintains a complex-valued statevector of size ( 2^n ).
8+
- **Common Gates**: X, Y, Z, H, S, T, plus multi-qubit gates like CNOT, SWAP, Toffoli, Fredkin, etc.
9+
- **Parameterized Gates**: General single-qubit rotation ( U(θ, φ, λ) ).
10+
- **Controlled Gates**: Automatically construct controlled versions of single-qubit gates.
11+
- **Circuit Visualization**: Generate a diagram of applied operations with `.draw()`.
12+
- **Measurement**: Returns shot-based measurement outcomes from the final state.
13+
- **Lightweight**: Only requires [NumPy](https://numpy.org). For plotting, install optional [matplotlib](https://matplotlib.org).
414

515
## Installation
616

0 commit comments

Comments
 (0)