Skip to content

Commit

Permalink
adding link to hardware docs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carsen-stringer committed Mar 3, 2024
1 parent bdfcf87 commit 21988ed
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Example notebooks are provided in the `docs/source/tutorials` folder and will be

### System requirements

Linux and Windows 64-bit are supported for running the code. At least 8GB of GPU RAM is required to run the software (see [wiki](https://github.com/MouseLand/Kilosort/wiki/8.-Hardware-guide) for more recommendations). The software has been tested on Windows 10 and Ubuntu 20.04.
Linux and Windows 64-bit are supported for running the code. At least 8GB of GPU RAM is required to run the software (see [docs](https://kilosort.readthedocs.io/en/latest/hardware.html) for more recommendations). The software has been tested on Windows 10 and Ubuntu 20.04.

### Instructions

Expand Down
6 changes: 3 additions & 3 deletions docs/drift.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Drift correction
==============================

Here we get into the details of drift: why it happens, what it looks like, how you can characterize it for your own recordings, and how you can tell if Kilosort2 is fixing it. The examples in this section are from acute Neuropixels 1.0 recordings in head-fixed mice.
Here we get into the details of drift: why it happens, what it looks like, how you can characterize it for your own recordings, and how you can tell if Kilosort is fixing it. The examples in this section are from acute Neuropixels 1.0 recordings in head-fixed mice.

Why drift happens
------------------------
Expand Down Expand Up @@ -53,10 +53,10 @@ Now the PCA feature projections across all times, for the two channels where the


.. image:: https://www.kilosort.org/static/images/scatter_PCA.png
:width: 400
:width: 200


Finally, here are the projections on the time-varying templates of Kilosort2, showing that the units maintain a constant high separation throughout the recording:

.. image:: https://www.kilosort.org/static/images/scatter_TEMP.png
:width: 400
:width: 300

0 comments on commit 21988ed

Please sign in to comment.