feat!: The execution_data module now provides ExecutionData as a replacement for both Qvm and Qpu structs. It serves a common interface for interacting with both result shapes when possible. See the ExecutionData documentation for more details on how to use it. (#223)

Co-authored-by: Michael Bryant <[email protected]>
Co-authored-by: Jake Selig <[email protected]>
Co-authored-by: Kalan <[email protected]>

Author: 4 people

.gitignore

@@ -1,9 +1,13 @@
 # Cargo / rustc artifacts
 /target
 
+# Python artifacts
+__pycache__/
+
 # Local config
 .env
 venv/
+.venv
 
 # JetBrains
 .idea

Cargo.lock

@@ -1,3 +1,23 @@
 [workspace]
 members = ["crates/*"]
 
+[workspace.dependencies]
+qcs-api = "0.2.1"
+qcs-api-client-common = "0.4.2"
+qcs-api-client-grpc = "0.4.2"
+qcs-api-client-openapi = "0.5.2"
+quil-rs = "0.15"
+serde_json = "1.0.86"
+tokio = "1.24.2"
+
+# ndarray is used by the `qcs` crate, but it is also used in the `python` crate via a 
+# re-export through the numpy crate. They should be updated as a pair to keep both 
+# crates version of ndarray in sync.
+# Similarly, pyo3 packages (`numpy`, `rigetti-pyo3`, `pyo3*`) track versions together 
+# and need to be updated together.
+ndarray = { version = "0.15.6", features = ["serde"] }
+numpy = "0.17"
+pyo3 = { version = "0.17", features = ["extension-module"] }
+pyo3-asyncio = { version = "0.17", features = ["tokio-runtime"] }
+pyo3-build-config = { version = "0.17" }
+rigetti-pyo3 = { version = "0.1.0-rc.4", features = ["extension-module", "complex"] }

Cargo.toml

@@ -19,32 +19,35 @@ futures = "0.3.24"
 indexmap = "1.9.1"
 lazy_static = "1.4.0"
 log = "0.4.17"
+ndarray.workspace = true
 num = { version = "0.4.0", features = ["serde"] }
-qcs-api = "0.2.1"
-qcs-api-client-common = "0.4.2"
-qcs-api-client-openapi = "0.5.2"
-qcs-api-client-grpc = "0.4.2"
-quil-rs = "0.15"
+qcs-api.workspace = true
+qcs-api-client-common.workspace = true
+qcs-api-client-openapi.workspace = true
+qcs-api-client-grpc.workspace = true
+quil-rs.workspace = true
 reqwest = { version = "0.11.12", default-features = false, features = ["rustls-tls", "json"] }
 rmp-serde = "1.1.1"
 serde = { version = "1.0.145", features = ["derive"] }
 serde_bytes = "0.11.7"
-serde_json = "1.0.86"
+serde_json.workspace = true
 thiserror = "1.0.37"
-tokio = { version = "1.24.2", features = ["fs"] }
+tokio = { workspace = true, features = ["fs"] }
 toml = "0.5.9"
 uuid = { version = "1.2.1", features = ["v4"] }
 tonic = { version = "0.8.2", features = ["tls", "tls-roots"] }
 zmq = { version = "0.9.2", features = ["vendored"] }
+itertools = "0.10.5"
 
 [dev-dependencies]
 erased-serde = "0.3.23"
 float-cmp = "0.9.0"
 hex = "0.4.3"
 maplit = "1.0.2"
-qcs-api-client-grpc = { version = "0.4.2", features = ["server"] }
+qcs-api-client-grpc = { workspace = true, features = ["server"] }
 simple_logger = { version = "2.3.0", default-features = false }
 tempfile = "3.3.0"
 tokio = { version = "1.21.2", features = ["macros", "rt-multi-thread"] }
 warp = { version = "0.3.3", default-features = false }
 regex = "1.7.0"
+test-case = "2.2.2"

crates/lib/Cargo.toml

@@ -17,7 +17,7 @@ async fn main() {
 
     let result = exe
         .with_parameter("theta", 0, PI)
-        .execute_on_qpu("Aspen-11")
+        .execute_on_qpu("Aspen-M-3")
         .await
         .expect("Program should execute successfully");
 

crates/lib/examples/execute.rs

@@ -18,9 +18,9 @@ async fn main() {
 
     let result = exe
         .with_parameter("theta", 0, PI)
-        .execute_on_qpu("Aspen-11")
+        .execute_on_qpu("Aspen-M-3")
         .await
         .expect("Program should execute successfully");
 
-    println!("{:?}", result);
+    println!("{result:?}");
 }

crates/lib/examples/local.rs

@@ -5,7 +5,6 @@ use std::f64::consts::PI;
 use std::time::Duration;
 
 use qcs::Executable;
-use qcs_api_client_grpc::models::controller::{readout_values::Values, IntegerReadoutValues};
 
 const PROGRAM: &str = r#"
 DECLARE ro BIT
@@ -30,32 +29,30 @@ async fn main() {
         let theta = step * f64::from(i);
         let data = exe
             .with_parameter("theta", 0, theta)
-            .execute_on_qpu("Aspen-11")
+            .execute_on_qpu("Aspen-M-3")
             .await
             .expect("Executed program on QPU");
         total_execution_time += data
             .duration
-            .expect("Aspen-11 should always report duration");
+            .expect("Aspen-M-3 should always report duration");
 
-        let ro_readout_data = data
-            .readout_data
-            .get_readout_values_for_field("ro")
+        let first_ro_values = data
+            .result_data
+            .to_register_map()
+            .expect("should be able to create a RegisterMap")
+            .get_register_matrix("ro")
             .expect("readout values should contain 'ro'")
-            .expect("'ro' should contain readout values");
-        let first_ro_data = ro_readout_data
-            .first()
-            .expect("'ro' should contain at least one readout value")
-            .clone();
-        let first_ro_values = first_ro_data
-            .expect("first readout value should ")
-            .values
-            .expect("'ro' should have readout values");
-        if let Values::IntegerValues(IntegerReadoutValues { mut values }) = first_ro_values {
-            parametric_measurements.append(&mut values)
+            .as_integer()
+            .expect("'ro' should be a register of integer values")
+            .row(0)
+            .to_owned();
+
+        for value in &first_ro_values {
+            parametric_measurements.push(*value)
         }
     }
 
-    println!("Total execution time: {:?}", total_execution_time);
+    println!("Total execution time: {total_execution_time:?}");
 
     for measurement in parametric_measurements {
         if measurement == 1 {

crates/lib/examples/parametric_compilation.rs

@@ -3,7 +3,6 @@
 //! [pyquil]: https://pyquil-docs.rigetti.com/en/stable/quilt_getting_started.html#Another-example:-a-simple-T1-experiment
 
 use qcs::Executable;
-use qcs_api_client_grpc::models::controller::{readout_values::Values, IntegerReadoutValues};
 
 /// This program doesn't do much, the main point is that it will fail if quilc is invoked.
 const PROGRAM: &str = r#"
@@ -20,17 +19,17 @@ async fn main() {
 
     let result = exe
         .compile_with_quilc(false)
-        .execute_on_qpu("Aspen-11")
+        .execute_on_qpu("Aspen-M-3")
         .await
         .expect("Program should execute successfully")
-        .readout_data
-        .get_readout_values("ro".to_string(), 0)
-        .expect("Readout data should include 'ro'")
-        .values
-        .expect("Readout data should include values");
+        .result_data
+        .to_register_map()
+        .expect("should be able to convert execution data to RegisterMap")
+        .get_register_matrix("ro")
+        .expect("Register data should include 'ro'")
+        .as_integer()
+        .expect("ro should be a register of integer values")
+        .to_owned();
 
-    match result {
-        Values::IntegerValues(IntegerReadoutValues { values }) => assert!(!values.is_empty()),
-        _ => panic!("expected IntegerReadoutValues, got {:?}", result),
-    }
+    println!("{result:?}");
 }