🚀 Quick Start
pip install cirquit
from cirquit import QuantumCircuit
# Create a Bell state (quantum entanglement)
qc = QuantumCircuit(2)
qc.h(0)
qc.cx(0, 1)
qc.measure_all()
# Run the circuit
result = qc.run(shots=1000)
print(result)
That's it! You just created quantum entanglement.
🎯 What is Cirquit?
Cirquit is a Python library for building quantum circuits with a developer-first approach. No quantum physics PhD required.
- 🎯 Simple API - Intuitive, Pythonic interface
- ⚡ Fast - Optimized quantum circuit simulation
- 📚 Well Documented - Clear examples and tutorials
- 🔧 Extensible - Easy to add custom gates
- 🌐 Open Source - MIT licensed
Perfect for learning, prototyping, and algorithm development.
✨ Features
Comprehensive Gate Library
Single-qubit gates:
- Pauli gates:
x(),y(),z() - Hadamard:
h() - Rotations:
rx(),ry(),rz()
Two-qubit gates:
cx()- CNOT (controlled-NOT)cz()- Controlled-Z- More coming soon!
Method Chaining
qc = QuantumCircuit(3)
qc.h(0).h(1).h(2).cx(0, 1).cx(1, 2).measure_all()
Circuit Information
print(qc)
# Output: QuantumCircuit(3 qubits, 6 gates)
📖 Examples
Bell State
from cirquit import QuantumCircuit
qc = QuantumCircuit(2)
qc.h(0)
qc.cx(0, 1)
qc.measure_all()
result = qc.run(shots=1000)
# Perfect correlation: ~50% |00⟩ and ~50% |11⟩
GHZ State (3-qubit Entanglement)
from cirquit import QuantumCircuit
qc = QuantumCircuit(3)
qc.h(0)
qc.cx(0, 1)
qc.cx(1, 2)
qc.measure_all()
result = qc.run(shots=1000)
# Result: ~50% |000⟩ and ~50% |111⟩
Superposition
from cirquit import QuantumCircuit
qc = QuantumCircuit(1)
qc.h(0) # Create superposition
qc.measure_all()
result = qc.run(shots=1000)
# Result: ~50% |0⟩ and ~50% |1⟩
📁 More examples: examples/
🛠️ Installation
Requirements
- Python 3.11 or higher
- NumPy
Install from PyPI
pip install cirquit
Install from Source
git clone https://github.com/tony-siqurity-ai/cirquit-web.git
cd cirquit-web
pip install -e .
📚 Documentation
Full documentation is available at docs.cirquit.dev
🗺️ Roadmap
✅ v1.0 (Current)
- Core quantum gates (H, X, Y, Z, CX)
- Basic statevector simulation
- Method chaining API
- PyPI package
🚧 v1.1 (Next)
- Circuit visualization
- More quantum gates (CZ, SWAP, Toffoli)
- Result analysis tools
- Performance optimizations
🔮 Future
- Advanced quantum algorithms
- Noise simulation
- GPU-accelerated simulation
- Cloud API
See our full roadmap →
🤝 Contributing
Contributions are welcome! Here's how you can help:
- 🐛 Report bugs by opening an issue
- ✨ Suggest features in discussions
- 📝 Improve documentation
- 🔧 Submit pull requests
See CONTRIBUTING.md for guidelines.
Development Setup
# Clone the repository
git clone https://github.com/tony-siqurity-ai/cirquit-web.git
cd cirquit-web
# Install in development mode
pip install -e .
# Run tests (if you have them)
python -m pytest tests/
📄 License
Cirquit is released under the MIT License.
🙏 Acknowledgments
Built for the quantum computing community.
Special thanks to early adopters and contributors!
🗺️ Roadmap
See our public roadmap for upcoming features and Cloud API development.
Want to influence what we build? Open a discussion!
⭐ Star us on GitHub if you find Cirquit useful!
Made with ⚛️ by the Cirquit team
Get Started • GitHub • PyPI
Metadata
Release files for cirquit 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cirquit-1.1.0.tar.gz | 15.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cirquit-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.8 kB
Release files / cirquit-1.1.0.tar.gz
| Download URL | cirquit-1.1.0.tar.gz |
|---|---|
| Size | 15.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
636690c709b9642ad3fc4aa4f4bb4397816dc24cdfbab8f9f37107416c0d58f8
|
|
BLAKE2b-256 checksum How to use checksums |
ee55f352cfea7951ac1c92e2c7f3aee0743a4dc68c7ea3fafb7d4451591d8806
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / cirquit-1.1.0-py3-none-any.whl
| Download URL | cirquit-1.1.0-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
db299717f100bd9f9c7ae185c1641483cf7ae3e1013e105103461e52d5cce045
|
|
BLAKE2b-256 checksum How to use checksums |
fe1891fa6f7f3b260f47899ba31c7801bea042ddba140efc634c8882d5153e91
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|