quantum-simulator 0.1.1

A Python library for simulating quantum computers and quantum algorithms

Quantum Simulator

A Python library for simulating quantum computers and quantum algorithms. This package provides an easy-to-use interface for quantum state simulation, gate operations, and circuit execution.

Features

• 🔬 Quantum State Simulation: Accurate simulation of quantum states using state vectors
• 🚪 Quantum Gates: Implementation of common single and multi-qubit gates (X, Y, Z, H, CNOT)
• 🔗 Quantum Circuits: Build and execute complex quantum circuits
• 📊 Measurement: Simulate quantum measurements with proper state collapse
• 🎯 Easy to Use: Clean, intuitive API for quantum programming
• 📚 Well Documented: Comprehensive documentation and examples

Quick Start

Installation

pip install quantum-simulator

Basic Example

from quantum_simulator import QuantumSimulator, QuantumCircuit
from quantum_simulator.gates import H_GATE, CNOT_GATE

# Create a 2-qubit quantum simulator
sim = QuantumSimulator(2)

# Build a Bell state circuit
circuit = QuantumCircuit(2)
circuit.add_gate(H_GATE, [0])        # Hadamard on qubit 0
circuit.add_gate(CNOT_GATE, [0, 1])  # CNOT with control=0, target=1

# Execute the circuit
circuit.execute(sim)

# Measure the qubits
result0 = sim.measure(0)
result1 = sim.measure(1)
print(f"Measurement: {result0}, {result1}")

Documentation

Full documentation is available at beefy.github.io/quantum-simulator

• Installation Guide
• Quick Start
• API Reference
• Examples

Development

Setting Up Development Environment

1. Clone the repository:

   git clone https://github.com/beefy/quantum-simulator.git
   cd quantum-simulator
   

2. Install in development mode:

   pip install -e .[dev,docs]
   

3. Run tests:

   pytest --cov=quantum_simulator --cov-report=xml --cov-report=term
   

4. Run lint checks:

   flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
   mypy src/
   

5. Build documentation:

   mkdocs serve
   

Publishing

Publishing to PyPI

This project uses automated publishing via GitHub Actions. To publish a new version:

1. Prepare the Release

1. Update version in src/quantum_simulator/__init__.py:

   __version__ = "0.2.0"  # Increment version number
   

2. Update CHANGELOG.md with release notes

3. Commit changes:

   git add .
   git commit -m "Bump version to 0.2.0"
   git push
   

2. Create a Release

1. Create and push a tag:

   git tag v0.2.0
   git push origin v0.2.0
   

2. Create a GitHub Release:

   • Go to GitHub Releases
   • Click "Create a new release"
   • Choose the tag you just created
   • Add release notes
   • Click "Publish release"

3. Automated Publishing:

   • GitHub Actions will automatically build and publish to PyPI
   • Check the Actions tab for progress

3. Manual Publishing (if needed)

If automated publishing fails, you can publish manually:

# Install build tools
pip install build twine

# Build the package
python -m build

# Upload to PyPI (requires PyPI API token)
twine upload dist/*

Publishing Documentation

Documentation is automatically deployed to GitHub Pages on every push to the main branch.

Manual Documentation Deployment

# Install documentation dependencies
pip install -e .[docs]

# Build and deploy to GitHub Pages
mkdocs gh-deploy

Local Documentation Development

# Serve documentation locally with auto-reload
mkdocs serve

# Open http://localhost:8000 in your browser