Skip to content

Add new install instructions #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alejoe91 merged 2 commits into from
Sep 23, 2026
Merged

Add new install instructions #282

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0846cdb
use gui as app using uv
chrishalcrow Sep 22, 2026
aeb2e90
Apply suggestion from @chrishalcrow
chrishalcrow Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,42 @@ This viewer has 2 modes:

# Installation

## Using `uv`

Using `uv`, you can use SpikeInterface-GUI like an app. First [install uv](https://docs.astral.sh/uv/getting-started/installation/). Then download (clone) the source code from github and change directory into the SpikeInterface-GUI folder:

```bash
git clone https://github.com/SpikeInterface/spikeinterface-gui.git
cd spikeinterface-gui
```

Now you can run the desktop or web version of the GUI, without having to explicitly create a new environment, by running

```bash
uv run --with '.[desktop]' sigui
```

or

```bash
uv run --with '.[web]' sigui --mode web
```

The first time you run this, `uv` will install all the required dependencies. This might take a few minutes. The next
time you run the GUI, the dependencies will already be installed.

## Using python environments

For beginners users, please see our [installation tips](https://github.com/SpikeInterface/spikeinterface/tree/main/installation_tips)
where we provide a yaml for Mac/Windows/Linux to help properly install `spikeinterface` and `spikeinterface-gui` for you in a dedicated
`uv` environment.
where for tips to properly install `spikeinterface` and `spikeinterface-gui` in a dedicated environment.

In your environment, if you wish to use the Desktop version of the GUI, you can do:
In your environment, if you wish to use the Desktop version of the GUI, you can run:

```bash
pip install 'spikeinterface-gui[desktop]'
```

Note: this installs `PySide6`. You can use the `PyQt5` backend instead by uninstalling `PySide6` and then installing `PyQt5`.
Note: this installs `PyQt5`. You can use the `PySide6` backend instead by uninstalling `PyQt5` and then installing `PySide6`.

If you wish to use the Web version of the GUI, you can do:

Expand Down
Loading