************
Installation
************

.. _quickstart:

Quick start
===========
To install the package ``qutip-qtrl`` from PyPI, use

.. code-block:: bash

    pip install qutip-qtrl

Migrating from ``qutip.control``
================================
As the :ref:`introduction` suggested, this package is based on a module in the `QuTiP <http://qutip.org/docs/latest/>`_ 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:

Prerequisites
=============
This package is built upon QuTiP, of which the installation guide can be found at on `QuTiP Installation <http://qutip.org/docs/latest/installation.html>`_.

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

.. code-block:: bash

    numpy scipy cython qutip

The following to packages are used for plotting and testing:

.. code-block:: bash

    matplotlib pytest

In addition,

.. code-block:: bash

    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 <https://github.com/qutip/qutip-qtrl>`_ and run

.. code-block:: bash

    pip install .

under the directory containing the ``setup.cfg`` file.

If you want to edit the code, use instead

.. code-block:: bash

    pip install -e .

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

```
pytest tests
```