Skip to content

Commit

Permalink
Update installation isntruction in README
Browse files Browse the repository at this point in the history
  • Loading branch information
niksirbi committed Jul 21, 2023
1 parent 6977f85 commit 3f4bc0c
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,37 @@ reproducible computational understanding of the hippocampus and entorhinal corte
Try our short tutorial online in Colab. <a href="https://githubtocolab.com/SainsburyWellcomeCentre/NeuralPlayground/blob/main/examples/colab_example.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>

## 2. Installation
You can create a new environment using conda, and the yml file with all the right
dependencies by running
```
git clone https://github.com/SainsburyWellcomeCentre/NeuralPlayground/
conda create --name NPG
conda activate NPG
conda install pip
```

For now, install using pip for local editing and testing
```
pip install -e .
### Create a conda environment
We advise you to install the package in a virtual environment,
to avoid conflicts with other packages. For example, using `conda`:

```python
conda create --name NPG-env python=3.10
conda activate NPG-env
```
or
### Pip install

You can use `pip` get the latest release of NeuralPlayground from PyPI.
```python
# install the latest release
pip install NeuralPlayground

# upgrade to the latest release
pip install -U NeuralPlayground

# install a particular release
pip install NeuralPlayground==0.0.1
```
### Install for development

If you want to contribute to the project, get the latest development version
from GitHub, and install it in editable mode, including the "dev" dependencies:
```bash
git clone https://github.com/SainsburyWellcomeCentre/NeuralPlayground/
cd NeuralPlayground
pip install -e '.[dev]'
```
if you want to install the dependencies for development.

## 3. Project

Expand Down

0 comments on commit 3f4bc0c

Please sign in to comment.