Skip to main content

A package for controlling and managing gate voltages in quantum devices.

Project description

Gate Manager

A Python package for controlling and managing gate voltages in quantum devices.

Features

  • Easy Voltage Control Set, ramp, and read gate voltages through simple Python calls.
  • 1D & 2D Sweeps Automate complex voltage sweeps across multiple gates, logging data for analysis.
  • Instrument Agnostic Easily extend or adapt the package to support different hardware backends (e.g., Nanonis, Zurich).
  • Integration & Logging Built-in logging of experimental parameters and sweep data for reproducible research.

Installation

You can install gate-manager using pip:

pip install git+https://github.com/chenx820/gate-manager.git

or

pip install gate-manager

Development Installation

Clone the repository and install in editable mode:

git clone https://github.com/chenx820/gate-manager.git
cd gate-manager
pip install -e .

This way, changes to the source code will immediately be reflected in your environment without reinstallation.

Usage

Below is a quick example showing how you might use the package to perform a simple 1D sweep. This is a high-level illustration; adjust names and parameters to match your hardware setup.

from gate_manager.gate import Gate, GatesGroup
from gate_manager.sweeper import Sweeper

# Suppose you have Gate instances connected to your hardware:
output_gate_1 = Gate(...)
output_gate_2 = Gate(...)
input_gate_1  = Gate(...)

# Group them as needed:
outputs = GatesGroup([output_gate_1, output_gate_2])
inputs  = GatesGroup([input_gate_1])

# Create a Sweeper instance
sweeper = Sweeper(outputs=outputs, inputs=inputs, temperature="CT", device="QuantumDevice1")

# Prepare an initial state for the outputs
initial_state = [
    [output_gate_1, 0.0, 'V'],
    [output_gate_2, 0.0, 'V'],
]

# Perform a 1D sweep from 0 V to 1 V in steps of 10 mV
sweeper.sweep1D(
    swept_outputs=outputs,
    measured_inputs=inputs,
    start_voltage=[0.0, 'V'],
    end_voltage=[1.0, 'V'],
    step=[10, 'mV'],
    initial_state=initial_state,
    comments="MyFirstSweep"
)

Check out the example/ folder to see more advanced usage.

Contributing

Contributions are welcome! Whether you find a bug, have a feature request, or want to add new hardware support, here are a few ways to get involved:

  1. Fork & Clone: Fork the repository, then clone it locally.
  2. Create a Branch: Make a feature or fix branch, e.g. git checkout -b feature/my-new-feature.
  3. Make Changes: Update the code, add tests, and ensure all tests pass.
  4. Open a Pull Request: Submit your PR, describing your changes and why they’re needed.

Please folow PEP 8 style guidelines and ensure that all existing tests pass before submitting a pull request.

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gate_manager-2.3.9.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gate_manager-2.3.9-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file gate_manager-2.3.9.tar.gz.

File metadata

  • Download URL: gate_manager-2.3.9.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for gate_manager-2.3.9.tar.gz
Algorithm Hash digest
SHA256 a4b0461ed696ffb3a64c0b0ef5bfa3c3302ff89ee6a5fde1cd09360f9f34c351
MD5 822ca5d911250b6d16595a87744c5dba
BLAKE2b-256 533d73bef6a9e6b6204b3de81212708fe1313fe98e2c0f566e7a17d7e0d6c19b

See more details on using hashes here.

File details

Details for the file gate_manager-2.3.9-py3-none-any.whl.

File metadata

  • Download URL: gate_manager-2.3.9-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for gate_manager-2.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 3dbdd6aee47323688474baeb6c958a4349bc16effd9d6092bc941cc5e3880197
MD5 72def008a442b05c8ccf0c09bc319afb
BLAKE2b-256 2a1f7c8da537197d72caf2f42fff5c984c51b78903a67e06c851323ef5e54a18

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page