Skip to content

Commit 290ad5c

Browse files
authored
Update README.md
1 parent 40f9ccc commit 290ad5c

1 file changed

Lines changed: 24 additions & 7 deletions

File tree

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Zenodo DOI: [![DOI](https://zenodo.org/badge/417468733.svg)](https://doi.org/10.
88
This repo adds some support to use [Spotiflow](https://github.com/weigertlab/spotiflow) within QuPath through a Python virtual environment.
99

1010
> [!WARNING]
11-
> This extension is developed for QuPath 0.5.x
11+
> This extension is developed for QuPath 0.6.x
1212
1313

1414
# Citing
@@ -24,13 +24,14 @@ As this code is neither novel nor entirely original, there is no linked publicat
2424
## Code authorship
2525
**Author**: Rémy Dornier (1)
2626

27-
**Contributors**: Olivier Burri (1), Nicolas Chiaruttini (1), Romain Guiet (1)
27+
**Contributors**: Albert Dominguez Mantes (2), Olivier Burri (1), Nicolas Chiaruttini (1), Romain Guiet (1)
2828

2929
This code heavily mirrors functions and design implemented in [QuPath Cellpose](https://github.com/BIOP/qupath-extension-cellpose).
3030

3131
**Affiliations**
3232

3333
(1) EPFL BioImaging and Optics Platform (BIOP)
34+
(2) EPFL Weigert Lab
3435

3536
### If you use this extension, you should cite the following publications
3637

@@ -92,11 +93,27 @@ On macOS or Linux:
9293
where `{HOME}` will be the location of your home directory, typically `/Users/user-name/` on macOS or `/home/user-name/` on Linux.
9394

9495
## Step 2: Install the QuPath Spotiflow extension
96+
### On QuPath 0.6.x
9597

96-
Download the latest `qupath-extension-spotiflow-[version].jar` file from [releases](https://github.com/biop/qupath-extension-spotiflow/releases) and unzip it into your `extensions` directory.
98+
- Open QuPath
99+
- Go under `Extensions -> Manage extensions`
100+
- Expand the `QuPath-BIOP catalog`
97101

98-
If your extensions directory is unset, drag & drop `qupath-extension-spotiflow-[version].jar` onto the main QuPath window. You'll be prompted to select a QuPath user directory.
99-
The extension will then be copied to a location inside that directory.
102+
> Note: if you don't have the **QuPath-BIOP-catalog** installed, please follow the [catalog installation steps](https://github.com/BIOP/qupath-biop-catalog?tab=readme-ov-file#installation)
103+
104+
- Search for `QuPath Spotiflow extension` and click on the green button
105+
- Select the latest version
106+
- Click on `Install`
107+
108+
> Note: If you need to update the extension, click on the ⚙️ button and select the latest version to install.
109+
110+
### On QuPath 0.5.x
111+
112+
Download the latest `qupath-extension-spotiflow-[version].jar` file from [releases](https://github.com/biop/qupath-extension-spotiflow/releases) and copy it into your extensions directory.
113+
114+
If your extensions directory is unset, drag & drop `qupath-extension-spotiflow-[version].jar` onto the main QuPath window.
115+
You'll be prompted to select a QuPath user directory. The extension will then be copied to a location inside that directory.
116+
You finally need to restart QuPath.
100117

101118
<!--
102119
To copy `run-cellpose-qc.py`, go to Extensions > Installed Extensions and click on "Open Extensions Directory". You can place the `run-cellpose-qc.py` in the same folder.
@@ -147,7 +164,7 @@ Running Spotiflow is done via a script and is very similar to the excellent [QuP
147164

148165
You can find a template in QuPath in
149166

150-
`Extensions > Spotiflow > Spotiflow detection script template`
167+
`Extensions > Spotiflow > Spotiflow detection template`
151168

152169
Or you can download the [Spotiflow_detection_template.groovy](src/main/resources/scripts/Spotiflow_detection_template.groovy) script from this repo and open it in the QuPath script editor.
153170

@@ -156,7 +173,7 @@ Or you can download the [Spotiflow_detection_template.groovy](src/main/resources
156173
157174
### Getting all available arguments
158175

159-
All builder options that are implemented are documented [in the Javadoc](https://biop.github.io/qupath-extension-spotiflow/).
176+
All builder options that are implemented are documented [in the Javadoc](https://biop.github.io/qupath-extension-spotiflow/qupath/ext/biop/spotiflow/SpotiflowBuilder.html).
160177
You can pass additional options to `spotiflow` by adding `.addParameter()` before the `.build()` line.
161178

162179
To get the available additional arguments, call the help from the `spotiflow` object using `spotiflow.helpPredict()`

0 commit comments

Comments
 (0)