Skip to content

πŸ”¬ Advanced Laboratory Software for Quantum Measurement Devices is a comprehensive laboratory software solution designed to interface with and control quantum measurement devices. It enables national laboratories and universities to standardize their electrical measurements without multiplying devices.

License

Notifications You must be signed in to change notification settings

michaelgermini/quantum-meter-pro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

QuantumMeter Pro πŸš€

QuantumMeter Pro Logo

Advanced Laboratory Software for Quantum Measurement Devices

Python License Version Build Status

QuantumMeter Pro is a comprehensive laboratory software solution designed to interface with and control quantum measurement devices. It enables national laboratories and universities to standardize their electrical measurements without multiplying devices.

πŸ“‹ Table of Contents

🌟 Features

πŸ”¬ Real-time Measurement

  • Current Measurement: Nanoampere precision (1 nA base)
  • Voltage Measurement: Microvolt precision (ΞΌV)
  • Resistance Calculation: Automatic calculation in megohms (MΞ©)
  • Temperature Monitoring: Controlled environment tracking
  • Quantum Precision: 0.01 ppm accuracy

πŸ“Š Data Visualization

  • 4 Real-time Charts: Current, Voltage, Resistance, Temperature
  • Interactive Dashboard: Web-based interface with Chart.js
  • Desktop Application: PyQt6-based GUI with Matplotlib
  • Responsive Design: Works on desktop, tablet, and mobile

πŸ€– AI Analysis Module

  • Statistical Analysis: Mean, standard deviation, min/max values
  • Anomaly Detection: 3-sigma rule for outlier identification
  • Quality Assessment: Overall measurement quality score
  • Error Correction: Automatic experimental error detection

πŸ“ Data Management

  • Export Formats: CSV, Excel, SQL
  • Import Capabilities: Load existing measurement data
  • Sample Data: Pre-loaded demonstration datasets
  • Data Retention: Configurable storage policies

🌐 Web Dashboard

  • Real-time Updates: Live data streaming
  • Device Control: Connect/disconnect devices
  • Measurement Control: Start/stop measurements
  • API Endpoints: RESTful API for integration

πŸ“Š Data Interface

QuantumMeter Pro Data Table Interface

Real-time data table showing current, voltage, resistance, and temperature measurements

🌐 Web Interface

QuantumMeter Pro Complete Web Interface

Complete web dashboard interface with real-time charts, control panels, and measurement data

πŸ”¬ Technical Specifications

Measurement Precision

  • Current: 1 nA base with 0.01% precision
  • Voltage: 1 V base with 1 ΞΌV precision
  • Resistance: Calculated from V/I ratio
  • Temperature: 23Β°C Β± 0.1Β°C controlled

Supported Devices

  • Quantum Resistance Bridges: High-precision resistance measurement
  • Nanoampere Meters: Ultra-low current measurement
  • Voltage Standards: Calibrated voltage sources
  • Temperature Controllers: Environmental monitoring

Data Formats

  • CSV: Comma-separated values with timestamps
  • Excel: Multi-sheet format with charts
  • SQL: Database export for analysis
  • JSON: API data exchange format

πŸ“Š Audit Report

A comprehensive security and code quality audit has been performed on QuantumMeter Pro. The audit reveals both strengths and areas for improvement.

πŸ” Key Findings

  • Code Quality: 177 linting issues identified
  • Security: 13 dependency vulnerabilities detected
  • Type Safety: 45 type annotation errors
  • Formatting: 3 files require reformatting

πŸ›‘οΈ Security Status

  • Application Code: βœ… No high-severity security issues
  • Dependencies: ⚠️ 13 vulnerabilities in third-party packages
  • Critical Issues: 5 high-severity vulnerabilities requiring immediate attention

πŸ”§ Recommended Actions

Immediate (High Priority)

  1. Update Vulnerable Dependencies:

    pip install --upgrade werkzeug>=3.0.6
    pip install --upgrade jinja2>=3.1.5
    pip install --upgrade flask>=3.1.1
  2. Fix Code Style Issues:

    black .
    isort .
  3. Add Type Annotations:

    • Add return type annotations to all functions
    • Add type hints for variables
    • Fix mypy configuration

Medium Priority

  1. Remove Unused Imports
  2. Fix Line Length Issues
  3. Add Comprehensive Tests
  4. Implement Security Headers

Low Priority

  1. Code Documentation
  2. Performance Optimization
  3. Error Handling Enhancement

πŸ“‹ Detailed Audit Report

For a complete analysis including:

  • Detailed vulnerability breakdown
  • Code quality metrics
  • Remediation timeline
  • Security recommendations

πŸ“– View Full Audit Report

πŸ› οΈ Installation

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Quick Start

Option 1: Desktop Application (Local)

  1. Clone the repository

    git clone https://github.com/michaelgermini/quantum-meter-pro.git
    cd quantum-meter-pro
  2. Install dependencies

    pip install -r requirements.txt
  3. Run the desktop application

    python main.py

Option 2: Web Dashboard (Local)

  1. Install dependencies

    pip install -r requirements.txt
  2. Run the web dashboard

    python src/web/app.py
  3. Access the web interface

    • Open http://localhost:8080 in your web browser

Option 3: Streamlit Version (Cloud-Ready)

  1. Install Streamlit dependencies

    pip install -r requirements-streamlit.txt
  2. Run Streamlit application

    streamlit run streamlit_app.py
  3. Access Streamlit interface

    • Open http://localhost:8501 in your web browser

Development Setup

For development, install additional dependencies:

pip install -r requirements-dev.txt

🎯 Usage

Desktop Application

  1. Launch the application

    python main.py
  2. Start measurements

    • Click "Start Measurement" to begin data collection
    • Real-time charts will update automatically
    • View AI analysis in the dedicated tab
  3. Export data

    • Click "Export Data" to save measurements
    • Choose format: CSV, Excel, or SQL
    • Data includes timestamps and all measurement values

Web Dashboard

  1. Access the dashboard

    • Open http://localhost:8080
    • View real-time measurement charts
    • Monitor device status
  2. Control devices

    • Connect/disconnect measurement devices
    • Start/stop measurements remotely
    • Configure sampling rates
  3. Data management

    • Load sample data for demonstration
    • Import CSV files with existing measurements
    • Export current dataset
  4. AI Analysis

    • View statistical analysis of measurements
    • Check for anomalies and quality scores
    • Monitor measurement stability
QuantumMeter Pro Web Dashboard Interface

Live web dashboard at http://localhost:8080 showing real-time data visualization, control panels, and measurement charts

πŸ“ Project Structure

QuantumMeter Pro/
β”œβ”€β”€ main.py                          # Desktop application entry point
β”œβ”€β”€ requirements.txt                 # Python dependencies
β”œβ”€β”€ requirements-dev.txt             # Development dependencies
β”œβ”€β”€ README.md                       # This file
β”œβ”€β”€ LICENSE                         # MIT License
β”œβ”€β”€ CHANGELOG.md                    # Version history
β”œβ”€β”€ CONTRIBUTING.md                 # Contribution guidelines
β”œβ”€β”€ .gitignore                      # Git ignore rules
β”œβ”€β”€ setup.py                        # Package setup
β”œβ”€β”€ pyproject.toml                  # Modern Python project config
β”œβ”€β”€ config/
β”‚   └── devices.yaml               # Device configuration
β”œβ”€β”€ data/
β”‚   └── sample_quantum_data.csv    # Sample measurement data
β”œβ”€β”€ src/
β”‚   └── web/
β”‚       β”œβ”€β”€ app.py                 # Flask web application
β”‚       └── templates/
β”‚           └── dashboard.html     # Web dashboard template
β”œβ”€β”€ .github/
β”‚   β”œβ”€β”€ workflows/
β”‚   β”‚   └── ci.yml                # CI/CD pipeline
β”‚   β”œβ”€β”€ ISSUE_TEMPLATE/
β”‚   β”‚   β”œβ”€β”€ bug_report.md         # Bug report template
β”‚   β”‚   └── feature_request.md    # Feature request template
β”‚   └── PULL_REQUEST_TEMPLATE.md  # PR template
└── docs/                          # Documentation (future)

πŸ”§ Configuration

Device Configuration (config/devices.yaml)

The application supports multiple quantum measurement devices:

devices:
  quantum_device_001:
    name: "Primary Quantum Meter"
    type: "quantum_resistance_bridge"
    connection:
      type: "serial"
      port: "COM3"
      baudrate: 115200
    measurement_ranges:
      current: [1e-12, 1e-9, 1e-6, 1e-3]
      voltage: [1e-3, 1e-0, 1e3]
    sampling_rates: [1, 10, 100, 1000]

Global Settings

  • Data Retention: Configure how long to keep measurement data
  • Auto Backup: Automatic data backup settings
  • Export Formats: Supported export file types
  • AI Analysis: Enable/disable AI features

🀝 Contributing

We welcome contributions to QuantumMeter Pro! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/your-feature-name
  3. Make your changes
  4. Add tests (if applicable)
  5. Commit your changes
    git commit -m "Add: your feature description"
  6. Push to your branch
    git push origin feature/your-feature-name
  7. Create a Pull Request

Development Guidelines

  • Follow PEP 8 style guidelines
  • Add type hints to all functions
  • Write comprehensive docstrings
  • Include tests for new functionality
  • Update documentation as needed

For detailed contribution guidelines, see CONTRIBUTING.md.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ“ž Support

πŸ”„ Version History

v1.0.0 (Current)

  • Initial release
  • Desktop application with PyQt6
  • Web dashboard with Flask
  • Real-time data visualization
  • AI analysis module
  • Data import/export capabilities

For detailed version history, see CHANGELOG.md.


Made with ❀️ for the scientific community

QuantumMeter Pro - Advancing Quantum Measurement Technology

About

πŸ”¬ Advanced Laboratory Software for Quantum Measurement Devices is a comprehensive laboratory software solution designed to interface with and control quantum measurement devices. It enables national laboratories and universities to standardize their electrical measurements without multiplying devices.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published