Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 1.87 KB

DOCUMENTATION.md

File metadata and controls

110 lines (80 loc) · 1.87 KB

Documentation

Data Files

The project uses several CSV files to store experiment data:

1. QEC Experiments (data/qec_exp.csv)

  • Article Title
  • Link
  • Year
  • Platform
  • Code Parameters
  • Code Name
  • Notes

2. Magic State Distillation (data/msd_exp.csv)

  • Article Title
  • Link
  • Year
  • Platform
  • Notes

3. Entangled State Error (data/entangled_state_error_exp.csv)

  • Article Title
  • Link
  • Year
  • Platform
  • Entangled State Error
  • Notes

4. Qubit Count (data/qubit_count.csv)

  • Article Title
  • Link
  • Year
  • Platform
  • Number of qubits
  • Notes

Generating Plots

Individual Plots

Each plot can be generated separately:

# Generate qubit count evolution plot
python -m src.plotting.qubit_count_plot

# Generate entangled error plot
python -m src.plotting.entangled_error_plot

# Generate QEC time evolution plot
python -m src.plotting.qec_time_plot

# Generate NKD plot
python -m src.plotting.nkd_plot

All Plots

Use the Makefile to generate all plots:

make plots

Generating README

The README.md file is automatically generated from the data:

make readme

Configuration

The config.yaml file contains all configuration settings:

  • File paths
  • Plot settings
  • Visual style parameters

Development

Running Tests

# Run all tests
make test

# Run specific test file
pytest tests/test_plotting.py

# Run with coverage
pytest --cov=src tests/

Code Structure

Plotting Classes

  • BasePlot: Abstract base class for all plots
  • QubitCountPlot: Qubit count evolution plot
  • EntangledErrorPlot: Entangled state error plot
  • QECTimePlot: QEC implementation timeline
  • NKDPlot: [n,k,d] parameter space plot

Markdown Generation

  • BaseSection: Base class for markdown sections
  • ExperimentSection: Base class for experiment sections
  • MarkdownGenerator: Main class for README generation