.. QuSpin documentation master file, created by sphinx-quickstart on Mon Jul 24 11:07:25 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to the Official QuSpin Documentation! ============================================= QuSpin is an open-source Python package for exact diagonalization and quantum dynamics of arbitrary boson, fermion and spin many-body systems. QuSpin supports the use of various (user-defined) symmetries for one and higher-dimensional lattice systems, (imaginary) time evolution following arbitrary user-specified driving protocols, and constrained Hilbert spaces. This page contains the documentation for the use of all public functions and classes contained in QuSpin. Check out these papers and the example scripts (below) for a detailed tutorial: * `SciPost Phys. 2, 003 (2017) `_. * `SciPost Phys. 7, 020 (2019) `_. **Report** any **bugs** and **ask questions** `here `_. The source code is available on `Github `_; Suggestions for future improvements and user contributions are always welcome! New Features ==================== .. toctree:: :maxdepth: 1 New_Features QuSpin API reference ==================== .. toctree:: :maxdepth: 1 basis operators tools Installation and Usage ======================= .. toctree:: :maxdepth: 1 Installation Example Scripts ====================== .. toctree:: :maxdepth: 1 Examples Parallel Computing Capabilities =============================== .. toctree:: :maxdepth: 1 parallelization User Basis Tutorial =============================== .. toctree:: :maxdepth: 1 user_basis Report a Bug / Ask a Question ============================= To report a bug in QuSpin, or ask a question about the package, please `open up a new issue `_ on GitHub.