Installation#
Installing via conda#
For Python 3.7, 3.8, 3.9, and 3.10, installation via conda is supported. This is done by executing
conda install -c conda-forge scqubits
Upgrading to the latest version of scqubits can be done by
conda update -c conda-forge scqubits
Installing via pip#
scqubits can also be installed using the Python package manager pip (although it should be noted that installing via pip under a conda environment is strongly discouraged, and is not guaranteed to work).
pip install scqubits
To upgrade to the latest version of scqubits one can execute
pip install scqubits -U
ARM64 Compatibility#
Apple M1 machines with arm64 architecture, scqubits is only compatible with SciPy < 1.7 and Python < 3.9, in addition to the requirements listed below. Alternatively, it is possible to create conda environments with x86 architecture.
General Requirements#
scqubits depends on the following Python open-source libraries:
Package |
Version |
Details |
---|---|---|
Python |
3.7+ |
Version 3.7 and higher is supported. |
NumPy |
1.14.2+ |
Not tested on lower versions. |
SciPy |
1.1.0+ |
Not tested on lower versions. |
Matplotlib |
3.0.0+ |
Some plotting does not work on lower versions. |
QuTiP |
4.3+ |
Needed for composite Hilbert spaces. |
Cython |
0.28.5+ |
Required by QuTiP |
tqdm |
4.0+ |
Needed for display of progress bar |
sympy |
1.7.1+ |
Needed for custom circuit analysis |
The following packages are optional:
Package |
Version |
Details |
---|---|---|
ipywidgets |
7.5+ |
For use of the interactive explorer |
h5py |
2.10+ |
Needed for writing data to h5 file |
pytest |
5.3+ |
For running the test suite. |
matplotlib-label-lines |
0.3.6+ |
For smart labelling of matrix element plots |
Verifying the Installation#
scqubits includes a set of tests that can be executed to verify that installation was successful:
import scqubits.testing as sctest
sctest.run()
This requires the pytest package.