From 5aa7cc4c3d60385d81a38d3757f35445fcc11e62 Mon Sep 17 00:00:00 2001
From: Jinqi Huang <jh1d18@soton.ac.uk>
Date: Mon, 21 Feb 2022 14:59:02 +0000
Subject: [PATCH] Update readme files

---
 NeuroCores/README.txt | 10 +++++-----
 NeuroData/README.txt  | 29 +++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 5 deletions(-)
 create mode 100644 NeuroData/README.txt

diff --git a/NeuroCores/README.txt b/NeuroCores/README.txt
index b5f1452..3c86b47 100644
--- a/NeuroCores/README.txt
+++ b/NeuroCores/README.txt
@@ -28,18 +28,17 @@ The network
 Common argument for all functions is the network itself (`net`). The network
 should have the following fields defined.
 
-* `LTP_V` and `LTP_pw`: Voltage and pulse width for potentiation
-* `LTD_V` and `LTD_pw`: Voltage and pulse width for depression
-* `epochs`: The total number of timesteps
+* `epochs`: The total number of timesteps for training
+* `epochsForTesting`: The total number of timesteps for testing
 * `NETSIZE`: The total number of neurons
-* `LTPWIN` and `LTDWIN`: Window for LTP and LTD
 * `DEPTH`: Depth of the network
+* `Ap`, `An`, `a0p`, `a1p`, `a0n`, `a1n`, `tp`, `tn`: memristor parameters
 * `rawin`: The raw state of all neurons
 * `stimin`: The stimulus input (see NeuroData/motif_stim.txt for an example)
 * `ConnMat`: The connectivity matrix (see NeuroData/motif_connmat.txt for an
   example)
 * `params`: A dict containing any user defined parameters defined in the base
-  configuration excluding `NETSIZE`, `LTPWIN`, `LTDWIN` and `DEPTH` that must
+  configuration excluding `NETSIZE`, `DEPTH`, `Pattern ` that must
   be *always* defined.  By using an alternate base configuration file (see
   NeuroData/Neurobase.json for the base configuration) additional parameters can
   be introduced and will be available under the `params` dict.
@@ -61,3 +60,4 @@ current status of the network and has the following fields defined.
 * `fireHist`: History of firing neurons. It should be updated during the
   `neurons` step.
 
+
diff --git a/NeuroData/README.txt b/NeuroData/README.txt
new file mode 100644
index 0000000..0192ef0
--- /dev/null
+++ b/NeuroData/README.txt
@@ -0,0 +1,29 @@
+NeuroPack core library
+
+------------------------------------------------------------------------------
+All necessary configuration parameters in NeuroBase.json file:
+
+* `NETSIZE`: The total number of neurons
+* `DEPTH`: Depth of the network
+* `SPIKETRAIN`: if spike train is enabled as inputs. 
+* `Pattern_epoch`: the number of spikes regarded as one input if spike train is enabled. Currently used in tempotron core.
+* `temporalCoding_enable`: if temporal coding is enabled.
+* `LAYER`: the number of layers
+* `dt`: time step used in Izhkevich neuron core.
+* `INITRES`: memristors initialised resistance states
+* `DEVICEINITVAIATION`: memristor initialisation variation
+* `POSVOLTOFPULSELIST`: magnitudes of pulse options for positive pulses
+* `POSPULSEWIDTHOFPULSELIST`: pulsewidth of pulse options for positive pulses
+* `NEGVOLTOFPULSELIST`: magnitudes of pulse options for negative pulses
+* `NEGPULSEWIDTHOFPULSELIST`: pulsewidth of pulse options for negative pulses
+* `MAXUPDATESTEPS`: maximum update step number for weight updating
+* `RTOLERANCE`: R tolerance. Defined as (R_real - R_exp)/R_exp 
+
+------------------------------------------------------------------------------
+connectivity matrix format:
+# PREID, POSTID, W, B, TYPE
+# TYPE can be either +1 (excitatory) or -1 (inhibitory)
+
+------------------------------------------------------------------------------
+stimuli file format:
+# timestep - neuron ID that fires, neuron ID that fires, neuron ID that fires, ...., neuron ID that fires
\ No newline at end of file