Skip to content

QTC-UMD/rydiqule

Repository files navigation

rydiqule

The Rydberg Interactive Quantum module is a modeling library designed to simulate the response of Rydberg atoms to arbitrary input RF waveforms. It also functions as a general master equation solver based on the semi-classical density matrix method.

PyPI Conda Version Python Version License Docs DOI

Please cite as

B. N Miller, D. H. Meyer, T. Virtanen, C. M O'Brien, and K. C. Cox, RydIQule: A Graph-based paradigm for modeling Rydberg and atomic sensors, Computer Physics Communications, 294, 108952 (2024) https://doi.org/10.1016/j.cpc.2023.108952

Installation

Installation can be done via pip or conda. See the documentation for details.

Documentation

Documentation is available online at readthedocs. PDF or EPUB formats of the documentation can be downloaded from the online documentation.

Examples

Example jupyter notebooks that demonstrate RydIQule can be found in the documentation, with back-links to download them directly from the github repository.

Support

Creation of this software was supported in part by the Defense Advanced Research Projects Agency (DARPA) Quantum Apertures program, DEVCOM Army Research Laboratory, and the Quantum Technology Center at the University of Maryland.

Disclaimer

The views, opinions and/or findings expressed are those of the authors and should not be interpreted as representing the official views or policies of the Department of Defense or the U.S. Government.

Contact

This github repository is primarily for code distribution. While we monitor it, responses to issues or pull requests posted to it may be limited. If you would like a more detailed response from the developers, please e-mail [email protected] or [email protected]

Contributing

We actively encourage contributions and collaboration in the development of rydiqule. Unforunately, rydiqule's development is done privately, for reasons. If you would like to submit a PR for all but the most trivial of changes, please e-mail us directly so we can discuss the collaboration.