Skip to content

Commit 94b6e9f

Browse files
Update installer instructions
1 parent e5b7f2e commit 94b6e9f

1 file changed

Lines changed: 51 additions & 36 deletions

File tree

doc/installation.md

Lines changed: 51 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Installation
22

3-
`micro_sam` requires the following dependencies:
3+
We provide three different ways of installing `micro_sam`:
4+
- [From conda](#from-conda) is the recommended way if you want to use all functionality.
5+
- [From source](#from-source) for setting up a development environment to change and potentially contribute to our software.
6+
- [From installer](#from-installer) to install without having to use conda. This mode of installation is still experimental! It only provides the annotation tools and does not enable model finetuning.
7+
8+
Our software requires the following dependencies:
49
- [PyTorch](https://pytorch.org/get-started/locally/)
510
- [SegmentAnything](https://github.com/facebookresearch/segment-anything#installation)
611
- [elf](https://github.com/constantinpape/elf)
@@ -14,7 +19,7 @@
1419
$ conda install -c conda-forge micro_sam
1520
```
1621

17-
This command will only install the `micro_sam` library without the required dependencies for the annotation functionality and training.
22+
This command will not install the required dependencies for the annotation tools and for training / finetuning.
1823
To use the annotation functionality you also need to install `napari`:
1924
```
2025
$ conda install -c conda-forge napari pyqt
@@ -27,40 +32,6 @@ $ conda install -c conda-forge torch_em
2732
In case the installation via conda takes too long consider using [mamba](https://mamba.readthedocs.io/en/latest/).
2833
Once you have it installed you can simply replace the `conda` commands with `mamba`.
2934

30-
## From installer
31-
32-
We also provide installers for Linux, Mac and Windows:
33-
- [Linux](https://owncloud.gwdg.de/index.php/s/Cw9RmA3BlyqKJeU)
34-
- [Mac](https://owncloud.gwdg.de/index.php/s/7YupGgACw9SHy2P)
35-
- [Windows](https://owncloud.gwdg.de/index.php/s/1iD1eIcMZvEyE6d)
36-
37-
Note that these installers are stil experimental and not yet fully tested.
38-
If you encounter problems with them then please consider installing `micro_sam` via [conda](#from-conda) instead.
39-
40-
**Linux Installer:**
41-
42-
To use the installer:
43-
- Unpack the you have downloaded.
44-
- Make the installer executable: `$ chmod +x micro_sam-0.2.0post1-Linux-x86_64.sh`
45-
- Run the installer: `$./micro_sam-0.2.0post1-Linux-x86_64.sh$`
46-
- You can select where to install `micro_sam` during the installation. By default it will be installed in `$HOME/micro_sam`.
47-
- The installer will unpack all `micro_sam` files to the installation directory.
48-
- After the installation you can start the annotator with the command `.../micro_sam/bin/micro_sam.annotator`.
49-
- To make it easier to run the annotation tool you can add `.../micro_sam/bin` to your `PATH` or set a softlink to `.../micro_sam/bin/micro_sam.annotator`.
50-
51-
**Mac Installer:**
52-
53-
To use the Mac installer you will need to enable installing unsigned applications. Please follow [the instructions for 'Disabling Gatekeeper for one application only' here](https://disable-gatekeeper.github.io/).
54-
<!---
55-
Alternative link on how to disable gatekeeper.
56-
https://www.makeuseof.com/how-to-disable-gatekeeper-mac/
57-
-->
58-
59-
TODO detailed instruction
60-
61-
**Windows Installer:**
62-
63-
TODO
6435

6536
## From source
6637

@@ -105,3 +76,47 @@ $ pip install -e .
10576
- Install `micro_sam` by running `pip install -e .` in this folder.
10677
- **Note:** we have seen many issues with the pytorch installation on MAC. If a wrong pytorch version is installed for you (which will cause pytorch errors once you run the application) please try again with a clean `mambaforge` installation. Please install the `OS X, arm64` version from [here](https://github.com/conda-forge/miniforge#mambaforge).
10778
- Some MACs require a specific installation order of packages. If the steps layed out above don't work for you please check out the procedure described [in this github issue](https://github.com/computational-cell-analytics/micro-sam/issues/77).
79+
80+
81+
## From installer
82+
83+
We also provide installers for Linuxand Windows:
84+
- [Linux](https://owncloud.gwdg.de/index.php/s/Cw9RmA3BlyqKJeU)
85+
- [Windows](https://owncloud.gwdg.de/index.php/s/1iD1eIcMZvEyE6d)
86+
<!---
87+
- [Mac](https://owncloud.gwdg.de/index.php/s/7YupGgACw9SHy2P)
88+
-->
89+
**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.
90+
91+
If you encounter problems with them then please consider installing `micro_sam` via [conda](#from-conda) instead.
92+
93+
**Linux Installer:**
94+
95+
To use the installer:
96+
- Unpack the zip file you have downloaded.
97+
- Make the installer executable: `$ chmod +x micro_sam-0.2.0post1-Linux-x86_64.sh`
98+
- Run the installer: `$./micro_sam-0.2.0post1-Linux-x86_64.sh$`
99+
- You can select where to install `micro_sam` during the installation. By default it will be installed in `$HOME/micro_sam`.
100+
- The installer will unpack all `micro_sam` files to the installation directory.
101+
- After the installation you can start the annotator with the command `.../micro_sam/bin/micro_sam.annotator`.
102+
- To make it easier to run the annotation tool you can add `.../micro_sam/bin` to your `PATH` or set a softlink to `.../micro_sam/bin/micro_sam.annotator`.
103+
104+
<!---
105+
**Mac Installer:**
106+
107+
To use the Mac installer you will need to enable installing unsigned applications. Please follow [the instructions for 'Disabling Gatekeeper for one application only' here](https://disable-gatekeeper.github.io/).
108+
109+
Alternative link on how to disable gatekeeper.
110+
https://www.makeuseof.com/how-to-disable-gatekeeper-mac/
111+
112+
TODO detailed instruction
113+
-->
114+
115+
**Windows Installer:**
116+
117+
- Unpack the zip file you have downloaded.
118+
- Run the installer by double clicking on it.
119+
- Choose installation type: `Just Me(recommended)` or `All Users(requires admin privileges)`.
120+
- Choose installation path. By default it will be installed in `C:\Users\<Username>\micro_sam` for `Just Me` installation or in `C:\ProgramData\micro_sam` for `All Users`.
121+
- The installer will unpack all micro_sam files to the installation directory.
122+
- After the installation you can start the annotator by double clicking on `.\micro_sam\Scripts\micro_sam.annotator.exe` or with the command `.\micro_sam\Scripts\micro_sam.annotator.exe` from the Command Prompt.

0 commit comments

Comments
 (0)