Skip to content

Commit 103a17e

Browse files
authored
Update docs - add hints on starting napari (#724)
1 parent b0440d6 commit 103a17e

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

doc/annotation_tools.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,18 @@ The annotation tools can be started from the napari plugin menu:
1919

2020
You can find additional information on the annotation tools [in the FAQ section](#usage-question).
2121

22+
HINT: If you would like to start napari to use `micro-sam` from the plugin menu, you must start it by activating the environment where `micro-sam` has been installed using:
23+
24+
```bash
25+
$ mamba activate <ENVIRONMENT_NAME>
26+
$ napari
27+
```
28+
2229

2330
## Annotator 2D
2431

2532
The 2d annotator can be started by
26-
- clicking `Annotator 2d` in the plugin menu.
33+
- clicking `Annotator 2d` in the plugin menu after starting `napari`.
2734
- running `$ micro_sam.annotator_2d` in the command line.
2835
- calling `micro_sam.sam_annotator.annotator_2d` in a python script. Check out [examples/annotator_2d.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_2d.py) for details.
2936

@@ -55,7 +62,7 @@ Check out [the video tutorial](https://youtu.be/9xjJBg_Bfuc) for an in-depth exp
5562
## Annotator 3D
5663

5764
The 3d annotator can be started by
58-
- clicking `Annotator 3d` in the plugin menu.
65+
- clicking `Annotator 3d` in the plugin menu after starting `napari`.
5966
- running `$ micro_sam.annotator_3d` in the command line.
6067
- calling `micro_sam.sam_annotator.annotator_3d` in a python script. Check out [examples/annotator_3d.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_3d.py) for details.
6168

@@ -81,7 +88,7 @@ Check out [the video tutorial](https://youtu.be/nqpyNQSyu74) for an in-depth exp
8188
## Annotator Tracking
8289

8390
The tracking annotator can be started by
84-
- clicking `Annotator Tracking` in the plugin menu.
91+
- clicking `Annotator Tracking` in the plugin menu after starting `napari`.
8592
- running `$ micro_sam.annotator_tracking` in the command line.
8693
- calling `micro_sam.sam_annotator.annotator_tracking` in a python script. Check out [examples/annotator_tracking.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_tracking.py) for details.
8794

@@ -107,7 +114,7 @@ Check out [the video tutorial](https://youtu.be/1gg8OPHqOyc) for an in-depth exp
107114
## Image Series Annotator
108115

109116
The image series annotation tool enables running the [2d annotator](#annotator-2d) or [3d annotator](#annotator-3d) for multiple images that are saved in a folder. This makes it convenient to annotate many images without having to restart the tool for every image. It can be started by
110-
- clicking `Image Series Annotator` in the plugin menu.
117+
- clicking `Image Series Annotator` in the plugin menu after starting `napari`.
111118
- running `$ micro_sam.image_series_annotator` in the command line.
112119
- calling `micro_sam.sam_annotator.image_series_annotator` in a python script. Check out [examples/image_series_annotator.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/image_series_annotator.py) for details.
113120

@@ -126,7 +133,7 @@ Check out [the video tutorial](https://youtu.be/HqRoImdTX3c) for an in-depth exp
126133

127134
## Finetuning UI
128135

129-
We also provide a graphical inferface for fine-tuning models on your own data. It can be started by clicking `Finetuning` in the plugin menu.
136+
We also provide a graphical inferface for fine-tuning models on your own data. It can be started by clicking `Finetuning` in the plugin menu after starting `napari`.
130137

131138
**Note:** if you know a bit of python programming we recommend to use a script for model finetuning instead. This will give you more options to configure the training. See [these instructions](#training-your-own-model) for details.
132139

doc/installation.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,23 @@ You can follow the instructions [here](https://mamba.readthedocs.io/en/latest/in
2222
$ mamba install -c pytorch -c conda-forge micro_sam
2323
```
2424
or you can create a new environment (here called `micro-sam`) via:
25+
2526
```bash
2627
$ mamba create -c pytorch -c conda-forge -n micro-sam micro_sam
2728
```
29+
2830
if you want to use the GPU you need to install PyTorch from the `pytorch` channel instead of `conda-forge`. For example:
31+
2932
```bash
3033
$ mamba create -c pytorch -c nvidia -c conda-forge -n micro-sam micro_sam pytorch pytorch-cuda=12.1
3134
```
35+
36+
NOTE: If you create a new enviroment (eg. here called `micro-sam`), you must activate the environment using
37+
38+
```bash
39+
$ mamba activate micro-sam
40+
```
41+
3242
You may need to change this command to install the correct CUDA version for your system, see [https://pytorch.org/](https://pytorch.org/) for details.
3343

3444

doc/start_page.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,17 @@ If you run into any problems or have questions please [open an issue](https://gi
2222
## Quickstart
2323

2424
You can install `micro_sam` via mamba:
25-
```
25+
```bash
2626
$ mamba install -c conda-forge micro_sam
2727
```
2828
We also provide installers for Windows and Linux. For more details on the available installation options, check out [the installation section](#installation).
2929

30-
After installing `micro_sam` you can start napari and select the annotation tool you want to use from `Plugins -> SegmentAnything for Microscopy`. Check out the [quickstart tutorial video](https://youtu.be/gcv0fa84mCc) for a short introduction and [the annotation tool section](#annotation-tools) for details.
30+
After installing `micro_sam`, you can start napari from within your environment using
31+
32+
```bash
33+
$ napari
34+
```
35+
After starting napari, you can select the annotation tool you want to use from `Plugins -> SegmentAnything for Microscopy`. Check out the [quickstart tutorial video](https://youtu.be/gcv0fa84mCc) for a short introduction and [the annotation tool section](#annotation-tools) for details.
3136

3237
The `micro_sam` python library can be imported via
3338

0 commit comments

Comments
 (0)