ql

Top level module from which all Qililab basic functions and classes can be directly imported.

Functions

about()	Prints the information for Qililab installation.
build_platform(runcard[, new_drivers])	Builds a Platform object, given a runcard.
deserialize(string[, cls])	Deserialize a YAML string to an object.
deserialize_from(file[, cls])	Deserialize a YAML file to an object.
get_db_manager([path, database_name])	Automatic DatabaseManager generator based on default load_config
get_settings()	Returns a singleton instance of QililabSettings.
load_by_id(id[, path])	Function to get the database ID without loading the Database Manager
load_results(path)	Load results from the given path to an .h5 file.
save_platform(path, platform)	Serialize and save the given platform to the specified path.
save_results(results, loops, data_path[, name])	Save the given results and the platform.
serialize(obj)	Serialize an object to a YAML string.
serialize_to(obj, file)	Serialize an object to a YAML file.
stream_results(shape, path, loops)	Constructs a StreamArray instance.

Classes

AnnealingProgram(flux_to_bus_topology, ...)	Class for an Annealing Program.
Arbitrary(samples)	Arbitrary waveform.
Calibration()	A class to manage calibration data.
Chained(waveforms)	Represents a composite waveform consisting of multiple waveforms played in a chained sequence.
Cooldown(cooldown, date, fridge)	Creates and manipulates CoolDown metadata database
CrosstalkMatrix()	A class to represent a crosstalk matrix where each index corresponds to a bus.
DatabaseManager(filename, database_name)	Database manager for measurements results and metadata
Domain(*values)	Domain class.
Experiment(label[, description])	Represents an experiment.
ExperimentResults(path)	Provides methods to access the experiment results stored in an HDF5 file.
FlatTop(amplitude, duration, smooth_duration)	Smoothed square pulse with error function on the edges rise waveform.
Gaussian(amplitude, duration, num_sigmas)	Gaussian waveform with peak at duration/2 and spanning for num_sigmas over the pulse duration.
GaussianDragCorrection(amplitude, duration, ...)	Calculates the first order drag correction of the imaginary (Ey) channel of a drive pulse.
IQDrag(amplitude, duration, num_sigmas, ...)
IQPair(I, Q)	IQPair containing the 'in-phase' (I) and 'quadrature' (Q) parts of a signal.
Measurement(experiment_name, sample_name, ...)	Creates and manipulates Measurement metadata database
Parameter(*values)	Parameter names.
Platform(runcard)	Platform object representing the laboratory setup used to control quantum devices.
QProgram()	QProgram is a hardware-agnostic pulse-level programming interface for describing quantum programs.
QbloxCompiler()	A class for compiling QProgram to QBlox hardware.
QdacCompiler()	A class for controling QProgram to Qdac hardware.
Ramp(from_amplitude, to_amplitude, duration)	Ramp waveform.
Rmw(qubit, *, theta, phase)	Microwave rotation in the equatorial plane (native single-qubit pulse).
Sample(sample_name, fab_run, wafer, sample, ...)	Creates and manipulates Sample metadata database
Square(amplitude, duration)	Square (rectangular) waveform.
SuddenNetZero(amplitude, duration, b, t_phi)	Sudden Net Zero waveform.
Waveform()	Waveforms describes the pulses envelope's shapes.