Skip to main content

The QuTiP quantum information processing package

Project description

qutip-qip

build Documentation Status PyPI version arXiv paper

The qutip-qip package used to be a module qutip.qip under QuTiP (Quantum Toolbox in Python). 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. Hence a few modules are separated from the core QuTiP and will become QuTiP family packages. They are still maintained by the QuTiP team but hosted under different repositories in the QuTiP organization.

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. The package offers two different approaches for simulating quantum circuits, one with QubitCircuit calculating unitary evolution under quantum gates by matrix product, another called Processor using open system solvers in QuTiP to simulate noisy quantum device.

If you would like to know the future development plan and ideas, have a look at the discussion panel as well as the qutip documentation for ideas.

Quick start

To install the package, use

pip install qutip-qip

Migrating from qutip.qip

As the introduction suggested, this package is based on a module in the QuTiP package qutip.qip. If you were using the qutip package and now want to try out the new features included in this package, you can simply install this package and replace all the qutip.qip in your import statement with qutip_qip. Everything should work smoothly as usual.

Documentation and tutorials

The documentation of qutip-qip updated to the latest development version is hosted at qutip-qip.readthedocs.io/. Tutorials related to using quantum gates and circuits in qutip-qip can be found here and those related to using noise simulators areavailable at this link.

Code examples used in the preprint Pulse-level noisy quantum circuits with QuTiP, updated for the latest code version, are hosted in this folder.

Installation from source

If you want to edit the source code, please download the source code and run the following command under the root qutip-qip folder,

pip install --upgrade pip
pip install -e .

which makes sure that you are up to date with the latest pip version. Contribution guidelines are available here.

To build and test the documentation, additional packages need to be installed:

pip install pytest matplotlib sphinx numpydoc sphinx_rtd_theme

Under the doc directory, use

make html

to build the documentation, or

make doctest

to test the code in the documentation.

Testing

To test the installation from a download of the source code, run from the qutip-qip directory

pytest tests

Citing qutip-qip

If you use qutip-qip in your research, the preprint can be cited as

@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.

Powered by NumFOCUS Unitary Fund

QuTiP development is supported by Nori's lab at RIKEN, by the University of Sherbrooke, by Chalmers University of Technology, by Macquarie University and by Aberystwyth University, among other supporting organizations.

License

license

You are free to use this software, with or without modification, provided that the conditions listed in the LICENSE.txt file are satisfied.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qutip-qip, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size qutip_qip-0.1.1-py3-none-any.whl (106.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size qutip-qip-0.1.1.tar.gz (109.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page