Skip to main content

Dataset management and measurement library for scientific data

Project description

qdrive

Dataset management and measurement library for the qHarbor data platform.

qdrive is the Python interface for creating, managing, and syncing scientific datasets with qHarbor.

Features

  • 📦 Create & manage datasets — Store measurements with rich metadata (tags, attributes, descriptions)
  • 📁 Multi-file support with versioning — Attach xarray, NumPy, JSON, HDF5 or any file, with automatic version tracking
  • 🔍 Powerful search — Filter datasets by attributes, date range, tags, or text
  • ☁️ Cloud sync — Automatic synchronization via the sync agent
  • 📊 Measurement tools — Built-in do0D, do1D, do2D sweep functions using native qHarbor format, compatible with QCoDeS parameters

Installation

pip install qdrive

To install the background services (syncs your data to qHarbor automatically):

etiket-services install

Other useful commands (though the service is managed automatically in the background):

etiket-services status      # Check service status
etiket-services start       # Start services
etiket-services stop        # Stop services
etiket-services restart     # Restart services
etiket-services update      # Update packages
etiket-services update --no-backends  # Update core packages only
etiket-services uninstall   # Remove services

For programmatic control of the sync agent (managing sync sources, viewing sync status, debugging), see the etiket-sdk package. You can also manage the services through the DataQruiser desktop application.

Quick Start

Authentication

import qdrive.authenticate as qauth

# See available institutions and login methods
qauth.print_login_methods()

# Log in with SSO (opens browser)
qauth.log_in_with_sso("MyInstitution")

# Check if logged in
qauth.is_logged_in()  # Returns True/False

# Log out
qauth.logout()

Scopes

from qdrive.scopes import get_scopes, set_default_scope

# List available scopes
get_scopes()

# Set default scope (by name or UUID)
set_default_scope("MyScope")

Create a dataset

from qdrive import dataset

ds = dataset.create(
    'Qubit T2* measurement',
    tags=['calibration'],
    attributes={'sample': 'Q7-R3', 'fridge': 'BlueFors-1'}
)

Add files to a dataset

import numpy as np
import xarray as xr

# Add various file types
ds['config.json'] = {'param1': 42, 'param2': 'value'}
ds['raw_data.npz'] = np.random.rand(100, 100)
ds['measurement.hdf5'] = xr.Dataset({'signal': (['time'], np.sin(np.linspace(0, 10, 100)))})
ds['script.py'] = __file__  # Attach the current script

Retrieve and access data

from qdrive import dataset

ds = dataset('59c40af3-cef3-49aa-8747-64707a9b080a')  # Load by UUID

# Access files in multiple formats
xr_data = ds['measurement.hdf5'].xarray
json_data = ds['config.json'].json

Search datasets

from qdrive.dataset.search import search_datasets

results = search_datasets(
    search_query='T2*',
    attributes={'sample': 'Q7-R3'},
    ranking=1
)

for ds in results:
    print(ds.name, ds.uuid)

Documentation

License

Proprietary — © 2026 QHarbor B.V. All Rights Reserved.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

qdrive-0.3.0b1-py3-none-any.whl (58.4 kB view details)

Uploaded Python 3

File details

Details for the file qdrive-0.3.0b1-py3-none-any.whl.

File metadata

  • Download URL: qdrive-0.3.0b1-py3-none-any.whl
  • Upload date:
  • Size: 58.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.12

File hashes

Hashes for qdrive-0.3.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 a669a57305b9e2e9c1414474314433261cecd7f43679fc5fd8cb859c0279e0ea
MD5 cffda18dc34e7cc97e59758bcb24f6a3
BLAKE2b-256 703e0540cef0924f246932bead2ed6b3e278e3a9286d05cb5459dd1b2fd9f35f

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