Merge pull request #62 from SainsburyWellcomeCentre/fixes-after-pypi

Fixes after pypi release

.gitignore

@@ -59,3 +59,6 @@ coverage.xml
 *.png
 
 *.egg-info
+
+# PyPI distribution / packages
+dist/

README.md

@@ -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
 

pyproject.toml

@@ -37,11 +37,11 @@ dependencies = [
 ]
 
 [project.urls]
-homepage = "https://github.com/ClementineDomine/NeuralPlayground"
-bug_tracker = "https://github.com/ClementineDomine/NeuralPlayground/issues"
-documentation = "https://github.com/ClementineDomine/NeuralPlayground"
-source_code = "https://github.com/ClementineDomine/NeuralPlayground"
-user_support = "https://github.com/ClementineDomine/NeuralPlayground/issues"
+"Homepage" = "https://github.com/ClementineDomine/NeuralPlayground"
+"Bug tracker" = "https://github.com/ClementineDomine/NeuralPlayground/issues"
+"Documentation" = "https://github.com/ClementineDomine/NeuralPlayground"
+"Source code" = "https://github.com/ClementineDomine/NeuralPlayground"
+"User support" = "https://github.com/ClementineDomine/NeuralPlayground/issues"
 
 [project.optional-dependencies]
 dev = [