Data

Tools

Indexes

Applications

Experiments

Open Source Science

rydiqule

Rydberg Sensor Interactive Quantum Physics Module

https://github.com/qtc-umd/rydiqule

Science Score: 75.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 6 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization qtc-umd has institutional domain (qtc.umd.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.6%) to scientific vocabulary

Keywords

atomic-physics atomic-sensors electrometry quantum-optics rydberg
Last synced: 6 months ago · JSON representation ·

Repository

Rydberg Sensor Interactive Quantum Physics Module

Basic Info
Statistics
  • Stars: 22
  • Watchers: 2
  • Forks: 7
  • Open Issues: 10
  • Releases: 10
Topics
atomic-physics atomic-sensors electrometry quantum-optics rydberg
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

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 status

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 david.h.meyer3.civ@army.mil or kevin.c.cox29.civ@army.mil

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.

Owner

  • Name: Quantum Technology Center
  • Login: QTC-UMD
  • Kind: organization
  • Location: United States of America

Software developed by members of the University of Maryland's Quantum Technology Center

JOSS Publication

RydIQule Version 2: Enhancing graph-based modeling of Rydberg atoms
Published
February 11, 2026
DOI
Volume 11, Issue 118, Page 8539
Authors
Benjamin N. Miller ORCID
DEVCOM Army Research Laboratory, 2800 Powder Mill Rd, Adelphi, MD, 20783, United States of America
David H. Meyer ORCID
DEVCOM Army Research Laboratory, 2800 Powder Mill Rd, Adelphi, MD, 20783, United States of America
Carter A. Montag ORCID
Program in Applied Mathematics, University of Arizona, 1200 E University Blvd, Tuscon, AZ 85721, United States of America
Omar Nagib ORCID
Department of Physics, University of Wisconsin-Madison, 1150 University Avenue, Madison, WI, 53706, United States of America
Teemu Virtanen ORCID
Naval Air Warfare Center, 1 Administration Circle, China Lake, CA, 93555, United States of America
Peter K. Elgee ORCID
DEVCOM Army Research Laboratory, 2800 Powder Mill Rd, Adelphi, MD, 20783, United States of America
Kevin C. Cox ORCID
DEVCOM Army Research Laboratory, 2800 Powder Mill Rd, Adelphi, MD, 20783, United States of America
Editor
Sophie Beck ORCID
Tags
Rydberg Atomic Physics Quantum Sensing Quantum Graph
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it using the preferred article citation.
title: RydIQule
abstract: >-
  The Rydberg Interactive Quantum module is a modeling library designed to simulate the response of Rydberg atoms to arbitrary input RF waveforms.
  It functions as a general master equation solver for quantum systems based on the semi-classical density matrix method.
authors:
  - family-names: Miller
    given-names: Benjamin N
    orcid: 'https://orcid.org/0000-0003-0017-1355'
  - family-names: Meyer
    given-names: David H
    orcid: 'https://orcid.org/0000-0003-2452-2017'
  - family-names: Virtanen
    given-names: Teemu
  - family-names: O'Brien
    given-names: Christopher M
    orcid: 'https://orcid.org/0000-0003-2974-0531'
  - family-names: Cox
    given-names: Kevin C
    orcid: 'https://orcid.org/0000-0001-5049-3999'

version: 1.1.0
date-released: "2023-10-11"
license: Apache-2.0
repository-code: "https://github.com/QTC-UMD/rydiqule"
url: "https://doi.org/10.1016/j.cpc.2023.108952"

identifiers:
  - description: Journal article describing the software
    doi: 10.1016/j.cpc.2023.108952

preferred-citation:
  type: article
  title: "RydIQule: A Graph-based paradigm for modeling Rydberg and atomic sensors"
  authors:
    - family-names: Miller
      given-names: Benjamin N
    - family-names: Meyer
      given-names: David H
      orcid: 'https://orcid.org/0000-0003-2452-2017'
    - family-names: Virtanen
      given-names: Teemu
    - family-names: O'Brien
      given-names: Christopher M
    - family-names: Cox
      given-names: Kevin C
  doi: "10.1016/j.cpc.2023.108952"
  journal: "Computer Physics Communications"
  month: 1
  year: 2024
  start: 108952 # page number
  issue: 294

references:
  - type: software
    title: ARC (Alkali.ne Rydberg Calculator)
    authors:
      - family-names: Šibalić
        given-names: Nikola
    repository-code: "https://github.com/nikolasibalic"
    url: "http://arc-alkali-rydberg-calculator.readthedocs.io/"
  - type: software
    title: NetworkX
    repository-code: "https://github.com/networkx/networkx"
    url: "https://networkx.org"
  - type: software
    title: NumPy
    repository-code: "https://github.com/numpy/numpy"
    url: "https://numpy.org"
  - type: software
    title: SciPy
    repository-code: "https://github.com/scipy/scipy"
    url: "https://scipy.org"
  - type: software
    title: numbakit-ode
    authors:
      - family-names: Grecco
        given-names: Hernan E
    repository-code: "https://github.com/hgrecco/numbakit-ode"
    url: "https://numbakit-ode.readthedocs.io/en/latest/index.html"
  - type: software
    title: CyRK
    authors:
      - family-names: Renaud
        given-names: Joe P
    repository-code: "https://github.com/jrenaud90/CyRK"
  - type: software
    title: leveldiagram
    authors:
      - family-names: Meyer
        given-names: David H
    repository-code: "https://github.com/dihm/leveldiagram"
    url: "https://leveldiagram.readthedocs.io/en/latest"

GitHub Events

Total
  • Create event: 17
  • Release event: 4
  • Issues event: 9
  • Watch event: 7
  • Delete event: 7
  • Member event: 1
  • Issue comment event: 17
  • Push event: 47
  • Pull request review comment event: 10
  • Pull request review event: 10
  • Pull request event: 18
  • Fork event: 4
Last Year
  • Create event: 17
  • Release event: 4
  • Issues event: 9
  • Watch event: 7
  • Delete event: 7
  • Member event: 1
  • Issue comment event: 17
  • Push event: 47
  • Pull request review comment event: 10
  • Pull request review event: 10
  • Pull request event: 18
  • Fork event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 12
  • Average time to close issues: 10 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 2.5
  • Average comments per pull request: 0.75
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 12
  • Average time to close issues: 1 day
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.75
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • john-guthrie (1)
  • jun-nan-wang (1)
  • JaySardesai444 (1)
  • petermao (1)
  • evgmik (1)
Pull Request Authors
  • dihm (8)
  • camontag (4)
  • Json-To-String (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
enhancement (2) bug (1) documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 127 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 10
  • Total maintainers: 1
pypi.org: rydiqule

Rydberg Sensor Interactive Quantum Physics Module

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 127 Last month
Rankings
Dependent packages count: 7.3%
Average: 24.2%
Dependent repos count: 41.1%
Maintainers (1)
dihm
Last synced: 6 months ago