Welcome to python_spectrometer’s documentation!#
The python_spectrometer package for noise spectroscopy#
The python_spectrometer package implements data acquisition, processing, and visualization for estimating noise power spectral densities (PSDs) using Welch’s method.
In principle, estimating the noise PSD given a set of time series data is far from hard – just plug it into scipy.signal.welch()! Moreover, you might even have some dedicated hardware sitting around that already does it for you, an oscilloscope or a Zurich Instruments MFLI, say, and we could just connect it to the noisy system in question and start characterizing.
In practice, however, the former option leaves us with the task of actually acquiring the time series data. How exactly to do this will depend heavily on the data acquisition (DAQ) instrument currently connected to the setup and thus require writing additional glue code each time this device changes. The latter option is convenient for a quick look because data acquisition and processing are already built into the DAQ instrument. Yet here data management is cumbersome, and persisting the data, as well as possibly annotating it with metadata about the current state of the system, require, again, writing additional glue code. Lastly, the DAQ is typically part of the measurement setup, and hence contributes to its noise characteristics. Replacing it with a dedicated instrument such as a scope just to perform noise spectroscopy is hence not ideal.
The python_spectrometer package aims to address these shortcomings by implementing a single and consistent interface for Fourier-transform noise spectroscopy. First, it is DAQ-backend-agnostic, providing wrappers around several instrument drivers, making replacing an instrument as simple as replacing the driver in one line of code. Next, it is flexible, allowing users to perform arbitrary processing in both the time and frequency domain, and human-centered, allowing users to specify the parameters of the resulting PSD (such as frequency resolution) rather than the more opaque properties of the raw time series data. Finally, it automatically saves data (including any metadata) to disk, allows recalling previous data or sessions, and visualizes the data in a dynamic plot that can show, for example, the cumulative RMS
with \(S_x(f)\) the PSD of the signal \(x(t)\), which gives insight into the relative contributions of broadband and monochromatic (\(50\,\mathrm{Hz}\), e.g.) noise.
To demonstrate the basic features, here is some example code using the Keysight DMM qcodes driver for data acquisition. For a more detailed walkthrough, see the notebook script in doc/walkthroughs. For theoretical background as well as a didactic introduction to the software package, see this thesis excerpt.
from python_spectrometer import Spectrometer, daq
from qcodes.instrument_drivers.Keysight.Keysight_34465A_submodules import Keysight_34465A
dmm = Keysight_34465A('dmm', 'some_tcpip_address')
# The Spectrometer object is the only one you'll ever need to talk to
spect = Spectrometer(daq.qcodes.Keysight344xxA(dmm),
procfn=lambda v: v*1000, # Convert voltage to millivolts, say
processed_unit='mV')
settings = {'f_min': 0.1, 'f_max': 1000, 'phase_of_the': 'moon'} # any other settings or metadata
# Acquire a spectrum with 5 outer averages. Automatically opens the plot window
spect.take('a comment', n_avg=5, **settings)
# Hide it from the plot
spect.hide(0)
# Show it again
spect.show('a comment') # same as spect.show(0)
# Plot the cumulative RMS
spect.plot_cumulative = True
# Save and recall functionality
spect.serialize_to_disk('./foo')
spect_loaded = Spectrometer.recall_from_disk('./foo') # read-only because no DAQ given
spect_loaded.show_keys()
# (0, 'a comment')
You can also play around with simulated noise (requires qopt):
from python_spectrometer import Spectrometer, daq
spect = Spectrometer(daq.simulator.QoptColoredNoise(lambda f, A, **_: A/f))
spect.take('foobar', n_avg=10, n_seg=5, A=42)
Leveraging qutil.plotting.live_view, the package also allows continuous acquisition and plotting of data:
spect = Spectrometer(some_daq, plot_timetrace=True)
freq_live_view, time_live_view = spect.live_view(fs=100e3)
This opens two figures which continuously update as new data is acquired in a background thread.
In this mode, data can be captured by pressing 'c' while the figure is active, or by calling
spect.new_live_capture().
Snapshots can be annotated with spect.annotate_last_live_capture() and loaded into the main plot using spect.add_live_captures().
Installing#
If you just want to use it you can install the latest “released” version via
python -m pip install python-spectrometer[complete]
However, this package profits from everybody’s work and the releases are infrequent. Please make a development install and contribute your changes. You can do this via
python -m pip install -e git+https://git.rwth-aachen.de/qutech/python-spectrometer.git#egg=python-spectrometer[complete]
This will download the source code (i.e. clone the git repository) into a subdirectory of the ./src argument and link the files into your environment instead of copying them. If you are on Windows you can use SourceTree which is a nice GUI for git.
You can specify the source code directory with the --src argument (which needs to be BEFORE -e):
python -m pip install --src some_directory/my_python_source -e git+https://git.rwth-aachen.de/qutech/python-spectrometer.git#egg=python-spectrometer[complete]
If you have already downloaded/cloned the package yourself you can use python -m pip install -e .[complete].
Please file an issue if any of these instructions does not work.
Documentation#
Some of the development of this package took place during a course taught at the II. Institute of Physics at RWTH Aachen University in the winter semester 2022/23. Targeting applied research topics too specific for lectures but too general for lab courses, several modules intended for self-learning were developed, one of which focuses on “characterizing and avoiding noise and interference in instrumentation”. The material can be found here:
For a didactic introduction to Fourier-transform noise spectroscopy as well as the design and workflow of this package refer to this thesis excerpt, or read it online here.
For a walkthrough of the main features and interaction with the tool, see the doc/walkthroughs directory. The python_spectrometer package has an auto-generated documentation that can be found at the Gitlab Pages.
To build the documentation locally, navigate to doc/ and run
make html
or
sphinx-build -b html source build
Make sure the dependencies are installed via
python -m pip install -e .[doc]
in the top-level directory.
To check if everything works for a clean install (requires hatch to be installed), run
python -m hatch run doc:build
Tests#
There are some basic tests in tests/ as well as a couple of doctests.
You can run the tests either via
python -m pytest --doctest-modules
or to check if everything works for a clean install (requires hatch to be installed)
python -m hatch run tests:run
Docker#
Make sure docker is installed and running:
pamac install docker docker-buildx(sudo) docker buildx install(sudo) systemctl status dockerExample output:
● docker.service - Docker Application Container Engine Loaded: loaded (/usr/lib/systemd/system/docker.service; disabled; preset: disabled) Active: active (running) since Tue 2025-02-11 20:09:55 CET; 1 week 1 day ago Invocation: 609d5a409daf4e99b7b3b8da9305776d TriggeredBy: ● docker.socket Docs: https://docs.docker.com Main PID: 54128 (dockerd) Tasks: 22 Memory: 38.8M (peak: 1.2G, swap: 21.3M, swap peak: 23.9M) CPU: 1min 2.133s CGroup: /system.slice/docker.service └─54128 /usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock
Build the docker image:
(sudo) docker build -t pyspeck-dev .
Run the image…
… either running the tests and exiting:
(sudo) docker run --rm pyspeck-dev
… or entering an interactive console:
(sudo) docker run --rm -it pyspeck-dev /bin/bash
Releases#
Releases on Gitlab, PyPI, and Zenodo are automatically created and pushed whenever a commit is tagged matching CalVer in the form vYYYY.MM.MICRO or vYYYY.0M.MICRO.
Excerpt from Tobias Hangleiter’s PhD Thesis#
python_spectrometer API Documentation#
This module provides the |