Connectors

A connector defines how to detect and read datasets from a particular data format or acquisition system. We provide pre-built connectors for several common data-acquisition frameworks (see below); if yours isn't listed, you can create your own.

Available connectors

Connector	Reads from	Type
QUAlibrate	A QUAlibrate calibration-data directory	File-based
FolderBase	Folders you mark as datasets with an info file	File-based
QCoDeS	A QCoDeS SQLite database	Database
Quantify	A Quantify data directory	File-based
Labber	Labber .hdf5 log files	File-based
Core Tools	A Core Tools PostgreSQL database	Database

Each connector page lists its package, configuration parameters, a ready-to-run create example, and any connector-specific behavior.

Installing a connector

FolderBase is available out of the box. The other connectors are separate packages that must be installed into the sync agent's environment before you can use them.

The easiest way is from the DataQruiser app: open Sync Settings → Connectors and click Install next to the connector in the Available list.

From Python, install through the SDK, which installs the package into the correct environment and makes the agent pick it up:

from etiket_sdk.sync import Connectors

# Install a connector from PyPI
Connectors.install_from_pypi("etiket_sync_agent_qcodes")

# ...or from a local path (e.g. a connector someone shared with you)
Connectors.install_from_local("/path/to/etiket-sync-agent-some-connector")

# See what is installed
print(Connectors.list())

# Update or remove
Connectors.update_from_pypi("etiket_sync_agent_qcodes")
Connectors.uninstall("etiket_sync_agent_qcodes")

Note

A connector's identifier (e.g. etiket_sync_agent_qcodes) is just the Python package name of the connector — the same name you pass to SyncSources.create(...). List the identifiers of installed connectors with SyncSources.connectors().