Skip to content

Commit

Permalink
updating readme installation
Browse files Browse the repository at this point in the history
  • Loading branch information
Phionx committed Jul 28, 2024
1 parent dc795af commit 5aca2c1
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,33 @@ Built on JAX, `qcsys` presents a scalable way to assemble and simulate systems

## Installation

**Recommended:** As this is a rapidly evolving project, we recommend installing the latest version of `qcsys` from source:
### Installing from source (recommended)

**Recommended:** As this is a rapidly evolving project, we recommend installing the latest version of `qcsys` from source as follows:
```
pip install git+https://github.com/EQuS/qcsys.git
```

After installing `qcsys`, consider updating the `jaxquantum` dependency to its latest version from source:
After installing `qcsys`, update the `jaxquantum` dependency to its latest version from source:
```
pip install git+https://github.com/EQuS/jaxquantum.git
```

### Installing from source in editable mode (recommended for developers)

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:
```
pip install -e ".[dev]"
```
This will also install extras from the `dev` flag, 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.

After installing `qcsys`, update the `jaxquantum` dependency to its latest version from source:
```
pip install git+https://github.com/EQuS/jaxquantum.git
```

### Installing from PyPI (not recommended)

`qcsys` is also published on PyPI. Simply run the following code to install the package:


Expand Down

0 comments on commit 5aca2c1

Please sign in to comment.