qtics package

Qtics module.

Subpackages

• qtics.instruments package
  • Submodules
  • qtics.instruments.instrument module
    • Instrument
      • Instrument.clear_defaults()
      • Instrument.connect()
      • Instrument.defaults
      • Instrument.disconnect()
      • Instrument.get()
      • Instrument.get_id()
      • Instrument.query()
      • Instrument.read()
      • Instrument.reset()
      • Instrument.set()
      • Instrument.set_defaults()
      • Instrument.update_defaults()
      • Instrument.validate_opt()
      • Instrument.validate_range()
      • Instrument.write()
  • qtics.instruments.network_inst module
    • NetworkInst
      • NetworkInst.connect()
      • NetworkInst.disconnect()
      • NetworkInst.query()
      • NetworkInst.read()
      • NetworkInst.write()
  • qtics.instruments.serial_inst module
    • SerialInst
      • SerialInst.connect()
      • SerialInst.disconnect()
      • SerialInst.query()
      • SerialInst.read()
      • SerialInst.write()

Submodules

qtics.experiment module

Base Experiment classes.

class qtics.experiment.BaseExperiment(name: str, data_file: str | None = None, data_dir: str | None = None)

Bases: ABC

Base experiment class.

add_instrument(inst: Instrument)

Add an instrument with the correct name.

all_instruments(func_name: str, *args, **kwargs)

Apply function to all instruments.

append_data_group(group_name: str, parent_name: str | None = None, datasets: dict | None = None, **attributes)

Save data appending to hdf5 file.

get_datasets_dict(data_file: str | None = None)

Load the datasets of an hdf5 file as dictionary.

abstract main()

Execute main part of the experiment.

run()

Run the experiment.

save_config()

Save experiment’s attributes and instruments defaults.

class qtics.experiment.Experiment(name: str, data_file: str | None = None, data_dir: str | None = None)

Bases: BaseExperiment

Experiment with monitoring functions.

add_monitor(monitor: MonitorExperiment)

Add monitoring experiment.

monitor_failed() → bool

Check if monitoring condition has failed and restore safe values.

run()

Run the experiment with parallel monitoring functions.

class qtics.experiment.MonitorExperiment(name: str, data_file: str | None = None, data_dir: str | None = None)

Bases: BaseExperiment

Base monitoring experiment class.

sleep: float = 5

watch(event: Event)

Run the experiment continuously until event is set.

qtics.logger module

Loggers configuration.

class qtics.logger.CustomHandler

Bases: StreamHandler

Custom handler for logging algorithm. Credits to Qibocal.

format(record)

Format the record with specific format.