Installation

Quick start

To install the package qutip-qtrl from PyPI, use

pip install qutip-qtrl

Migrating from qutip.control

As the Introduction suggested, this package is based on a module in the QuTiP package qutip.control. 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.control in your import statement with qutip_qtrl. Everything should work smoothly as usual.

Prerequisites

This package is built upon QuTiP, of which the installation guide can be found at on QuTiP Installation.

In particular, following packages are necessary for running qutip-qtrl:

numpy scipy cython qutip

The following to packages are used for plotting and testing:

matplotlib pytest

In addition,

sphinx numpydoc sphinx_rtd_theme

are used to build and test the documentation.

Install qutip-qtrl from source code

To install the package, download to source code from GitHub website and run

pip install .

under the directory containing the setup.cfg file.

If you want to edit the code, use instead

pip install -e .

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

` pytest tests `