Skip to content

Commit d92b245

Browse files
committed
Added compile mexfiles instructions
1 parent 0113968 commit d92b245

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

kilosort3-compiled/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ Licenses for Matlab and toolboxes are needed only for compiling ironclust as Sta
2626
## Compiling Kilosort as Matlab's Standalone Application
2727
- Git clone or Download kilosort [source code](https://github.com/MouseLand/Kilosort)
2828
- Open Matlab
29+
- Compile Kilosort mexfiles:
30+
- Set Matlab's workspace folder to `<git-cloned-path>/Kilosort/CUDA`
31+
- In Matlab console run:
32+
```
33+
>> mexGPUall
34+
```
2935
- Set Matlab's workspace folder to `/path/to/spikeinterface-dockerfiles/kilosort3-compiled/matlab_files`
3036
- Open Matlab's `Application Compiler` (located in `APPS` Tab)
3137
- Click on `+` sign in Add Main File, Select `ks3_compiled.m` and Click `Open`
@@ -38,7 +44,7 @@ Licenses for Matlab and toolboxes are needed only for compiling ironclust as Sta
3844
## Generating Base Docker Image
3945
- In Matlab console run:
4046
```
41-
compiler.package.docker('ks3_compiled/for_testing/ks3_compiled', 'ks3_compiled/for_testing/requiredMCRProducts.txt', 'ImageName', 'ks3-matlab-base')
47+
>> compiler.package.docker('ks3_compiled/for_testing/ks3_compiled', 'ks3_compiled/for_testing/requiredMCRProducts.txt', 'ImageName', 'ks3-matlab-base')
4248
```
4349
4450
This command will create an image called `ks3-matlab-base` to be used in the next step
@@ -74,4 +80,3 @@ This kilosort3 compiled version assumes that there are also two `.mat` files in
7480
2. `chanMap.mat`: ChannelMap data
7581
7682
Both files are automatically generated by spikeinterface when running `run\_sorter`. If you want to run compiled kilosort independently you need to generate them manually (HOW TO still needs to be done)
77-

0 commit comments

Comments
 (0)