QMix

QMix: A Python package for simulating the quasiparticle tunneling currents in SIS junctions - Published in JOSS (2019)

https://github.com/garrettj403/qmix

Science Score: 95.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 14 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: ieee.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

physics python radio-astronomy simulation sis-mixer

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation

Repository

Simulate the behavior of SIS junctions

Basic Info
Statistics
  • Stars: 9
  • Watchers: 5
  • Forks: 3
  • Open Issues: 2
  • Releases: 7
Topics
physics python radio-astronomy simulation sis-mixer
Created over 7 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License

README.md

QMix

Quantum Mixing software

PyPI version ci flake8 License: GPL v3

QMix is used to simulate the quasiparticle tunneling currents in Superconductor/Insulator/Superconductor (SIS) junctions. In radio astronomy, these junctions are used for heterodyne mixing at millimeter and submillimeter wavelengths. QMix can be used to simulate the behavior of SIS mixers, optimize their performance and analyze experimental data.

In order to calculate the quasiparticle tunneling currents, QMix uses multi-tone spectral domain analysis (see references). Among other applications, this makes QMix ideal for simulating power saturation, higher-order harmonics, sub-harmonic pumping, harmonic mixing and frequency multiplication.

Website: https://garrettj403.github.io/QMix/

Getting Started

The easiest way to install QMix is using pip:

```bash

for latest release (from PyPI)

python -m pip install QMix

for latest commit (from GitHub)

python -m pip install git+https://github.com/garrettj403/QMix.git ```

Take a look at the QMix website for more information on how to use the QMix package and examples showing how to simulate SIS junctions. If you run into any problems, please create a new issue through the issue tracker with the help wanted or question tag. In your message, make sure to include your operating system, Python version, and package versions for QMix, Numpy, SciPy and Matplotlib.

Contributing to QMix

GitHub issues GitHub commits since latest release

If you would like to contribute to the QMix project, please take a look at the contribution instructions. This document includes information on reporting bugs, requesting new features, creating pull requests and contributing new code.

To get a local copy of QMix running:

```bash

Download QMix

git clone https://github.com/garrettj403/QMix.git QMix cd QMix/

Create a virtual environment using Anaconda

conda env create -f environment.yml conda activate qmix

Install QMix

python -m pip install -e .

Test installation

pytest --verbose --color=yes tests/ ```

Examples

QMix can be used to simulate a wide variety of SIS junction behavior. A simple example is shown below for simulating an SIS mixer at 230 GHz. You can find more examples in the QMix/notebooks/ directory or on the QMix website.

Citing QMix

If you use QMix, please cite the following papers:

DOI1

@article{Qmix1,
  author       = {J. D. Garrett and G. Yassin},
  title        = {{QMix: A Python package for simulating the quasiparticle tunneling currents in SIS junctions}},
  publisher    = {Journal of Open Source Software},
  month        = mar,
  year         = 2019,
  volume       = 4,
  number       = 35,
  pages        = 1231,
  doi          = {10.21105/joss.01231},
  url          = {https://doi.org/10.21105/joss.01231},
}

DOI2

@article{Qmix2,
  author       = {J. D. Garrett and B.-K. Tan and F. Boussaha and C. Chaumont and G. Yassin},
  title        = {{Simulating the Behavior of a 230-GHz SIS Mixer Using Multitone Spectral Domain Analysis}},
  publisher    = {IEEE Transactions on Terahertz Science and Technology},
  month        = nov,
  year         = 2019,
  volume       = 9,
  number       = 6,
  pages        = {540--548},
  doi          = {10.1109/TTHZ.2019.2938993},
  url          = {https://ieeexplore.ieee.org/document/8822760/},
}

You can also cite a specific version of QMix by citing the appropriate Zenodo archive:

DOI3

@article{Qmix3,
  author       = {J. D. Garrett},
  title        = {{QMix  (v1.0.6)}},
  month        = jul,
  year         = 2020,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.3936263},
  url          = {http://doi.org/10.5281/zenodo.3936263}
}

License

QMix is released under a GNU General Public License, Version 3.

Owner

  • Name: John Garrett
  • Login: garrettj403
  • Kind: user
  • Location: Vancouver, BC

RF engineer

JOSS Publication

QMix: A Python package for simulating the quasiparticle tunneling currents in SIS junctions
Published
March 20, 2019
Volume 4, Issue 35, Page 1231
Authors
John D. Garrett ORCID
University of Oxford
Ghassan Yassin
University of Oxford
Editor
Lorena A Barba ORCID
Tags
SIS mixers radio astronomy superconducting detectors terahertz instrumentation

GitHub Events

Total
  • Issues event: 2
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 5
  • Fork event: 1
Last Year
  • Issues event: 2
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 5
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 299
  • Total Committers: 2
  • Avg Commits per committer: 149.5
  • Development Distribution Score (DDS): 0.12
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
John Garrett j****t@a****k 263
John Garrett g****3@g****m 36
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 7
  • Total pull requests: 0
  • Average time to close issues: 3 days
  • Average time to close pull requests: N/A
  • Total issue authors: 5
  • Total pull request authors: 0
  • Average comments per issue: 2.57
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 3 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • PaulKGrimes (2)
  • Chesire-W (2)
  • matthewBeckIBM (1)
  • NGC2023 (1)
  • dliupmo (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 24 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 1
pypi.org: qmix

Simulate SIS mixer operation

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 24 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 19.2%
Average: 21.4%
Dependent repos count: 21.6%
Stargazers count: 25.1%
Downloads: 31.1%
Maintainers (1)
Last synced: 4 months ago

Dependencies

environment.yml pypi
  • nbsphinx *
  • tornado ==4.5.3
requirements.txt pypi
  • matplotlib *
  • numba *
  • numpy *
  • scipy *
setup.py pypi
  • matplotlib *
  • numba *
  • numpy *
  • scipy *