Restructure repository

[norepinephrine_wm.git] / README

diff --git a/README b/README
index 9b1367a1144a331d4e6bd8658c81cd29ffc5a3a8..35378eb881c0a4316f6db8de65947d44b3a54fba 100644 (file)
--- a/README
+++ b/README
@@ -8,5 +8,28 @@ Marianne Bezaire.
 
 The work in this repository was in-part derived from "Effects of Guanfacine and
 Phenylephrine on a Spiking Neuron Model of Working Memory" by Peter Duggins,
-Terry Stewart, Xuan Choo, Chris Eliasmith.
+Terry Stewart, Xuan Choo, Chris Eliasmith. Some of those original files are
+preserved in old/.
 <https://github.com/psipeter/drugs_and_working_memory>
+
+Usage
+=====
+
+Create and activate a new virtual environment:
+
+    python3 -m venv venv
+    . ./venv/bin/activate
+
+Install necesary dependencies:
+
+       pip install -r requirements.txt
+
+Modify conf.py as needed:
+
+       vi conf.py
+
+Run simulation (use the -h flag to see more options):
+
+       python3 model.py
+
+Results are stored in ./out/.