QuSpin is an open-source Python package for Exact Diagonalization and quantum dynamics of arbitrary boson, fermion and spin many-body systems, supporting the use of various (user-defined) symmetries in one and higher dimensional lattice systems and (imaginary) time evolution following a user-specified driving protocol.
The complete Documentation for QuSpin (including a number of recent tutorials) can be found at
http://quspin.github.io/QuSpin/
Examples with python scripts and Jupyter notebooks which show how to use QuSpin can be downloaded at
http://quspin.github.io/QuSpin/Examples.html
For an indepth introduction to the package, check out the following papers:
QuSpin wraps Scipy, Numpy, and custom Cython libraries together to offer state-of-the art exact diagonalization calculations. The interface allows the user to define any many-body (and single particle) Hamiltonian which can be constructed from local single-particle operators. It also gives the user the flexibility of accessing many pre-defined symmetries in 1d (e.g. translation, reflection, spin inversion), as well as user-defined symmetry based on elementary transformations, such as site and spin flips. Moreover, there are convenient built-in ways to specify the time and parameter dependence of operators in the Hamiltonian, which is interfaced with user-friendly routines to solve the time dependent Schrödinger equation numerically. All the Hamiltonian data is stored either using Scipy's sparse matrix library for sparse Hamiltonians or dense Numpy arrays which allows the user to access any powerful Python scientific computing tools.
The latest version of the package has the compiled modules written in Cython which has made the code far more portable across different platforms. We will support precompiled version of the package for Linux, OS X and Windows 64-bit systems. The automatic installation of QuSpin requires the Anaconda package manager for Python. Once Anaconda has been installed, all one has to do to install QuSpin is run:
$ conda install -c weinbe58 quspin
This will install the latest version on your computer. Right now the package is in its beta stages and so it may not be available for installation on all platforms using this method. In such a case one can also manually install the package.
OpenMP support is available starting from QuSpin 0.3.1. To instal quspin with OpenMP, use
$ conda install -c weinbe58 omp quspin
To install QuSpin manually, download the source code either from the master branch, or by cloning the git repository. In the top directory of the source code you can execute the following commands from bash:
Unix:
python setup.py install --default-compiler-flags
or Windows command line:
setup.py install --default-compiler-flags
For the manual installation you must have all the prerequisite python packages installed:
- scipy>=0.19.1
- numpy>=1.19.2
- cython>=0.29
- joblib
- six
- dill
- gmpy2
- numba
- numexpr
- boost, installation must include header files for boost.
- llvm-openmp, osx openmp version only.
For Windows machines one needs the correct verion of the Microsoft Visual Stuios compiler for the given python version you are building the package for. A good resource which can help you with this is here. For OS-X and Linux the standard compilers should be fine for building the package. Note that some of the compiled extensions require Openmp 2.0 or above. For most setups We recommend Anaconda or Miniconda to manage your python packages and we have pre-built code which should be compatible with most 64-bit systems. When installing the package manually, if you add the flag --record install.txt, the location of all the installed files will be output to install.txt which stores information about all installed files. This can prove useful when updating the code.
For manual installation with OpenMP, use:
Unix:
python setup.py install --omp --default-compiler-flags
or Windows command line:
setup.py install --omp --default-compiler-flags
To update the package with Anaconda, all one has to do is run the installation command again.
To safely update a manually installed version of QuSpin, one must first manually delete the entire package from the python 'site-packages/' directory. In Unix, provided the flag --record install.txt has been used in the manual installation, the following command is sufficient to completely remove the installed files: cat install.txt | xargs rm -rf. In Windows, it is easiest to just go to the folder and delete it from Windows Explorer.
The complete QuSpin documentation can be found under