Skip to content

Commit aaac099

Browse files
Added environment.yml for smoother development installation
1 parent 3ab2b3c commit aaac099

File tree

3 files changed

+40
-8
lines changed

3 files changed

+40
-8
lines changed

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,18 +102,12 @@ phy template-gui params.py
102102

103103
## Developer instructions
104104

105-
To get the most up-to-date changes to the code, clone the repository and install in editable mode in your Kilosort environment, along with the other installation steps mentioned above.
105+
To get the most up-to-date changes to the code, clone the repository and install in editable mode in your Kilosort environment, along with the other installation steps mentioned above. Using the included `environment.yml` to create your environment is recommended, which will also install pytest and the cuda version of Pytorch.
106106
~~~
107107
git clone [email protected]:MouseLand/Kilosort.git
108+
conda env create -f environment.yml
108109
conda activate kilosort
109110
pip install -e Kilosort[gui]
110-
pip uninstall torch
111-
conda install pytorch pytorch-cuda=11.8 -c pytorch -c nvidia
112-
~~~
113-
114-
For unit testing, you will need to install pytest
115-
~~~
116-
pip install pytest
117111
~~~
118112

119113
Then run all tests with:

environment.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: kilosort
2+
channels:
3+
- conda-forge
4+
- pytorch
5+
- nvidia
6+
dependencies:
7+
- python=3.9.*
8+
- pip
9+
- psutil
10+
- numpy>=1.20.0,<2.0.0
11+
- scipy
12+
- scikit-learn
13+
- tqdm
14+
- numba
15+
- faiss-cpu
16+
- libblas=*=*mkl
17+
- pytest
18+
# CUDA
19+
- pytorch-cuda=11.8
20+
- pytorch
21+
- pynvml
22+
# GUI
23+
- matplotlib
24+
- pip:
25+
- pyqtgraph>=0.13.0
26+
- qtpy
27+
- pyqt6
28+
- pyqt6.sip
29+
30+
31+
# TODO first thing tomorrow, create fresh env from this now that I've made all
32+
# the adjustments. Goal is should only need to do the following:
33+
# ```
34+
# conda create -f environment.yml
35+
# conda activate kilosort
36+
# pip install -e .
37+
# ```

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
'torch>=1.6',
1010
'numba',
1111
'faiss-cpu',
12+
'psutil'
1213
]
1314

1415
gui_deps = [

0 commit comments

Comments
 (0)