Skip to content

Commit

Permalink
Merge pull request #2494 from zm711/sorter-window-doc
Browse files Browse the repository at this point in the history
Add note to explain that Command Prompt is currently the only officially supported shell for Windows
  • Loading branch information
samuelgarcia authored Mar 8, 2024
2 parents fe937a1 + 594cc77 commit e0a7ad0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/modules/sorters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ For instance, the :code:`Kilosort2_5Sorter` will handle:
From the user's point of view all of this is in the background and it happens automatically when using the
:py:func:`~spikeinterface.sorters.run_sorter` function.

.. note::
Because SpikeInterface needs to interact with other programs (e.g. Matlab) it uses shell scripts to load the scripts
that it generates. This means that the appropriate shell must be used. Although for macOS and Linux most shells work
without any issues, currently only the :code:`Command Prompt` shell for Windows works. This means that using the
:code:`PowerShell` or :code:`Windows Terminal` as your default shell may lead to errors while running sorters. Please
see Windows documentation for changing your default shell.


Running different spike sorters
Expand Down

0 comments on commit e0a7ad0

Please sign in to comment.