We recommend using pip, poetry, or uv to install the package.
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:
Or provide the API key directly:
The Coulomb Diamond Segmenter is a binary segmentation model that segments a given conductance measurement grid into coulomb diamond regions.
You can download an example file to follow along with the example:

Coulomb Diamond Segmenter v0 Input Data. (Data Source: Lennon, D., et al. Real measurement of Coulomb diamonds. 2019. Zenodo, https://doi.org/10.5281/zenodo.2559478.)

The Coulomb Diamond Detector v0 is a model that detects Coulomb Diamond structures from a binary segmentation mask.
You can download an example file to follow along with the example:
The four diamond keys “left”, “right”, “bottom” and “top” correspond to each vertex of the detected Coulomb diamond.
Use the following script to visualize detected coulomb diamonds from the v0 model.

The Coulomb Diamond Detector can detect multiple coulomb diamonds. Download the following example to try it.

The Coulomb Diamond Detector v1 is a single-stage model that detects Coulomb diamond structures directly from raw conductance data. Unlike the v0 workflow that requires first segmenting the data with the Segmenter, the v1 Detector can be used standalone for end-to-end diamond detection.
You can download an example file to follow along with the example:
Use the following script to visualize detected coulomb diamonds from the v1 model.

Coulomb Diamond Detector v1 Output. (Data Source: Lennon, D., et al. Efficiently measuring a quantum device using machine learning. 2019. Zenodo, https://doi.org/10.5281/zenodo.2559478.)
The Coulomb Diamond Detector v2 detects Coulomb diamond structures directly from current measurement data and returns the vertices of each detected diamond. Unlike v0 which requires a segmentation mask as input, v2 works directly on raw 2D current measurement grids.
Use the Coulomb Diamond Detector v2 when you have:
This model is a single-step solution - no prior segmentation is required.
You can download an example file to follow along with the example:
Use the following script to visualize detected coulomb diamonds from the v2 model.

Coulomb Diamond Detector v2 Output. (Data Source: Lennon, D., et al. Efficiently measuring a quantum device using machine learning. 2019. Zenodo, https://doi.org/10.5281/zenodo.2559478.)
diamond_vertices with left, top, right, bottom keys) as v0 and v1, so it can replace previous versions without changing downstream code.