Skip to content

Commit a5b1df6

Browse files
committed
Update readme.md
1 parent 85a1b0e commit a5b1df6

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

spikeinterface/readme.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,34 @@
11
### How to build this image
22
Open a terminal, navigate to the spikeinterface directory, then run:
3-
`docker build -t wanglabneuro/spikeinterface:0.2 .`
3+
`docker build -t spikeinterface:0.2 .`
44
On Linux systems, you can also use the build script (after making it executable `chmod +x build.sh`):
55
`./build.sh`
66

77
### How to run the spikeinterface container
88
**Method 1**
9-
For Windows: drag and drop the data folder on `Run_SpikeInterface.bat`. Replace "mytoken" by whatever word.
9+
For Windows: drag and drop the data folder on `Run_SpikeInterface.bat`. Replace "mytoken" by some other word.
1010

1111
**Method 2**
12-
On Linux/MacOS:
12+
1. Open a terminal and navigate to the data directory. Then follow these instructions.
13+
2. Start the container
14+
*On Linux/MacOS*
1315
`export JUPYTER_TOKEN='mytoken'`
14-
`docker run -d --rm --name spikeinterface -v "${PWD}":/home/jovyan/work -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.1`
15-
16-
On Windows:
16+
`docker run -d --rm --name spikeinterface -v "${PWD}":/home/jovyan/data -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.1`
17+
*On Windows*
1718
`set JUPYTER_TOKEN=mytoken`
18-
`docker run -d --rm --name spikeinterface -v "%CD%":/home/jovyan/work -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.1`
19+
`docker run -d --rm --name spikeinterface -v "%CD%":/home/jovyan/data -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.1`
1920

20-
Then open http://localhost:8888/lab?token=mytoken in a browser.
21+
3. Then open http://localhost:8888/lab?token=mytoken in a browser.
22+
23+
(Replace "mytoken" by some other word).
24+
25+
**Important Note**
26+
The `--rm` flag means the container is a on-off (will self-destroy upon closure).
27+
To make the container persitant, remove the `--rm flag` from the docker call. In which case, the container will persist. To start a stopped container, run `docker start spikeinterface` in a terminal, or use the Docker Desktop interface to start it.
28+
29+
30+
31+
2132

2233

2334

0 commit comments

Comments
 (0)