Installation

Conda users, please make sure to conda install pip before running any pip installation if you want to install bosonic into your conda environment.

Install from PyPI

bosonic will soon be published on PyPI. So, to install, simply run:

pip install bosonic

To check if the installation was successful, run:

python3
>>> import bosonic as bcj

If pip installation doesn't work, please build from source, as detailed below.

Build from source

To build bosonic from source, pip install using:

git clone git@github.com:Phionx/bosonic.git
cd bosonic
pip install --upgrade .

If you also want to download the dependencies needed to run optional tutorials, please use pip install --upgrade .[dev,docs] or pip install --upgrade '.[dev,docs]' (for zsh users).

Please Note: For now, you will also have to manually install the bosonic dependency, to learn how to do so please visit: https://github.com/EQuS/bosonic.

Installation for Devs

If you intend to contribute to this project, please install bosonic in develop mode as follows:

git clone git@github.com:Phionx/bosonic.git
cd bosonic
pip install -e .[dev,docs]

Please use pip install -e '.[dev,docs]' if you are a zsh user.

Installing the package in the usual non-editable mode would require a developer to upgrade their pip installation (i.e. run pip install --upgrade .) every time they update the package source code.

Please Note: For now, you will also have to manually install the bosonic dependency, to learn how to do so please visit: https://github.com/EQuS/bosonic.