Installation

Quick start

To install the package qutip-qoc from PyPI, use

pip install qutip-qoc

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

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

numpy scipy cython qutip qutip-qtrl

The following packages are required for using the JOPT algorithm:

jax jaxlib qutip-jax

The following packages are required for the RL (reinforcement learning) algorithm:

gymnasium stable-baselines3

The following package is used for testing:

pytest

In addition,

sphinx numpydoc sphinx_rtd_theme

are used to build and test the documentation.

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-qoc directory

pytest tests