qecp 0.2.7

Quantum Error Correction Playground for Surface Code Research
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

//! Visualizer
//!
//! This module helps visualize the circuit, noise model, model graph, error patterns, corrections, etc.
//!

use crate::chrono::Local;
use crate::serde::{Deserialize, Serialize};
use crate::serde_json;
use crate::urlencoding;
#[cfg(feature = "python_binding")]
use pyo3::prelude::*;
use std::collections::BTreeSet;
use std::fs::File;
use std::io::{Seek, SeekFrom, Write};

pub trait QecpVisualizer {
    fn component_info(&self, abbrev: bool) -> (String, serde_json::Value);
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "python_binding", cfg_eval)]
#[cfg_attr(feature = "python_binding", pyclass)]
pub struct VisualizePosition {
    /// vertical axis, -i is up, +i is down (left-up corner is smallest i,j)
    #[cfg_attr(feature = "python_binding", pyo3(get, set))]
    pub x: f64,
    /// horizontal axis, -j is left, +j is right (left-up corner is smallest i,j)
    #[cfg_attr(feature = "python_binding", pyo3(get, set))]
    pub y: f64,
}

#[cfg_attr(feature = "python_binding", cfg_eval)]
#[cfg_attr(feature = "python_binding", pymethods)]
impl VisualizePosition {
    /// create a visualization position
    #[cfg_attr(feature = "python_binding", new)]
    pub fn new(x: f64, y: f64) -> Self {
        Self { x, y }
    }
    #[cfg(feature = "python_binding")]
    fn __repr__(&self) -> String {
        format!("{:?}", self)
    }
}

#[derive(Debug)]
#[cfg_attr(feature = "python_binding", cfg_eval)]
#[cfg_attr(feature = "python_binding", pyclass)]
pub struct Visualizer {
    /// save to file if applicable
    file: Option<File>,
    /// component sealed
    component_done: bool,
    /// names of the components
    #[cfg_attr(feature = "python_binding", pyo3(get))]
    pub component_names: BTreeSet<String>,
}

#[cfg_attr(feature = "python_binding", cfg_eval)]
#[cfg_attr(feature = "python_binding", pymethods)]
impl Visualizer {
    /// create a new visualizer with target filename and node layout
    #[cfg_attr(feature = "python_binding", new)]
    #[cfg_attr(feature = "python_binding", pyo3(signature = (filepath)))]
    pub fn new(mut filepath: Option<String>) -> std::io::Result<Self> {
        if cfg!(feature = "disable_visualizer") {
            filepath = None; // do not open file
        }
        let mut file = match filepath {
            Some(filepath) => Some(File::create(filepath)?),
            None => None,
        };
        if let Some(file) = file.as_mut() {
            file.set_len(0)?; // truncate the file
            file.seek(SeekFrom::Start(0))?; // move the cursor to the front
            file.write_all(format!("{{\"format\":\"qecp\",\"version\":\"{}\"}}", env!("CARGO_PKG_VERSION")).as_bytes())?;
            file.sync_all()?;
        }
        Ok(Self {
            file,
            component_names: BTreeSet::new(),
            component_done: false,
        })
    }

    pub fn end_component(&mut self) -> std::io::Result<()> {
        assert!(!self.component_done);
        self.component_done = true;
        if let Some(file) = self.file.as_mut() {
            file.seek(SeekFrom::End(-1))?; // move the cursor before the ending }
            file.write_all(b",\"cases\":[")?;
            file.write_all(
                json!({
                    "error_pattern": {},
                    "correction": {},
                    "measurement": [],
                    "detected_erasures": [],
                    "qec_failed": false,
                    "elapsed": {
                        "simulate": 0.,
                        "decode": 0.,
                        "validate": 0.,
                    },
                })
                .to_string()
                .as_bytes(),
            )?;
            file.write_all(b"]}")?;
            file.sync_all()?;
        }
        Ok(())
    }
}

#[cfg(feature = "python_binding")]
#[pymethods]
impl Visualizer {
    pub fn add_component_simulator(&mut self, simulator: &crate::simulator::Simulator) -> std::io::Result<()> {
        self.add_component(simulator)
    }
    pub fn add_component_noise_model(&mut self, noise_model: &crate::noise_model::NoiseModel) -> std::io::Result<()> {
        self.add_component(noise_model)
    }
    pub fn add_component_model_graph(&mut self, model_graph: &crate::model_graph::ModelGraph) -> std::io::Result<()> {
        self.add_component(model_graph)
    }
    pub fn add_component_model_hypergraph(
        &mut self,
        model_hypergraph: &crate::model_hypergraph::ModelHypergraph,
    ) -> std::io::Result<()> {
        self.add_component(model_hypergraph)
    }
    #[pyo3(name = "add_case")]
    pub fn py_add_case(&mut self, case: PyObject) -> std::io::Result<()> {
        use crate::util::*;
        let case = pyobject_to_json(case);
        self.add_case(case)
    }
}

impl Visualizer {
    /// add component to the visualizer; each component should be independent
    pub fn add_component(&mut self, component: &impl QecpVisualizer) -> std::io::Result<()> {
        assert!(!self.component_done);
        let abbrev = true;
        if let Some(file) = self.file.as_mut() {
            file.seek(SeekFrom::End(-1))?; // move the cursor before the ending }
            let (name, component_info) = component.component_info(abbrev);
            file.write_all(format!(",\"{}\":", name).as_bytes())?;
            file.write_all(json!(component_info).to_string().as_bytes())?;
            file.write_all(b"}")?;
            file.sync_all()?;
        }
        Ok(())
    }

    pub fn add_case(&mut self, case: serde_json::Value) -> std::io::Result<()> {
        if !self.component_done {
            self.end_component()?;
        }
        if let Some(file) = self.file.as_mut() {
            file.seek(SeekFrom::End(-2))?; // move the cursor before the ending ]}
            file.write_all(b",")?;
            file.write_all(case.to_string().as_bytes())?;
            file.write_all(b"]}")?;
            file.sync_all()?;
        }
        Ok(())
    }
}

impl Drop for Visualizer {
    fn drop(&mut self) {
        if !self.component_done {
            self.end_component().unwrap();
        }
    }
}

const DEFAULT_VISUALIZE_DATA_FOLDER: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/visualize/data/");

// only used locally, because this is compile time directory
pub fn visualize_data_folder() -> String {
    DEFAULT_VISUALIZE_DATA_FOLDER.to_string()
}

#[cfg_attr(feature = "python_binding", pyfunction)]
pub fn static_visualize_data_filename() -> String {
    "visualizer.json".to_string()
}

#[cfg_attr(feature = "python_binding", pyfunction)]
pub fn auto_visualize_data_filename() -> String {
    format!("{}.json", Local::now().format("%Y%m%d-%H-%M-%S%.3f"))
}

#[cfg_attr(feature = "python_binding", pyfunction)]
pub fn print_visualize_link_with_parameters(filename: String, parameters: Vec<(String, String)>) {
    let default_port = if cfg!(feature = "python_binding") { 51669 } else { 8069 };
    let mut link = format!("http://localhost:{}?filename={}", default_port, filename);
    for (key, value) in parameters.iter() {
        link.push('&');
        link.push_str(&urlencoding::encode(key));
        link.push('=');
        link.push_str(&urlencoding::encode(value));
    }
    if cfg!(feature = "python_binding") {
        println!(
            "opening link {} (use `fusion_blossom.open_visualizer(filename)` to start a server and open it in browser)",
            link
        )
    } else {
        println!("opening link {} (start local server by running ./visualize/server.sh) or call `node index.js <link>` to render locally", link)
    }
}

#[cfg_attr(feature = "python_binding", pyfunction)]
pub fn print_visualize_link(filename: String) {
    print_visualize_link_with_parameters(filename, Vec::new())
}

#[cfg(feature = "python_binding")]
#[pyfunction]
pub(crate) fn register(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
    m.add_class::<VisualizePosition>()?;
    m.add_class::<Visualizer>()?;
    m.add_function(wrap_pyfunction!(static_visualize_data_filename, m)?)?;
    m.add_function(wrap_pyfunction!(auto_visualize_data_filename, m)?)?;
    m.add_function(wrap_pyfunction!(print_visualize_link_with_parameters, m)?)?;
    m.add_function(wrap_pyfunction!(print_visualize_link, m)?)?;
    Ok(())
}