Using the Charge Stability Diagram Models | Conductor Quantum

Installation

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")

Data Requirements

Charge Stability Diagram Data

Shape: (128, 128)
2D array of current values

Important Notes for Charge Stability Diagram Data

Input dimensions must be (128, 128) - you may need to interpolate/downsample your data.
Each current value in the input array corresponds to a point in the charge stability diagram for a set of two gate voltages.

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)
16 
17 # Segment the Charge Stability Diagram
18 result = client.models.execute(
19     model="charge-stability-diagram-segmenter-v0",
20     data=data
21 )
22 
23 # Access the segmentation result
24 segmentation = result.output["segmentation"]
25 print(f"Segments: {segmentation}")

Output

1 Segments: [
2     [2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2], 
3     ..., 
4     [2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
5 ]

Charge Stability Diagram Input Data — Input Data

Charge Stability Diagram Segmenter v0 Output

Using the Charge Transition Line Detector

The Charge Transition Line Detector is a model that detects the locations of charge transition lines in a charge stability diagram.

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-transition-detector-v0.npy") # shape (n, m)
16 
17 # Detect the transition lines in the Charge Stability Diagram
18 result = client.models.execute(
19     model="charge-stability-diagram-transition-detector-v0",
20     data=data
21 )
22 
23 # Access the transition lines result
24 transition_lines = result.output["transition_lines"]
25 print(f"Transition lines: {transition_lines}")

Output

1 Transition lines: [
2   [False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, True, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, True, True, True, False, True, True, True, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, True, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, True, True, False, False, False],  
3   ...,
4   [False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
5 ]

Charge Transition Line Detector v0 Output

Using the Charge Stability Diagram Classifier

The Charge Stability Diagram Classifier is a model that can classify a charge stability diagram as one of the following: no dot (0), single dot (1), and double dot (2).

Charge Stability Diagram Data

Shape: (128, 128)
2D array of values (transport current or charge sensor signal)

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-classifier-v0.npy")  # shape (128, 128)
16 
17 # Segment the Charge Stability Diagram
18 result = client.models.execute(
19     model="charge-stability-diagram-classifier-v0",
20     data=data
21 )
22 
23 # Access the classification result
24 classification = result.output["classification"]
25 print(f"Classification: {classification}")

Output

1 Classification: 2

Charge Stability Diagram Classifier Input Data — Input Data

Important Notes for Charge Stability Diagram Data

For best results, input dimensions should be (128, 128) - you may need to interpolate/downsample your data.
Each transport current or charge sensor signal value in the input array corresponds to a point in the charge stability diagram for a set of two plunger gate voltages.