Skip to content

Commit ab0c8bd

Browse files
committed
Update readme.md
1 parent c077701 commit ab0c8bd

1 file changed

Lines changed: 28 additions & 11 deletions

File tree

spikeinterface/readme.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,48 @@
1-
### How to build this image
2-
Open a terminal, navigate to the spikeinterface directory, then run:
3-
`docker build -t spikeinterface:0.2 .`
4-
On Linux systems, you can also use the build script (after making it executable `chmod +x build.sh`):
5-
`./build.sh`
61

72
### How to run the spikeinterface container
8-
**Method 1**
9-
For Windows: drag and drop the data folder on `Run_SpikeInterface.bat`. Replace "mytoken" by some other word.
3+
**Method 1: drag and drop** (Windows only)
4+
Drag and drop the data folder on either `.bat` file. For convenience, create a shortcut and put it on your desktop.
5+
6+
![Drag and Drop](DragAndDropDemo.gif)
7+
8+
Which launch script should you pick?
9+
`SpikeInterface_OneOff.bat` will start a on-off sesssion. The container will self-destroy upon shutdown (not just closing the tab though). If the tab is closed, go back to your session at this address: http://localhost:8888/lab?token=mytoken.
10+
`SpikeInterface_Persist.bat` will start a persistent container that can be reused. The drawback is that data folder will stay the same until the container is stopped and remove (which can be done following instructions below).
11+
In the `.bat`, please replace "mytoken" by some other word of your choice.
12+
13+
To add files and notebooks to your session, drag and drop them on the left side mneu.
14+
Files can be downloaded with right-click > download.
1015

11-
**Method 2**
16+
**Method 2: manual start**
1217
1. Open a terminal and navigate to the data directory. Then follow these instructions.
1318
2. Start the container
1419
*On Linux/MacOS*
1520
`export JUPYTER_TOKEN='mytoken'`
16-
`docker run -d --rm --name spikeinterface -v "${PWD}":/home/jovyan/data -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.1`
21+
`docker run -d --rm --name spikeinterface -v "${PWD}":/home/jovyan/data -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.2`
1722
*On Windows*
1823
`set JUPYTER_TOKEN=mytoken`
19-
`docker run -d --rm --name spikeinterface -v "%CD%":/home/jovyan/data -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.1`
24+
`docker run -d --rm --name spikeinterface -v "%CD%":/home/jovyan/data -p 8888:8888 -e JUPYTER_TOKEN wanglabneuro/spikeinterface:0.2`
25+
26+
* Replace "mytoken" by some other word.
27+
* If you built the image (see below), remove `wanglabneuro` or replace it with your docker handle.
2028

2129
3. Then open http://localhost:8888/lab?token=mytoken in a browser.
2230

23-
(Replace "mytoken" by some other word).
31+
2432

2533
**Important Note**
2634
The `--rm` flag means the container is a on-off (will self-destroy upon closure).
2735
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.
2836

37+
### How to build this image
38+
The container image is [available on DockerHub](https://hub.docker.com/repository/docker/wanglabneuro/spikeinterface/). Providing you have Docker installed, it will automatically download when starting the container.
39+
40+
If you want to build it, follow the instructions below.
41+
Open a terminal, navigate to the spikeinterface directory, then run:
42+
`docker build -t spikeinterface:0.2 .`
43+
On Linux systems, you can also use the build script (after making it executable `chmod +x build.sh`):
44+
`./build.sh`
45+
2946

3047

3148

0 commit comments

Comments
 (0)