Skip to content

Commit

Permalink
adding info to use requirements.txt for development with conda
Browse files Browse the repository at this point in the history
  • Loading branch information
ShantanuKodgirwar committed Oct 23, 2024
1 parent 667b769 commit f092ca9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ git clone [email protected]:PtyLab/PtyLab.py.git
cd PtyLab.py
```

Inside a virtual environment (preferably with conda), please install `ptylab` and its dependencies:
Inside a virtual environment (preferably with conda), please install `ptylab` and its dependencies from the pinned versions specified under `requirements.txt`:
```bash
conda create --name ptylab_venv python=3.11.5 # or python version satisfying ">=3.9, <3.12"
conda activate ptylab_venv
pip install -e .[dev]
pip install -e . -r requirements.txt
```

To use the GPU, `cupy` can be additionally installed in this environment.
Expand All @@ -43,7 +43,7 @@ To use the GPU, `cupy` can be additionally installed in this environment.
conda install -c conda-forge cupy
```

If you would like to contribute to this package, please checkout the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
If you would like to contribute to this package, especially if it involves modifying dependencies, please checkout the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.

## Citation

Expand Down

0 comments on commit f092ca9

Please sign in to comment.