API Reference

This page provides an auto-generated reference of all DAMARIS classes, functions, and modules. It is built from docstrings using Sphinx autodoc and autosummary.

Data Module

The data module contains result types, data handling, and signal processing classes.

`damaris.data.ADC_Result`([x, y, index, ...])
`damaris.data.Accumulation`([x, y, y_2, n, ...])	Represents an accumulation of sampled data with various attributes and methods for data manipulation, analysis, and exporting.
`damaris.data.Config_Result`([config, desc, ...])
`damaris.data.DamarisFFT`
`damaris.data.DataPool`()	dictionary with sending change events
`damaris.data.Drawable`
`damaris.data.Errorable`
`damaris.data.Error_Result`([error_msg, desc, ...])	Specialised class of Resultable Contains error-messages from the core
`damaris.data.FitResult`(x, y[, title, ...])	plottable fit curve belonging to a MeasurementResult
`damaris.data.MeasurementResult`(quantity_name)
`damaris.data.Persistance`
`damaris.data.Resultable`
`damaris.data.Signalpath`
`damaris.data.Temperature`
`damaris.data.autophase`

Experiments Module

The experiments module contains the Experiment class and related utilities for defining pulse sequences.

`damaris.experiments.Experiment`([gating, ...])	Class holding the complete state tree for a single experiment.
`damaris.experiments.DurationEstimator`
`damaris.experiments.dac`	This module holds everything connected with the DAC and PFG

GUI Module

The GUI module contains the graphical interface, backend driver, and experiment/result handling.

`damaris.gui.BackendDriver`	This class handles the backend driver
`damaris.gui.ExperimentHandling`
`damaris.gui.ExperimentWriter`
`damaris.gui.ResultHandling`
`damaris.gui.ResultReader`
`damaris.gui.TemperatureMonitor`	Temperature monitoring thread.
`damaris.gui.logging_utils`	Unified logging for DAMARIS.

A short usage example for the font helper of the GUI module (the non-deprecated replacement for the removed Widget.modify_font()):

from damaris.gui.DamarisGUI import apply_font_css

apply_font_css(textview, "Monospace 10")   # pango style font description
apply_font_css(label, "sans bold 16")

The font string is converted into a CSS rule (font-family/font-size/ font-weight) which is applied to the widget’s style context with a Gtk.CssProvider.

Tools Module

The tools module contains hardware driver interfaces and utility functions.

`damaris.tools.ranges`
`damaris.tools.signal`
`damaris.tools.temperature`	Temperature controller interface and base classes.
`damaris.tools.temperature_simulator`	Simulated temperature controller for testing.