Skip to content

Commit 436fcb3

Browse files
committed
doc install
1 parent cd4339e commit 436fcb3

1 file changed

Lines changed: 38 additions & 21 deletions

File tree

docs/Installation.md

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,58 @@
11
# Installation
22

3+
FishFeats is distributed in a pip module and can be installed as:
4+
```
5+
pip install fishfeats
6+
```
7+
in a virtual environment (python 3.10 recommended).
8+
9+
If you are not familiar with the procedure, here are two options for installation with more details:
10+
311
[**Standard installation**](#standard-installation): You can install napari and `FishFeats` by creating/using a python virtual environment (**recommended**).
412

513
[**Easier installation**](#easier-installation): If you have no python virtual environment experience and want to avoid it, you can install napari through the "bundle" distribution.
614
The bundles come with an installer program for Windows and MacOS systemso this allow for an easy installation (everything will be done through graphical interfaces), but allows for less control/flexibility.
715

816
## Standard installation
17+
To install FishFeat you need to install napari first.
18+
Napari is Python based and you need to install Python management package if you don't have one already.
19+
You first need to install that (few minutes to 10min), then create a virtual environment and install napari and fishfeats (less than 5 min).
20+
921
### From napari interface
1022
FishFeats is a napari plugin, in python. You can install it either through an already installed napari instance by going in napari to `Plugins>Install/Uninstall`, search for `FishFeats` and click `Install`.
11-
You could have version issues between the different modules installed in your environment and FishFeats dependencies, in this case it is recommended to create a new virtual environnement specific for FishFeats.
23+
You could have version issues between the different modules installed in your environment and FishFeats dependencies, in this case it is recommended to create a new virtual environment specific for FishFeats.
1224

13-
### From virtual environnement
14-
To install FishFeats, you should create a new virtual environnement or activate an exisiting compatible one.
25+
### From virtual environnement (recommended)
1526

16-
#### Create a new virtual environement
17-
You can create a virtual environement [with venv](https://www.geeksforgeeks.org/create-virtual-environment-using-venv-python/) or mamba/conda/miniforge/anaconda depending on what you have on your computer (you may need to install one of them if you don't have any yet. In this case, to [install miniforge](https://kirenz.github.io/codelabs/codelabs/miniforge-setup/#0) or to install mamba, see [here](https://informatics.fas.harvard.edu/resources/tutorials/installing-command-line-software-conda-mamba/). If you prefer to install anaconda (slower), see here: [on windows](https://www.geeksforgeeks.org/how-to-install-anaconda-on-windows/), [on macOS](https://www.geeksforgeeks.org/installation-guide/how-to-install-anaconda-on-macos/?ref=ml_lbp) or [on linux](https://www.geeksforgeeks.org/how-to-install-anaconda-on-linux/) ).
27+
**Step 1 : install a Python management package (if you don't have one already).**
28+
You have different options, but you have to choose one:
29+
- Miniforge (**recommended**): fast, free but no interface. Follow the detailled steps here to [install miniforge](https://kirenz.github.io/codelabs/codelabs/miniforge-setup/#0)
30+
- venv: fast and simple install in general, no interface. See [tutorial here](https://www.geeksforgeeks.org/create-virtual-environment-using-venv-python/)
31+
- Mamba: fast, free but no interface. See [here](https://informatics.fas.harvard.edu/resources/tutorials/installing-command-line-software-conda-mamba/)
32+
- Anaconda: a sort of interface, works well on MacOS and Windows but slow and might not stay free to all. See here: [on windows](https://www.geeksforgeeks.org/how-to-install-anaconda-on-windows/), [on macOS](https://www.geeksforgeeks.org/installation-guide/how-to-install-anaconda-on-macos/?ref=ml_lbp) or [on linux](https://www.geeksforgeeks.org/how-to-install-anaconda-on-linux/) ).
33+
34+
**Step 2 : Create a virtual environment with that python management package.**
35+
Once you have installed such Python management package, they generally create one environment (=call env) called base but you should not install anything in that env.
1836

19-
Then use the conda/Anaconda interface to create a new virtual environement with the desired python version, or [through the Terminal](https://www.geeksforgeeks.org/set-up-virtual-environment-for-python-using-anaconda/).
37+
- You need to create an environment where you will install fishfeats and napari. To do so you first open the terminal, then you can write `conda env list` to list all your env.
38+
If you don’t already have one env for fishfeats you can create one by : ```conda create -n fishfeats_env python=3.10```
39+
It will install python 3.10 and create an environment called `fishfeats_env`.
2040

21-
For example, in a terminal, once conda is installed, you can create a new environnement by typing:
22-
```
23-
conda create -n fishfeats_env python=3.10
24-
```
41+
- Then you need to activate that environment (=like entering or opening it) by writing : ```conda activate fishfeats_env```
2542

26-
#### Install FishFeats
27-
Once you have created/identified a virtual environnement, type in the terminal:
28-
```
29-
conda activate fishfeats_env
30-
```
31-
to activate it (and start working in that environnement).
43+
- Then you can install napari and fishfeats and all the depencies they need : `pip install fishfeats`.
44+
It takes a bit of time, be patient. Congrats and see you in Step 3 then.
3245

33-
Type in the activated environnement window:
46+
**Step 3: Open napari**
47+
You can open napari by writing `napari` in the terminal.
48+
It is often slow to open the first time but that’s it.
49+
3450

35-
```
36-
pip install fishfeats
37-
```
38-
to install FishFeats.
51+
**Extra information:**
52+
53+
- you can create more environment, they are rather light in size. Be careful because with Python, and napari of course, plugin and librairies are often dependent on many other to properly works and very often, installing a new one can create major issues in the environment that was previously working....
54+
55+
- to logout, you can just close the terminal. To come back to FishFeats, you can open the terminal, enter `conda activate fishfeats_env`, `napari`
3956

4057
!!! warning "Installation of dependencies"
4158
FishFeats depends on a lot of external librairies, some under active development and others are not anymore mainteined. We tried to put few constraints on the librairies version to allow for flexibility in the install, but also to identify which ones should be limited. In the future, there could some trouble on installing. Don't hesitate to look at our [Trouble shooting page](./Known-errors-and-solutions.md), where we listed some environment configurations that worked and could thus be reproduced.

0 commit comments

Comments
 (0)