From 0846cdb27709491e38ae7435a4f7a6851b69e492 Mon Sep 17 00:00:00 2001 From: chrishalcrow Date: Tue, 22 Sep 2026 08:43:18 +0100 Subject: [PATCH 1/2] use gui as app using uv --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bc470f4..18c2f09 100644 --- a/README.md +++ b/README.md @@ -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]' --mode web sigui +``` + +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: From aeb2e90df02d64206c03d44fb5fb163300324790 Mon Sep 17 00:00:00 2001 From: Chris Halcrow <57948917+chrishalcrow@users.noreply.github.com> Date: Tue, 22 Sep 2026 08:45:49 +0100 Subject: [PATCH 2/2] Apply suggestion from @chrishalcrow --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 18c2f09..be33285 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ uv run --with '.[desktop]' sigui or ```bash -uv run --with '.[web]' --mode web sigui +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