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:
Both detectors expect a visualization-ready 2D array shaped (n_bias, n_voltage):
This is the same layout you’d pass to imshow() or pcolormesh() - resonator bias on the vertical axis, unload voltage on the horizontal axis.
Coming from acquisition-format data? If your data is stored as (n_voltage, n_bias) - one bias trace per voltage point - transpose before calling the API. This matches the typical visualization convention with unload voltage on the x-axis and resonator bias on the y-axis:
The Electron Unload Detector identifies the column indices in a two-dimensional resonator scan where electron unloading events occur.
Supply your own measurement data to follow along.
To plot with real voltage and frequency values, convert indices to coordinates:
The Electron Unload Texture Detector locates contiguous resonator patterns that frequently co-occur with unloading transitions. Each cluster contains the row/column indices of its member pixels so you can overlay the detections directly on your measurement.
To plot with real voltage and frequency values: