Skip to content

Commit 666f49b

Browse files
committed
Update readme with more specific instructions for installation
1 parent 454e195 commit 666f49b

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

Readme.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@ This tool allows you to:
1414
![change factors](/img/RasterVis-ChangeFactor.gif)
1515

1616
### Installation
17-
To run RasterVis locally, you need a to set up a local web server. For example using Python (2.x), browse to the main folder and run:
18-
``` python -m SimpleHTTPServer 8888 ```. Then open http://localhost:8888/ in your browser.
17+
To run RasterVis locally, you need to install the dependencies and set up a local web server.
18+
19+
To install the dependencies and start a webserver, run:
20+
```
21+
npm install
22+
npm run postinstall
23+
24+
```
1925

2026
### Data Format and Naming
2127
All files must be in the JSON format.
28+
Time should be measured in milliseconds.
2229

2330
All data must be placed in the /DATA folder
2431

@@ -33,21 +40,19 @@ There are three main file types:
3340

3441
The trialInfo.json contains an array of three objects structured as follows:
3542
<pre>
36-
|--Subject (NOTE TO SELF: change name to subject instead of monkey)
37-
|--name: Name of subject
38-
|--sessionNames
39-
|----name: Name of session
40-
|----neurons: Array of neuron names
41-
42-
|--timePeriods (NOTE TO SELF: change name to trialEvents)
43+
|--neurons
44+
|--name: Name of neuron
45+
|--sessionName: Name of session
46+
|--timePeriods
4347
|--name: Name of trial event
4448
|--label: Short label of trial event
4549
|--startID: Beginning of trial event
4650
|--endID: End of trial event
4751
|--color: Color of trial event
4852
|--experimentalFactor
4953
|--name: Name of experimental factor to sort by
50-
|--value: experimental factor key (NOTE TO SELF: change name to key)
54+
|--value: experimental factor key
55+
|--factorType: continuous | categorical | ordinal
5156
</pre>
5257

5358
The (sessionName)_TrialInfo.json is an array of objects corresponding to each trial. Each trial object contains the properties corresponding to trial events and experimental factors. For example:

0 commit comments

Comments
 (0)