Skip to content

Commit

Permalink
Merge pull request #56 from purva-thakre/info_qutip_paper
Browse files Browse the repository at this point in the history
Add info about citing paper
  • Loading branch information
nathanshammah committed Jun 14, 2021
2 parents 7ef0158 + 4e2a613 commit 1603af5
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![build](https://github.com/qutip/qutip-qip/workflows/Tests/badge.svg)](https://github.com/qutip/qutip-qip/actions)
[![Documentation Status](https://readthedocs.org/projects/qutip-qip/badge/?version=latest)](https://qutip-qip.readthedocs.io/en/latest/)
[![PyPI version](https://badge.fury.io/py/qutip-qip.svg)](https://badge.fury.io/py/qutip-qip)
[![arXiv paper](https://img.shields.io/badge/arXiv-2105.09902-<COLOR>.svg)](https://arxiv.org/abs/2105.09902)

The qutip-qip package used to be a module ``qutip.qip`` under [QuTiP (Quantum Toolbox in Python)](http://qutip.org/index.html).
From QuTiP 5.0, the community has decided to decrease the size of the core QuTiP package by reducing the external dependencies, in order to simplify maintenance.
Expand Down Expand Up @@ -66,7 +67,20 @@ To test the installation from a download of the source code, run from the `qutip
```
pytest tests
```

Citing `qutip-qip`
------------
If you use `qutip-qip` in your research, the [*preprint*](https://arxiv.org/abs/2105.09902) can be cited as

```bibtex
@misc{li2021pulselevel,
title={Pulse-level noisy quantum circuits with QuTiP},
author={Boxi Li and Shahnawaz Ahmed and Sidhant Saraogi and Neill Lambert and Franco Nori and Alexander Pitchford and Nathan Shammah},
year={2021},
eprint={2105.09902},
archivePrefix={arXiv},
primaryClass={quant-ph}
}
```
Support
-------
This package is supported and maintained by the same developers group as QuTiP.
Expand Down
24 changes: 24 additions & 0 deletions doc/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,27 @@ They are still maintained by the QuTiP team but hosted under different repositor
The qutip-qip package, QuTiP quantum information processing, aims at providing basic tools for quantum computing simulation both for simple quantum algorithm design and for experimental realization.
Compared to other libraries for quantum information processing, qutip-qip puts additional emphasis on the physics layer and the interaction with the QuTiP package.
It offers two different approaches for simulating quantum circuits, one with :class:`.QubitCircuit` calculating unitary evolution under quantum gates by matrix product, another called :class:`.Processor` using open system solvers in QuTiP to simulate noisy quantum device.

Citing
===========

If you use ``qutip.qip`` in your research, cite the `preprint <https://arxiv.org/abs/2105.09902>`_
as

.. code-block:: text
Boxi Li, Shahnawaz Ahmed, Sidhant Saraogi, Neill Lambert, Franco Nori, Alexander Pitchford, & Nathan Shammah. (2021). Pulse-level noisy quantum circuits with QuTiP.
The bibtex can be downloaded directly :download:`here<qutip_qip.bib>` or
copy-pasted using :

.. code-block:: text
@misc{li2021pulselevel,
title={Pulse-level noisy quantum circuits with QuTiP},
author={Boxi Li and Shahnawaz Ahmed and Sidhant Saraogi and Neill Lambert and Franco Nori and Alexander Pitchford and Nathan Shammah},
year={2021},
eprint={2105.09902},
archivePrefix={arXiv},
primaryClass={quant-ph}}
7 changes: 7 additions & 0 deletions doc/source/qutip_qip.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@misc{li2021pulselevel,
title={Pulse-level noisy quantum circuits with QuTiP},
author={Boxi Li and Shahnawaz Ahmed and Sidhant Saraogi and Neill Lambert and Franco Nori and Alexander Pitchford and Nathan Shammah},
year={2021},
eprint={2105.09902},
archivePrefix={arXiv},
primaryClass={quant-ph}}

0 comments on commit 1603af5

Please sign in to comment.