For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
We recommend using pip, poetry, or uv to install the package.
$
pip install conductorquantum
Authentication
The SDK requires an API key for authentication. Sign in and create a new API
key. Remember, your API key is your access secret - keep it safe
with environment variables.
Using environment variables:
Python
1
from dotenv import load_dotenv
2
import os
3
from conductorquantum import ConductorQuantum
4
5
# Load API key from .env file
6
load_dotenv()
7
TOKEN = os.getenv("CONDUCTOR_API_KEY")
8
9
# Initialize client
10
client = ConductorQuantum(token=TOKEN)
Or provide the API key directly:
Python
1
from conductorquantum import ConductorQuantum
2
3
# Initialize client with API key
4
client = ConductorQuantum(token="YOUR_API_KEY")
Usage Examples
Using the Charge Stability Diagram Segmenter
The Charge Stability Diagram Segmenter is a model that can segment a given measurement into different charge stability regimes: no dot (0), single dot (1), and double dot (2).
You can download an example file to follow along with the example:
Python
1
from dotenv import load_dotenv
2
import os
3
import numpy as np
4
from conductorquantum import ConductorQuantum
5
6
7
# Load API key from .env file
8
load_dotenv()
9
TOKEN = os.getenv("CONDUCTOR_API_KEY")
10
11
# Initialize client
12
client = ConductorQuantum(token=TOKEN)
13
14
# Load Charge Stability Diagram data
15
data = np.load("charge-stability-diagram-segmenter-v0.npy") # shape (128, 128)
Using the Charge Stability Diagram Binary Classifier
There are two versions of the Charge Stability Diagram (CSD) binary classifier available: one for 16x16 input arrays and one for 48x48 arrays. Both models classify a CSD as either “double dot” (1) or “not double dot” (0).
Charge Stability Diagram Data Requirements
Input shape: (16, 16) or (48, 48)
Data: 2D numpy array representing transport current or charge sensor signal
To choose the appropriate model, use the suffix in the model string:
For 48x48 data: charge-stability-diagram-binary-classifier-v0-48x48
For 16x16 data: charge-stability-diagram-binary-classifier-v0-16x16
Important Notes for Charge Stability Diagram Models
Input dimensions: Input dimensions should ideally match the specified resolution of the model for the best results. You may need to interpolate or downsample your data to match the required shape. You can find the required input shapes for each model on the models overview page.
Data format: Input data should be a 2D numpy array representing transport current or charge sensor signal values. Each value in the input array corresponds to a point in the charge stability diagram for a set of two plunger gate voltages.
Output format:
The segmenter outputs a 2D array with integer labels: 0 (no dot), 1 (single dot), or 2 (double dot).
The transition detector outputs a 2D array with binary values (0.0 or 1.0) indicating transition line locations.
The binary classifier outputs a classification (0 or 1) and a confidence score.
Model versions: Higher version numbers typically indicate improved accuracy and performance. Check the models overview for the latest available versions.
