Modern instrumentation development often involves the incorporation of many dissimilar hardware peripherals into a single unified instrument. The increasing availability of modular hardware has brought greater instrument complexity to small research groups. This complexity stretches the capability of traditional, monolithic orchestration software. In many cases, a lack of software flexibility leads creative researchers to feel frustrated, unable to perform experiments they envision. Herein, we describe Yet Another acQuisition (yaq), a software project defining a new standardized way of communicating with diverse hardware peripherals. yaq encourages a highly modular approach to experimental software development that is well suited to address the experimental flexibility needs of complex instruments. yaq is designed to overcome hardware communication barriers that challenge typical experimental software. A large number of hardware peripherals are already supported, with tooling available to expand support. The yaq standard enables collaboration among multiple research groups, increasing code quality while lowering development effort.
REFERENCES
1.
See https://www.ni.com/en-us/support/documentation/supplemental/06/getting-started-with-ni-daqmx–main-page.html for Getting started with NI-DAQmx; accessed: 02 October 2022,
2022
.2.
Standard Commands for Programmable Instruments (SCPI), SCPI Consortium,
1999
.3.
MODBUS Application Protocol Specification, Modbus,
2012
.4.
PICam 5.x Programmer’s Manual, Teledyne Princeton Instruments,
2021
.5.
Thorlabs Motion Controllers Host-Controller Communications Protocol, Thorlabs,
2022
.6.
L. R.
Dalesio
, M. R.
Kraimer
, and A. J.
Kozubal
, “EPICS architecture
,” in ICALEPCS
(1991
), Vol. 91.7.
J.-M.
Chaize
, A.
Götz
, J.
Meyer
, M.
Pérez
, and E.
Taurel
, “TANGO—An object oriented control system based on CORBA
,” in ICALEPCS
, 1999
.8.
S. J.
Weber
, “PyMoDAQ: An open-source python-based software for modular data acquisition
,” Rev. Sci. Instrum.
92
, 045104
(2021
).9.
N.
Bogdanowicz
, C.
Rogers
, S.
Weber
, Zakv
, S.
Pelissier
, J.
Wheeler
, Cxz
, F.
Marazzi
, Eedm
, and I.
Galinskiy
, (2022
) “Instrumental: A python-based library for controlling lab hardware
,” Zenodo. https://doi.org/10.5281/zenodo.659176410.
P.
Tapping
, “TRSpectrometer documentation
,” https://trspectrometer.readthedocs.io/; accessed 02 October 2022, 2021
.11.
L.
Koerner
, “Instrbuilder: A Python package for electrical instrument control
,” J. Open Source Softw.
4
, 1172
(2019
).12.
L.
Campagnola
, M. B.
Kratz
, and P. B.
Manis
, “ACQ4: An open-source software platform for data acquisition and analysis in neurophysiology research
,” Front. Neuroinform.
8
, 3
(2014
).13.
See https://pymeasure.readthedocs.io/ for PyMeasure; accessed: 02 October 2022,
2022
.14.
G.
Giesbrecht
, A.
Amsellem
, T.
Bauer
, B.
Mak
, B.
Wynne
, Z.
Qin
, and A.
Persaud
, “Hardware-control: Instrument control and automation package
,” J. Open Source Softw.
7
, 2688
(2022
).15.
16.
The yaq protocol is fully specified by the set of accepted yaq Enhancement Proposals at https://yeps.yaq.fyi/.
17.
18.
See https://avro.apache.org/docs/1.11.1/specification/ for Apache avro specification; accessed: 02 October 2022,
2022
.19.
J.
Segal
, “When software engineers met research scientists: A case study
,” Empir. Softw. Eng.
10
, 517
–536
(2005
).20.
yaqc available on PyPI at https://pypi.org/project/yaqc/.
21.
yaqc-qtpy available on PyPI at https://pypi.org/project/yaqc-qtpy/.
22.
D.
Allan
, T.
Caswell
, S.
Campbell
, and M.
Rakitin
, “Bluesky’s ahead: A multi-facility collaboration for an a la carte software project for data acquisition and management
,” Synchrotron Radiat. News
32
, 19
–22
(2019
).23.
yaqc-bluesky available on PyPI at https://pypi.org/project/yaqc-bluesky/.
24.
S.
Mukamel
, “Multidimensional femtosecond correlation spectroscopies of electronic and vibrational excitations
,” Annu. Rev. Phys. Chem.
51
, 691
–729
(2000
).25.
J. C.
Wright
, “Multiresonant coherent multidimensional spectroscopy
,” Annu. Rev. Phys. Chem.
62
, 209
–230
(2011
).26.
R. J.
Carlson
, “Quantitative aspects of high resolution, fully resonant, four-wave mixing spectroscopy for the analysis of vibronic mode coupling in molecules
,” Ph.D. thesis, University of Wisconsin-Madison
, 1988
.27.
K. A.
Meyer
, “Frequency-scanned ultrafast spectroscopic techniques applied to infrared four-wave mixing spectroscopy
,” Ph.D. thesis, University of Wisconsin–Madison
, 2004
.28.
S.
Kain
, “Transition of frequency-domain coherent multidimensional spectroscopic methods to the femtosecond time regime with applications to nanoscale semiconductors
,” Ph.D. thesis, University of Wisconsin-Madison
, 2017
.29.
B. J.
Thompson
, “Development of frequency domain multidimensional spectroscopy with applications in semiconductor photophysics
,” Ph.D. thesis, University of Wisconsin–Madison
, 2018
.30.
K. F.
Sunden
, “yaq: Yet Another Acquisition a modular approach to spectroscopy software and instrumentation
,” Ph.D. thesis, University of Wisconsin–Madison
, 2022
.31.
yaqd-core-python available on PyPI at https://pypi.org/project/yaqd-core.
32.
yaq-traits available on PyPI at https://pypi.org/project/yaq-traits.
33.
yaqd-brooks-mfc-gf source code available on GitHub at https://github.com/yaq-project/yaqd-brooks/.
34.
See https://pypi.org/project/pyserial for PySerial; accessed: 02 October 2022.
35.
See https://pypi.org/project/pyusb for PyUSB; accessed: 06 November 2022.
36.
See https://pypi.org/project/pyvisa for PyVISA; accessed: 06 November 2022.
37.
See https://pypi.org/project/pymodbus for PyModbus; accessed: 06 November 2022.
38.
See https://yaq.fyi/daemons/ and https://yaq.fyi/hardware/ for living lists of all yaq daemons and supported hardware, respectively.
39.
C. A.
Salazar
, B. J.
Thompson
, S. M. M.
Knapp
, S. R.
Myers
, and S. S.
Stahl
, “Multichannel gas-uptake/evolution reactor for monitoring liquid-phase chemical reactions
,” Rev. Sci. Instrum.
92
, 044103
(2021
).40.
E.
Allman
, “Managing technical debt
,” Commun. ACM
55
, 50
–55
(2012
).41.
yaqd-fakes available on PyPI at https://pypi.org/project/yaqd-fakes/.
42.
J.
Segal
, “Some problems of professional end user developers
,” in IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC 2007)
(IEEE
, 2007
).43.
J.
Cohen
, D. S.
Katz
, M.
Barker
, N.
Chue Hong
, R.
Haines
, and C.
Jay
, “The four pillars of research software engineering
,” IEEE Softw.
38
, 97
–105
(2021
).44.
A.
Nowogrodzki
, “How to support open-source software and stay sane
,” Nature
571
, 133
–134
(2019
).© 2023 Author(s). Published under an exclusive license by AIP Publishing.
2023
Author(s)
You do not currently have access to this content.
