Installation guide

You have three choices to install NA, but all of them require you to install something to deal with virtual Python environments. In the following instruction, we will use Miniconda (https://repo.anaconda.com/miniconda/) but you are free to use the one you are the most comfortable with.

Create a new environment with Python 3.10 or higher, and activate it. Then you can install Napari with the command: pip install napari[all]. You can check that Napari is correctly installed by running napari in your terminal.

Example:

conda create -n napari-nucleation-analyzer -y python=3.12
conda activate napari-nucleation-analyzer
pip install "napari[all]"

1. Install a frozen dev version

  • Start by going on the GitHub repository of napari-nucleation-analyzer (https://github.com/MontpellierRessourcesImagerie/napari-nucleation-analyzer).

  • Click on the green button Code and click on Download ZIP.

  • Decompress the ZIP file and move its content to somewhere you won’t delete it by mistake.

  • In your terminal with the environment activated, run the command pip install -e path/to/napari-nucleation-analyzer where path/to/napari-nucleation-analyzer is the path to the folder you just downloaded. Depending on your system, you can simply drag and drop the folder in your terminal to get the path.

2. Install an updatable dev version

  • If you wish to go with this option, you need to have git installed on your system. If you don’t have it, you can download it from https://git-scm.com/downloads. To check if you have it, run the command git --version in any terminal.

  • In your terminal with the environment activated, run the command pip install -e git+https://github.com/MontpellierRessourcesImagerie/napari-nucleation-analyzer.git

3. Install the stable version from PyPI

  • In your terminal with the environment activated, run the command pip install napari-nucleation-analyzer

4. Final check

  • To make sure that NA is correctly installed, you can run napari in your terminal.

  • Then click on the “Plugins” menu in the top-bar manu of Napari. In there you should see:

    • Calibration Tool > Scale Tool

    • Nucleation analyzer

  • If this is the case, everything is correctly installed and you can start using NA.