From 86b8caa91b8a18989922a17fff15d0d9b32a822d Mon Sep 17 00:00:00 2001
From: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
Date: Fri, 4 Nov 2022 15:42:45 +0000
Subject: [PATCH] Add instructions for installing pinned requirements and
 prepare release (#108)

* Update the README before releasing

* Add note about changelog

* Bump version to v0.1.13
---
 README.md          | 30 ++++++++++++++++++++++++++----
 modnet/__init__.py |  2 +-
 2 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index d4ffd405..a08c34ba 100644
--- a/README.md
+++ b/README.md
@@ -33,13 +33,15 @@ See the MODNet papers and repositories below for more details:
 <a name="install"></a>
 ## How to install
 
-First, create a virtual environment (e.g., named modnet) with Python 3.8:
+First, create a virtual environment (e.g., named modnet) with Python 3.8 using
+your favourite environment manager (the following instructions use
+[conda](https://docs.conda.io/)):
 
 ```shell
 conda create -n modnet python=3.8
 ```
 
-activate the environment:
+Activate the environment:
 
 ```shell
 conda activate modnet
@@ -51,16 +53,36 @@ Then, install pymatgen v2020.8.13 with conda, which will bundle several pre-buil
 conda install -c conda-forge pymatgen=2020.8.13
 ```
 
-Finally, install MODNet from PyPI with pip:
+(you could alternatively do this step with `pip install pymatgen==2020.8.13`).
 
-```bash
+Finally, install MODNet from PyPI with `pip`:
+
+```shell
 pip install modnet
 ```
 
+Alternatively, for local development (or if you wish to use pinned
+dependencies that MODNet has been tested with), you can clone this git
+repository and make an editable install inside your chosen environment with `pip`:
+
+```shell
+git clone git@github.com:ppdebreuck/modnet
+cd modnet
+conda create -n modnet python=3.8
+conda activate modnet
+pip install -r requirements.txt  # optionally use pinned requirements
+pip install -e .
+```
+
+
 <a name="documentation"></a>
 ## Documentation
 The documentation is available at [ReadTheDocs](https://modnet.readthedocs.io).
 
+<a name="changelog"></a>
+## Changelog
+A brief changelog can be found in the [release summaries on GitHub](https://github.com/ppdebreuck/modnet/releases).
+
 <a name="author"></a>
 ## Author
 This software was written by [Pierre-Paul De Breuck](mailto:pierre-paul.debreuck@uclouvain.be) and [Matthew Evans](https://www.github.com/ml-evs) with contributions from David Waroquiers and  Gregoire Heymans.
diff --git a/modnet/__init__.py b/modnet/__init__.py
index 74acd0ef..3cb7d95e 100644
--- a/modnet/__init__.py
+++ b/modnet/__init__.py
@@ -1 +1 @@
-__version__ = "0.1.12"
+__version__ = "0.1.13"