|
1 | 1 | # Installation |
2 | 2 |
|
3 | | -We provide three different ways of installing `micro_sam`: |
| 3 | +There are three ways to install `micro_sam`: |
4 | 4 | - [From mamba](#from-mamba) is the recommended way if you want to use all functionality. |
5 | 5 | - [From source](#from-source) for setting up a development environment to use the latest version and be able to change and 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: |
9 | | -- [PyTorch](https://pytorch.org/get-started/locally/) |
10 | | -- [SegmentAnything](https://github.com/facebookresearch/segment-anything#installation) |
11 | | -- [elf](https://github.com/constantinpape/elf) |
12 | | -- [torch_em](https://github.com/constantinpape/torch-em) |
13 | | -- [napari](https://napari.org/stable/) (for the interactive annotation tools) |
14 | | - |
| 6 | +- [From installer](#from-installer) to install without having to use conda (supported platforms: Windows and Linux, only for CPU users). |
15 | 7 |
|
16 | 8 | ## From mamba |
17 | 9 |
|
18 | | -[mamba](https://mamba.readthedocs.io/en/latest/) is a drop-in replacement for conda, but is much faster than it. |
| 10 | +[mamba](https://mamba.readthedocs.io/en/latest/) is a drop-in replacement for conda, but much faster. |
19 | 11 | While the steps below may also work with `conda`, we highly recommend using `mamba`. |
20 | | -You can follow the instrutions [here](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) to install `mamba`. |
| 12 | +You can follow the instructions [here](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) to install `mamba`. |
| 13 | + |
| 14 | +**IMPORTANT**: Make sure to avoid installing anything in the base environment. |
21 | 15 |
|
22 | | -`micro_sam` can then be installed in an existing environment via |
| 16 | +`micro_sam` can be installed in an existing environment via: |
23 | 17 | ``` |
24 | 18 | $ mamba install -c conda-forge micro_sam |
25 | 19 | ``` |
26 | | -or you can create a new environment (here called `micro-sam`) via |
| 20 | +or you should create a new environment (here called `micro-sam`) via: |
27 | 21 | ``` |
28 | 22 | $ mamba create -c conda-forge -n micro-sam micro_sam |
29 | 23 | ``` |
|
0 commit comments