qig

Getting Started

  • Installation
    • Requirements
    • Install from source
    • Install dependencies
    • Verify installation
  • Quick Start
    • Creating a Quantum Exponential Family
    • Computing the Fisher Information Metric
    • Constrained Dynamics
    • Working with Entanglement
    • Next Steps

User Guide

  • User Guide
    • Quantum Exponential Families
      • Introduction
      • Creating an Exponential Family
      • See Also
    • Constrained Dynamics
      • Introduction
      • Creating Dynamics
      • Solving Constrained Dynamics
      • See Also
    • Constraint Manifolds
      • Marginal Entropy Constraints
        • Constraint Function
        • Computing Constraints
      • See Also
    • GENERIC Decomposition
      • Overview
      • Quick Start
        • Basic Example
        • Understanding the Results
      • Step-by-Step Guide
        • Step 1: Initialize Exponential Family
        • Step 2: Choose Initial State
        • Step 3: Run Decomposition
        • Step 4: Extract Key Components
        • Step 5: Validate Results
      • Advanced Usage
        • Computing the Diffusion Operator
        • Integrating GENERIC Dynamics
        • Separating Reversible and Irreversible Dynamics
      • Performance Considerations
        • Computational Cost
        • Accuracy vs Speed
      • Troubleshooting
        • Common Issues
        • Interpreting Diagnostics
      • Examples
      • See Also
    • Advanced Topics
      • Entanglement with Pair Operators
      • High-Precision Derivatives (Duhamel)
      • Third-Order Cumulants
      • Optimisation on Manifolds
      • See Also
    • Quantum Exponential Families
    • Constrained Dynamics
    • Constraint Manifolds
    • Advanced Topics

API Reference

  • API Reference
    • Core Modules
      • qig.core
        • partial_trace()
        • von_neumann_entropy()
        • create_lme_state()
        • marginal_entropies()
        • generic_decomposition()
      • qig.exponential_family
        • pauli_basis()
        • gell_mann_matrices()
        • qutrit_basis()
        • create_operator_basis()
        • QuantumExponentialFamily
      • qig.dynamics
        • InaccessibleGameDynamics
        • GenericDynamics
      • qig.pair_operators
        • gell_mann_generators()
        • pair_basis_generators()
        • bell_state()
        • bell_state_density_matrix()
        • multi_pair_basis()
        • product_of_bell_states()
      • qig.duhamel
        • Method Selection
        • References
      • qig.analysis
      • Structure Constants Module
        • compute_structure_constants()
        • verify_lie_algebra()
        • verify_jacobi_identity()
        • verify_antisymmetry()
        • get_cached_structure_constants()
        • cache_structure_constants()
        • compute_and_cache_structure_constants()
        • verify_all_properties()
        • Overview
        • Examples
        • Mathematical Properties
        • See Also
      • qig.generic
        • GENERIC Decomposition Components
        • Examples
        • See Also
      • qig.generic_decomposition
        • High-Level GENERIC Decomposition Interface
        • Classes
        • Functions
        • The 12-Step Procedure
        • Examples
        • See Also
      • Module: qig.symbolic
        • Overview
        • Submodules
        • Example Usage
        • See Also
      • Validation Module
        • ValidationCheck
        • ValidationReport
        • compare_matrices()
        • check_hermitian()
        • check_symmetric()
        • check_antisymmetric()
        • check_traceless()
        • check_commutator()
        • finite_difference_jacobian()
        • check_constraint_tangency()
        • check_entropy_monotonicity()
        • check_positive_semidefinite()
      • Reference Data Module
        • get_su2_structure_constants()
        • get_su3_structure_constants()
        • verify_structure_constant_properties()
        • get_reference_structure_constants()
        • print_reference_verification()

Theory

  • Theory
    • Quantum Exponential Families
      • Mathematical Framework
      • Properties
      • Why Duhamel Integrals Appear
      • What Is Special About Our Geometry?
      • See Also
    • Fisher Information and BKM Metric
      • The Bogoliubov-Kubo-Mori Metric
      • Quantum Covariance
      • See Also
    • The Inaccessible Game
      • Information-Geometric Framework
      • The Central Question
      • Geometric Interpretation
      • See Also
    • Origin Regularisation
      • The North Pole Analogy
      • Valid Regularisation Matrices
        • Structure Detection
      • Efficiency Implications
        • Isotropic Regularisation (σ = I/D)
        • Product Regularisation (σ = σ₁⊗…⊗σₙ)
        • General Regularisation
      • Physics vs Efficiency Trade-off
      • Block-Diagonal Fisher Information
      • Different Origins: bell_indices
      • Further Reading
    • GENERIC Structure
      • General Equation for Non-Equilibrium Reversible-Irreversible Coupling
      • Decomposition
      • For Constrained Quantum Dynamics
      • When Duhamel Integrals Are Needed
        • The Lie Closure Cancellation
        • No Duhamel Required
        • Duhamel Required
        • Practical Implications
      • See Also
    • Symbolic Computation for Qutrits
      • Overview
      • Natural Parameter Interpretation
      • The su(9) Pair Basis
      • LME Block Decomposition (Key Breakthrough)
        • The Entangled Subspace
        • Block-Preserving Generators
        • Reduced Density Matrix Structure
        • Lie-Algebraic Origin
        • Computational Benefit
        • References
      • Available Methods
        • Usage Example: LME Exact
        • Numeric-Symbolic Bridge
        • Precomputed Expressions
        • Caching
      • Validation
      • Current Status
      • See Also
    • Quantum Exponential Families
    • Fisher Information and the BKM Metric
    • The Inaccessible Game Framework
    • Origin Regularisation
    • GENERIC Structure

Development

  • Development Guide
    • Validation Framework
      • Overview
      • Components
        • 1. Validation Utilities (qig/validation.py)
        • 2. Reference Data (qig/reference_data.py)
        • 3. Test Suite (tests/test_validation.py)
      • Usage Examples
        • Basic Validation Report
        • Cross-Validation
        • Using Reference Data
      • Tolerance Hierarchy
      • Phase 0 Completion Status
      • References
      • API Reference
    • Testing Documentation
      • Overview
      • Test Organization
        • Test Markers
        • Running Different Test Subsets
      • Tolerance Framework (CIP-0004)
      • Running Tests
      • Notebook Testing
        • Available Notebooks
        • Running Notebook Tests
      • Test Structure
        • Core Library Tests
        • Derivative Tests
        • Dynamics & Integration
        • Performance & Optimization
        • Diagnostic & Utility
      • See Also
    • Testing Tolerance Framework
      • Tolerance Categories
      • See Also
    • Contributing Guidelines
      • Getting Started
      • Development Workflow
        • 1. Create a Feature Branch
        • 2. Make Your Changes
        • 3. Add Tests
        • 4. Working with Notebooks
        • 5. Update Documentation
        • 6. Commit Your Changes
        • 7. Push and Create Pull Request
      • Project Management (VibeSafe)
        • Code Improvement Plans (CIPs)
        • Backlog Tasks
        • Checking Project Status
      • Code Style Guidelines
        • Python Code
        • Quantum-Specific Guidelines
      • Testing Guidelines
        • Test Categories
        • Test Naming
      • Pull Request Checklist
      • Types of Contributions
        • Bug Reports
        • Feature Requests
        • Code Contributions
      • Questions?
      • License
    • Notebook Development
      • Available Notebooks
      • Notebook Output Filtering
      • Notebook Testing
      • See Also
    • Notebook Output Filtering
      • Overview
      • Setup
      • Verification
        • Test 1: nbstripout works
        • Test 2: Git filter works
        • Test 3: Repository notebooks
      • Usage
        • For Contributors
        • Installing nbstripout (for new clones)
        • Checking Notebook Status
        • Manual Stripping (if needed)
        • Testing the Filter
      • Configuration Files
        • .gitattributes
        • .git/config (automatically created)
        • .gitignore (already configured)
      • Benefits
      • Troubleshooting
        • Filter not working?
        • nbstripout not found?
        • Want to commit outputs (unusual)?
      • Related Files
      • References
    • Testing
    • Testing Tolerances
    • Contributing
    • Notebook Development
qig
  • Overview: module code

All modules for which code is available

  • qig.core
  • qig.duhamel
  • qig.dynamics
  • qig.exponential_family
  • qig.generic
  • qig.generic_decomposition
  • qig.pair_operators
  • qig.reference_data
  • qig.structure_constants
  • qig.symbolic.lme_exact
  • qig.validation

© Copyright 2025, Neil D. Lawrence.

Built with Sphinx using a theme provided by Read the Docs.