Examples
--------

For a detailed tutorial on how to use the package, check out these papers:
	* `SciPost Phys. 2, 003 (2017) <https://scipost.org/10.21468/SciPostPhys.2.1.003>`_.
	* `SciPost Phys. 7, 020 (2019) <https://scipost.org/10.21468/SciPostPhys.7.2.020>`_.

The following Python scripts demonstrate basic and advanced functionality of QuSpin. In many cases, we have chosen to exhibit QuSpin's functionality, and *there may exist a more efficient approach* to obtain the same result using QuSpin. 

To run the example scripts, besides QuSpin, you have to also install `matplotlib <https://matplotlib.org/users/installing.html>`_ (e.g. by using anaconda):
	
	* **Getting started**
		* :ref:`example_00-label`, :download:`download script <../../examples/scripts/example00.py>`
		* :ref:`example0-label`, :download:`download script <../../examples/scripts/example0.py>`
		* :ref:`example8-label`, :download:`download script <../../examples/scripts/example8.py>`
	
	* **Parallel computing in QuSpin**
		* :ref:`example12-label`, :download:`download script <../../examples/scripts/example12.py>`
	
	* **Basic usage**
		* **non-interacting systems**
			* :ref:`example5-label`, :download:`download script <../../examples/scripts/example5.py>`
			* :ref:`example3-label`, :download:`download script <../../examples/scripts/example3.py>`
			* :ref:`example17-label`, :download:`download script <../../examples/scripts/example17.py>`
			* :ref:`example4-label`, :download:`download script <../../examples/scripts/example4.py>`
		* **interacting systems**
			* :ref:`example13-label`, :download:`download script <../../examples/scripts/example13.py>`
			* :ref:`example18-label`, :download:`download script <../../examples/scripts/example18.py>`
			* :ref:`example2-label`, :download:`download script <../../examples/scripts/example2.py>`	
			* :ref:`example7-label`, :download:`download script <../../examples/scripts/example7.py>`
			* :ref:`example9-label`, :download:`download script <../../examples/scripts/example9.py>`	
			* :ref:`example6-label`, :download:`download script <../../examples/scripts/example6.py>`
			* :ref:`example1-label`, :download:`download script <../../examples/scripts/example1.py>`
			* :ref:`example10-label`, :download:`download script <../../examples/scripts/example10.py>`
			* :ref:`example25-label`, :download:`download script <../../examples/scripts/example25.py>`
			
	* **Advanced usage**
		* :ref:`example14-label`, :download:`download script <../../examples/scripts/example14.py>`
		* :ref:`example15-label`, :download:`download script <../../examples/scripts/example15.py>`
		* :ref:`example16-label`, :download:`download script <../../examples/scripts/example16.py>`
		* :ref:`example19-label`, :download:`download script <../../examples/scripts/example19.py>`
		* :ref:`example26-label`, :download:`download script <../../examples/scripts/example26.py>`
		* :ref:`example23-label`, :download:`download script <../../examples/scripts/example23.py>`
		* :ref:`example24-label`, :download:`download script <../../examples/scripts/example24.py>`
		* :red:`NEW:` :ref:`example28-label`, :download:`download script <../../examples/scripts/example28.py>`
		
	

	* **Algorithms and Routines**
		* :ref:`example11-label`, :download:`download script <../../examples/scripts/example11.py>`
		* :ref:`example22-label`, :download:`download script <../../examples/scripts/example22.py>`
		* :ref:`example20-label`, :download:`download script <../../examples/scripts/example20.py>`
		* :ref:`example21-label`, :download:`download script <../../examples/scripts/example21.py>`
		* :red:`NEW:` :ref:`example27-label`, :download:`download script <../../examples/scripts/example27.py>`

		

Tutorials
---------

We also have a small number of tutorials in `Jupyter notebook <http://jupyter.org/>`_ format:
	* `Bose Hubbard Model <https://github.com/weinbe58/QuSpin/blob/master/examples/notebooks/BHM.ipynb>`_, :download:`download ipynb <../../examples/notebooks/BHM.ipynb>`, :download:`download script <../../examples/notebooks/BHM.py>`
	* `Fermi Hubbard Model <https://github.com/weinbe58/QuSpin/blob/master/examples/notebooks/FHM.ipynb>`_, :download:`download ipynb <../../examples/notebooks/FHM.ipynb>`, :download:`download script <../../examples/notebooks/FHM.py>`
	* `Su Schrieffer Heeger Model <https://github.com/weinbe58/QuSpin/blob/master/examples/notebooks/SSH.ipynb>`_, :download:`download ipynb <../../examples/notebooks/SSH.ipynb>`, :download:`download script <../../examples/notebooks/SSH.py>`
	* `Gross Pitaevskii Equation <https://github.com/weinbe58/QuSpin/blob/master/examples/notebooks/GPE.ipynb>`_, :download:`download ipynb <../../examples/notebooks/GPE.ipynb>`, :download:`download script <../../examples/notebooks/GPE.py>`