Installation Guide#

This notebook covers installation of QCMet and its dependencies.

Requirements#

QCMet requires Python 3.10 or higher.

Basic Installation#

Clone the repository, and install QCMet and its dependencies using pip (inside the QCMet root folder):

pip install -e .

Optional Dependencies#

Development Tools#

pip install -e .[dev]

All Optional Dependencies#

pip install -e .[dev,docs,lint]

Verifying Installation#

Let’s verify that QCMet is installed correctly:

import qcmet
print(f"QCMet version: {qcmet.__version__}")
QCMet version: 1.0.0

Testing the Installation#

Let’s run a simple test to ensure everything works:

from qcmet import T1
from qcmet.devices import IdealSimulator

# Create a simple T1 benchmark
simulator = IdealSimulator()
t1 = T1()

# Generate circuits
t1.generate_circuits()
print(f"Generated {len(t1.circuits)} circuits")
print("QCMet is working correctly!")
Generated 10 circuits
QCMet is working correctly!