qcs 0.26.1

High level interface for running Quil on a QPU
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

//! This module defines exceptions used (or catchable) on the Python-side,
//! along with conversions from their Rust error counterparts within this crate.
use pyo3::exceptions::PyException;
use qcs_api_client_common::configuration;
use rigetti_pyo3::{create_exception, exception};

create_exception!(
    qcs_sdk,
    QcsSdkError,
    PyException,
    "Base exception type for errors raised by this package."
);

exception!(
    crate::Error,
    qcs_sdk,
    ExecutionError,
    QcsSdkError,
    "Errors which can occur when executing a program."
);

exception!(
    crate::RegisterMatrixConversionError,
    qcs_sdk,
    RegisterMatrixConversionError,
    QcsSdkError,
    "Error that may occur when building a `RegisterMatrix` from execution data."
);

create_exception!(
    qcs_sdk.client,
    ClientError,
    QcsSdkError,
    "Errors encountered while interacting with a QCS API client."
);

create_exception!(
    qcs_sdk.client,
    BuildClientError,
    ClientError,
    "Errors encountered while building the QCS API client configuration manually."
);

create_exception!(
    qcs_sdk.client,
    LoadClientError,
    ClientError,
    "Errors encountered while loading the QCS API client configuration from the environment configuration."
);

create_exception!(
    qcs_sdk.client,
    TokenError,
    ClientError,
    "Errors that can occur when managing authorization tokens."
);

/// These are conversions from error types in other crates to `PyErr`s of our target types.
/// These can't be implemented using `From` due to orphan rules.
#[expect(
    clippy::needless_pass_by_value,
    reason = "by value makes mapping cleaner"
)]
impl ClientError {
    pub(crate) fn load_error(err: configuration::LoadError) -> pyo3::PyErr {
        LoadClientError::new_err(err.to_string())
    }

    pub(crate) fn builder_error(
        err: configuration::ClientConfigurationBuilderError,
    ) -> pyo3::PyErr {
        BuildClientError::new_err(err.to_string())
    }

    pub(crate) fn token_error(err: configuration::TokenError) -> pyo3::PyErr {
        TokenError::new_err(err.to_string())
    }
}

exception!(
    crate::compiler::quilc::Error,
    qcs_sdk.compiler.quilc,
    QuilcError,
    QcsSdkError,
    "Errors encountered compiling a Quil program."
);

exception!(
    crate::compiler::rpcq::Error,
    qcs_sdk.client,
    RPCQQuilcError,
    ClientError,
    "Errors when compiling with RPCQ client."
);

#[cfg(feature = "libquil")]
exception!(
    crate::compiler::libquil::Error,
    qcs_sdk.client,
    LibquilQuilcError,
    QcsSdkError,
    "Errors when compiling with the libquil client."
);

exception!(
    crate::qpu::ListQuantumProcessorsError,
    qcs_sdk.qpu,
    ListQuantumProcessorsError,
    QcsSdkError,
    "API Errors encountered when trying to list available quantum processors."
);

#[cfg(feature = "experimental")]
exception!(
    crate::qpu::experimental::random::Error,
    qcs_sdk.qpu.experimental.random,
    RandomError,
    QcsSdkError,
    "Errors that may occur using the randomization primitives defined in this module."
);

exception!(
    crate::qpu::api::QpuApiError,
    qcs_sdk.qpu.api,
    QpuApiError,
    QcsSdkError,
    "Errors that can occur while attempting to establish a connection to the QPU."
);

exception!(
    crate::qpu::api::python::SubmissionError,
    qcs_sdk.qpu.api,
    SubmissionError,
    QpuApiError,
    "Errors that may occur when submitting a program for execution."
);

exception!(
    crate::qpu::api::python::BuildOptionsError,
    qcs_sdk.qpu.api,
    BuildOptionsError,
    QpuApiError,
    "Errors building execution options."
);

exception!(
    crate::qpu::GetIsaError,
    qcs_sdk.qpu.isa,
    GetISAError,
    QcsSdkError,
    "Errors raised due to failure to get an ISA."
);

exception!(
    crate::qpu::isa::python::SerializeIsaError,
    qcs_sdk.qpu.isa,
    SerializeISAError,
    QcsSdkError,
    "Errors raised due to failure to serialize an ISA."
);

exception!(
    crate::qpu::translation::python::TranslationError,
    qcs_sdk.qpu.translation,
    TranslationError,
    QcsSdkError,
    "Errors raised due to failure to translate a program."
);

exception!(
    crate::qvm::Error,
    qcs_sdk.qvm,
    QVMError,
    QcsSdkError,
    "Errors that can occur when running a Quil program on QVM."
);