Skip to content

Commit d328f51

Browse files
committed
doc installation
1 parent c293cb6 commit d328f51

File tree

3 files changed

+61
-3
lines changed

3 files changed

+61
-3
lines changed

docs/Installation.md

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# Installation
22

3+
EpiCure is a napari plugin.
4+
Depending on your familiarity with python, you can install it in several ways:
5+
6+
* [In a new virtual environment (recommend)](#from-a-virtual-environment-recommended): Usually, each plugin is installed in its own python environment to avoid compatibility issues of its dependencies. Below, we detailled all the installation steps so that anybody could perform this installation.
7+
8+
* [In already installed Napari](#from-napari-interface): if you already have an environement with napari installed (ideally with python 3.9 or 3.10), and are not afraid of compatibility issues, you can directly use it and add EpiCure to it.
9+
10+
* [In a full graphical way](#with-graphical-interface): if you are unconfortable with the installation of a virtual environment, there is a possibility to do all the installation through graphical interfaces.
11+
12+
313
## From Napari interface
414
EpiCure is a Napari plugin, in python.
5-
You can install it either through an already installed Napari instance by going in Napari to `Plugins>Install/Uninstall`, search for `Epicure` and click `Install`.
15+
You can install it through an already installed Napari instance by going in Napari to `Plugins>Install/Uninstall`, search for `Epicure` and click `Install`.
616
You could have version issues between the different modules installed in your environment and EpiCure dependencies, in this case it is recommended to create a new virtual environnement specific for EpiCure.
717

818

@@ -46,10 +56,58 @@ pip install epicure
4656
```
4757
to install EpiCure with its dependencies.
4858

49-
**Step 4: Open napari and start using EpiCure **
59+
### Step 4: Open napari and start using EpiCure
5060
You can open napari by writing `napari` in the terminal.
5161
It is often slow to open the first time but that’s it.
5262

5363
You can start EpiCure by going in `Plugins>EpiCure>Start Epicure` and follow the [Usage online documentation](./Start-epicure.md) to know how to use it.
5464

55-
## Compatibility/Dependencies
65+
66+
## With graphical interface
67+
68+
### Step 1: Napari installation through a graphical interface
69+
70+
Download the bundle version of napari 0.5.4:
71+
72+
* [Linux version](https://github.com/napari/napari/releases/download/v0.5.4/napari-0.5.4-Linux-x86_64.sh)
73+
* [Windows x86](https://github.com/napari/napari/releases/download/v0.5.4/napari-0.5.4-Windows-x86_64.exe)
74+
75+
* [MacOS arm64 (apple chip, from M1 and after)](https://github.com/napari/napari/releases/download/v0.5.4/napari-0.5.4-macOS-arm64.pkg) :fontawesome-solid-triangle-exclamation:
76+
* [MacOS x86 (Intel chip, before M1)](https://github.com/napari/napari/releases/download/v0.5.4/napari-0.5.4-macOS-x86_64.pkg):fontawesome-solid-triangle-exclamation:
77+
78+
!!! warning "napari bundle doesn't open on MacOS"
79+
On MacOS, the bundle version 0.5.4 might not work (after installation, it doesn't open, see more in [imagesc forum](https://forum.image.sc/t/bundle-napari-0-5-4-on-macos-permission-denied/117259)). In this case, proceed to the "normal" installation, or install the [latest napari bundle](https://napari.org/stable/tutorials/fundamentals/installation_bundle_conda.html#macos-bundle) (without epyseg then).
80+
81+
Double-click on the executable.
82+
It will open an installer program, that you can simply follow step by step.
83+
You can keep all the default options that are proposed by the installation program.
84+
When the installation is finished (it takes some time), a shortcut icon should have been created in your desktop.
85+
86+
![snapshots installation](./imgs/bundle_installation.png)
87+
88+
All these bundles come from napari github, [release of version 0.5.4](https://github.com/napari/napari/releases/tag/v0.5.4).
89+
The installation steps for each OS are described [here](https://napari.org/stable/tutorials/fundamentals/installation_bundle_conda.html).
90+
91+
??? note "Why napari version 0.5.4"
92+
We chose this version as it is the last one in Python 3.9, the following ones are with Python > 3.11, to have all options available (including Epyseg which is limited to version <3.11).
93+
You can still download the latest bundle of napari if you wish, and then use the napari console Terminal to fix dependencies install, or not use some options (Epyseg).
94+
95+
### Step 2: EpiCure installation through a graphical interface
96+
When the installation is over, double-click on the napari icon and wait for napari window to open (it can take a few minutes).
97+
When napari is open, go to `Plugins>Install/Uninstall` to open the plugin manager.
98+
In the window that appears, search for `epicure` and click Install.
99+
Wait for the installation to finish (it takes some time), and restart napari.
100+
101+
![snapshots plugin installation](./imgs/bundle_plugin_install.png)
102+
103+
If you want to install a specific version of EpiCure, click on `Installation info` to get the list of available versions.
104+
**Restart napari after the plugin installation**.
105+
106+
### Step 3: Use EpiCure from Napari
107+
Open Napari by double-clicking on the icon created by the installation in step 1.
108+
109+
In the napari window, start EpiCure by going in `Plugins>EpiCure>Start Epicure` and follow the [Usage online documentation](./Start-epicure.md) to know how to use it.
110+
111+
??? tip "Updating some dependencies version"
112+
If you need to change some dependencies version, you can do so by opening the napari Terminal by clicking the icon :material-console-line: at the bottom left of the napari window. Then write `pip install modulename==versionnumber` to install the `modulename` library with the given version number.
113+

docs/imgs/bundle_installation.png

78.7 KB
Loading
100 KB
Loading

0 commit comments

Comments
 (0)