Skip to content

Commit 927e6cf

Browse files
Add gui description to doc
1 parent 94b6e9f commit 927e6cf

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

doc/annotation_tools.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,18 @@ They are built using [napari](https://napari.org/stable/) and [magicgui](https:/
1717
If you are not familiar with napari yet, [start here](https://napari.org/stable/tutorials/fundamentals/quick_start.html).
1818
The `micro_sam` tools use [the point layer](https://napari.org/stable/howtos/layers/points.html), [shape layer](https://napari.org/stable/howtos/layers/shapes.html) and [label layer](https://napari.org/stable/howtos/layers/labels.html).
1919

20-
The annotation tools are explained in detail below. In addition to the documentation we provide [video tutorials](https://www.youtube.com/watch?v=ket7bDUP9tI&list=PLwYZXQJ3f36GQPpKCrSbHjGiH39X4XjSO) for the tools.
20+
The annotation tools are explained in detail below. In addition to the documentation here we also provide [video tutorials](https://www.youtube.com/watch?v=ket7bDUP9tI&list=PLwYZXQJ3f36GQPpKCrSbHjGiH39X4XjSO).
2121

2222

23+
## Starting via GUI
24+
25+
The annotation toools can be started from a central GUI, which can be started with the command `$ micro_sam.annotator` or using the executable [from an installer](#from-installer).
26+
27+
In the GUI you can select with of the four annotation tools you want to use:
28+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/micro-sam/master/doc/images/micro-sam-gui.png">
29+
30+
And after selecting them a new window will open where you can select the input file path and other optional parameter. Then click the top button to start the tool. **Note: If you are not starting the annotation tool with a path to pre-computed embeddings then it can take several minutes to open napari after pressing the button because the embeddings are being computed.**
31+
2332

2433
## Annotator 2D
2534

doc/images/micro-sam-gui.png

15.7 KB
Loading

doc/installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ We also provide installers for Linuxand Windows:
8686
<!---
8787
- [Mac](https://owncloud.gwdg.de/index.php/s/7YupGgACw9SHy2P)
8888
-->
89+
8990
**The installers are stil experimental and not fully tested.** Mac is not supported yet, but we are working on also providing an installer for it.
9091

9192
If you encounter problems with them then please consider installing `micro_sam` via [conda](#from-conda) instead.

0 commit comments

Comments
 (0)