You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/installation.md
+51-36Lines changed: 51 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,11 @@
1
1
# Installation
2
2
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.
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/).
- Install `micro_sam` by running `pip install -e .` in this folder.
106
77
-**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).
107
78
- 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).
**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/).
- 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