2. Installation

2.1. Main installation method

  1. Fork 🍴 the ```pyEPR top-level repository```_ on GitHub. (How to fork a GitHub repo?). Share some love by staring :star: pyEPR.
  2. Clone 👇 your forked repository locally. (How to clone a GitHub repo?). Setup the pyEPR python code by following Installation and Python Setup.
  3. Tutorials Learn how to use using the jupyter notebook tutorials
  4. Stay up to date Enjoy and make sure to git add the master remote branch git remote add MASTER_MINEV git://github.com/zlatko-minev/pyEPR.git (help?).
  5. Cite ``pyEPR`` arXiv:2010.00620 and arXiv:1902.10355 enjoy! 🎂

2.2. Installing locally via pip

In the future, pyEPR can be installed using the Python package manager pip.

However, for the moment, we recommend a local developer installation, which allows for fast upgrades. We are still in active development. Perform the steps in the Main installation method section. What you could do, once you have the local clone git, is to install pyEPR locally. Navigate to the local root folder of the repo.

First, in bash, upgrade python pip

python -m pip install -U pip

Now we can locally install the pyEPR module.

python -m pip install -r requirements.txt -e .

2.3. Installing via conda

For Python 3.6+, installation via conda is supported since pyEPR v.0.8.03, through the conda-forge channel. You can download and install pyEPR typing in from bash:

conda install -c conda-forge pyepr-quantum

The prefix -c conda-forge is required to activate the optional conda-forge channel.

2.4. Installing via pip from PyPI

For Python 3.6+, installation via PyPI is supported since pyEPR v.0.8. You can download and install pyEPR typing in from bash:

pip install pyEPR-quantum

Note

Note that the name of the recipe on the conda-forge channel is pyepr-quantum, and on PyPI is pyEPR-quantum, as the name pyepr was already taken by another project. This does not change anything in the way the library is imported in Python as documented in the guide and examples.