|
1 |
| -# Installation |
| 1 | +## Installation |
2 | 2 |
|
3 |
| -*Conda users, please make sure to `conda install pip` before running any pip installation if you want to install `jaxquantum` into your conda environment.* |
4 | 3 |
|
5 |
| -`jaxquantum` is published on PyPI. So, to install the latest version from PyPI, simply run the following code to install the package: |
| 4 | +### Installing from source (recommended) |
6 | 5 |
|
7 |
| -```bash |
8 |
| -pip install jaxquantum |
| 6 | +**Recommended:** As this is a rapidly evolving project, we recommend installing the latest version of `jaxquantum` from source as follows: |
| 7 | +``` |
| 8 | +pip install git+https://github.com/EQuS/jaxquantum.git |
9 | 9 | ```
|
10 |
| -If you also want to download the dependencies needed to run optional tutorials, please use `pip install jaxquantum[dev,docs]` or `pip install 'jaxquantum[dev,docs]'` (for `zsh` users). |
11 |
| - |
12 |
| -#### Building from source |
13 | 10 |
|
14 |
| -To build `jaxquantum` from source, pip install using: |
| 11 | +### Installing from source in editable mode (recommended for developers) |
15 | 12 |
|
16 |
| -```bash |
17 |
| -git clone git@github.com:EQuS/jaxquantum.git jaxquantum |
18 |
| -cd jaxquantum |
19 |
| -pip install --upgrade . |
| 13 | +If you are interested in contributing to the package, please clone this repository and install this package in editable mode after changing into the root directory of this repository: |
20 | 14 | ```
|
| 15 | +pip install -e ".[dev,docs]" |
| 16 | +``` |
| 17 | +This will also install extras from the `dev` and `docs` flags, which can be useful when developing the package. Since this is installed in editable mode, the package will automatically be updated after pulling new changes in the repository. |
21 | 18 |
|
22 |
| -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). |
| 19 | +### Installing from PyPI (not recommended) |
23 | 20 |
|
24 |
| -#### Installation for Devs |
| 21 | +`jaxquantum` is also published on PyPI. Simply run the following code to install the package: |
25 | 22 |
|
26 |
| -If you intend to contribute to this project, please install `jaxquantum` in editable mode as follows: |
27 | 23 | ```bash
|
28 |
| -git clone git@github.com:EQuS/jaxquantum.git jaxquantum |
29 |
| -cd jaxquantum |
30 |
| -pip install -e .[dev, docs] |
| 24 | +pip install jaxquantum |
31 | 25 | ```
|
32 | 26 |
|
33 |
| -Please use `pip install -e '.[dev, docs]'` if you are a `zsh` user. |
34 |
| - |
35 |
| -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. |
36 |
| - |
37 |
| -#### Install with GPU support (Linux) |
| 27 | +### Install with GPU support (Linux) |
38 | 28 |
|
39 | 29 | For linux users who wish to enable Nvidia GPU support, here are some steps ([ref](https://jax.readthedocs.io/en/latest/installation.html#nvidia-gpu)):
|
40 | 30 |
|
|
0 commit comments