How to install?

[Babalion]

How can one install this package with qutip?

[sbisw002]

First, intall qutip in the way you are comfortable. Then, here is a sample set of commands to install qutip-lattice in development mode.

conda create --name qutip_lattice_env_name python=3.6 conda activate qutip_lattice_env_name conda install libgcc-ng conda install libstdcxx-ng conda install numpy scipy conda install cython conda install matplotlib conda install pytest conda install nose conda install jupyter notebook conda install spyder conda install dill conda install joblib git init git config --global user.email "your_email@gmail.com" git config --global user.name "github_user_name" git clone https://github.com/qutip/qutip-lattice.git cd qutip-lattice/ git remote add upstream https://github.com/qutip/qutip-lattice.git git pull upstream master git remote add origin https://github.com/sbisw002/qutip-lattice.git git remote -v show conda install qutip conda config --append channels conda-forge conda install qutip

python setup.py develop (for development mode) or python setup.py (for release mode)

After this, you should be able to use qutip-lattice with from qutip_lattice import *

The commands will make sense if you are familiar with conda, git, development modes.

[sbisw002]

The class Lattice1d here only works with single particle physics. If you wish to work on multiparticle physics, you have to pull the Pull Request https://github.com/qutip/qutip-lattice/pull/8

The multiparticle physics classes deal with few different Hubbard models. Since, all the scenarios are mutually exclusive, you are only ever going to use one class among Lattice1d, Lattice1d_fermi_Hubbard, Lattice1d_bose_Hubbard etc. (They are all separate sports like Baseball, Football or Tennis)

Some usage examples can be found in https://github.com/sbisw002/qutip-lattice-notebooks/tree/master