metsuperq 0.1.0

A project to define standards for analysis functions of experimental data in the MetSuperQ project.

MetSuperQ

Quantum measurement analysis with integrated InfluxDB time-series storage.

Features

• Quantum Measurement Analysis: T1, T2 echo, and T2 Ramsey measurement analysis
• InfluxDB Integration: Modern time-series database storage
• User-Friendly API: Simple interface for users to record measurements
• Comprehensive Validation: Pydantic-based data validation at all boundaries
• Performance Monitoring: Built-in logging and performance tracking

Quick Start

Prerequisites

• Python 3.12+
• InfluxDB v2.x (optional)

Installation

For users (install from PyPI or source):

# From PyPI (when published)
pip install metsuperq

# Or from source
git clone https://code.orangeqs.com/opensource/metsuperq.git

For developers (using uv):

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and install in development mode
git clone https://code.orangeqs.com/opensource/metsuperq.git
cd metsuperq
uv sync  # Installs all dev dependencies

See Installation Guide for detailed setup.

Basic Usage

from metsuperq.analysis import BaseAnalyzer
from metsuperq.integrations import record_measurement

# Run analysis
analyzer = BaseAnalyzer()
result = analyzer.run_full_analysis("20241008-143022-123-abcdef")

# Record to database
record_measurement(
    analysis_result=result,
    experiment_id="experiment_1",
    device_name="device_1",
    qubit_name="Q1",
)

Development

This project uses uv for fast, reproducible dependency management.

# Install dependencies and set up environment
uv sync

# Run pre-commit hooks
uv run pre-commit install
uv run pre-commit run --all-files

# Run tests
uv run pytest

# Run type checking
uv run pyright

See Contributing Guide for details.

Documentation

• Installation Guide
• API Reference
• Architecture Overview

Contributing

Fork, create a feature branch, add tests, and submit a PR. See Contributing Guide.

License

BSD 3-Clause License. See LICENSE for details.

Support

• Documentation: Project Docs
• Issues and Discussions: GitLab Issues
• Merge Requests: GitLab Merge Requests