Installation

To install QKDpy, you can use pip or uv.

Using uv (recommended)

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/Pranava-Kumar/qkdpy.git
cd qkdpy

# Create a virtual environment
uv venv

# Install in development mode
uv pip install -e .

Using pip

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in development mode
pip install -e .

Optional Extras

QKDpy provides several optional dependency groups for extended functionality:

# Development tools (testing, linting, documentation)
pip install qkdpy[dev]

# Machine learning components (scikit-learn, pandas)
pip install qkdpy[ml]

# Documentation dependencies
pip install qkdpy[docs]

# Visualization extras (seaborn)
pip install qkdpy[viz]

# Enterprise features (cryptography, PKCS#11, compliance)
pip install qkdpy[enterprise]

# Cirq quantum computing framework integration
pip install qkdpy[cirq]

# PennyLane quantum computing framework integration
pip install qkdpy[pennylane]

# QpiAI Quantum SDK integration
pip install qkdpy[qpiai]

# All extras
pip install qkdpy[all]

Product Tiers

QKDpy uses a cumulative three-tier licensing model. By default, the FREE tier is active, which includes all QKD protocols, satellite simulation, ML integration, and advanced visualization.

To activate higher tiers:

# Set via environment variable
export QKDPY_PRODUCT_TIER=enterprise   # or premium

# Or set programmatically
python -c "from qkdpy import set_config; set_config(product_tier='enterprise')"

See the Product Tiers section in the README for a full feature comparison.

Verify Installation

python -c "import qkdpy; print(qkdpy.__version__)"