final update

[norepinephrine_wm.git] / README

diff --git a/README b/README
index 9b1367a1144a331d4e6bd8658c81cd29ffc5a3a8..d916536f679bc4c1ea5143f60a1d825137926f23 100644 (file)
--- a/README
+++ b/README
@@ -10,3 +10,28 @@ 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.
 <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:
+
+       python3 model.py
+
+An overall progress bar is shown during the simulation, and more detailed
+results are stored in a log file. Logs and charts are stored in ./out/. The
+simulation will be skipped if a file named simulation.pkl is present. It will be
+loaded and used instead of the simulation being run.