Install napari#

Install with Python

Install napari in a Python environment for the most customizable experience.

Install as Python package
Download napari app

A standalone installer for when you want napari without setting up Python first.

Install as an application

If you want to contribute code back into napari, you should follow the development installation instructions in the contributing guide instead.

Install as Python package#

This installation method allows you to use napari from Python to programmatically interact with the app. It is the best way to install napari and make full use of all its features. Python package distributions of napari can be installed via pip, conda-forge, or from source.

It requires:

You may also want:

  • an environment manager like conda or venv (Highly recommended)

New to Python?

New to Python or uncertain about conda, pip, and virtual environments? Here are some resources we recommend:

Choose one of the options below to install napari as a Python package.

If you prefer to manage packages with conda, napari is available on the conda-forge channel. We also recommend this path for users of arm64 macOS machines (Apple Silicon, meaning a processor with a name like “M1”). You can install it with:

conda install -c conda-forge napari pyqt

You can then upgrade to a new version of napari using:

conda update napari

If you want to install napari with PySide6 as the backend you need to install it using

conda install -c conda-forge napari pyside6

Note

In some cases, conda’s default solver can struggle to find out which packages need to be installed for napari. If it takes too long or you get the wrong version of napari (see below), consider:

  1. Overriding your default channels to use only conda-forge by adding --override-channels and specifying the napari and Python versions explicitly. For example, use python=3.11 to get Python 3.11 and napari=0.7.0 to specify the napari version as 0.7.0, the current release.

  2. Switching to the new, faster libmamba solver, by updating your conda (libmamba is the default solver from conda 23.10 onwards):

conda update -n base conda

napari can be installed from PyPI on most macOS, Linux, and Windows systems with Python 3.10-3.14 using pip:

python -m pip install "napari[all]"

You can then upgrade napari to a new version using:

python -m pip install "napari[all]" --upgrade

(See Choosing a different Qt backend below for an explanation of the [all] notation.)

(See Using constraints file for help installing older versions of napari)

To install the latest version with yet to be released features from Github you can use pip:

python -m pip install "git+https://github.com/napari/napari.git#egg=napari[all]"

Checking it worked#

After installation you should be able to launch napari from the command line by running

napari

An empty napari viewer should appear as follows:

/home/runner/work/docs/docs/.venv/lib/python3.12/site-packages/requests/__init__.py:113: RequestsDependencyWarning: urllib3 (2.6.3) or chardet (7.1.0)/charset_normalizer (3.4.6) doesn't match a supported version!
  warnings.warn(
Screenshot of an empty napari viewer, right after launching.

Note

On some platforms, particularly macOS and Windows, there may be a ~30 second delay before the viewer appears on first launch. This is expected and subsequent launches should be quick. However, anti-malware and other security software measures may further delay launches—even after the first launch.

You can check the napari version, to ensure it’s what you expect, for example the current release 0.7.0, using the command: napari --version .

Advanced installation options#

Choosing a different Qt backend#

napari needs a library called Qt to run its user interface (UI). In Python, there are two primary alternative libraries to run this: PyQt6 and PySide6 for Qt6. There is also an older option, PyQt5 for Qt5. By default, we don’t choose for you — simply running python -m pip install napari will not install either. You may already have one installed in your environment through other scientific packages such as Spyder or matplotlib. If neither is available, running napari will result in an error message asking you to install one.

Running python -m pip install "napari[all]" will install the default framework, which is currently PyQt6–but this could change in the future.

To install napari with a specific framework, you can use:

python -m pip install "napari[pyqt6, optional]"    # for PyQt6

# OR
python -m pip install "napari[pyside6, optional]"  # for PySide6

By including optional you will install everything that napari[all] includes, but with the Qt backend of your choice.

Note

If you switch backends, it’s a good idea to pip uninstall the one you’re not using.

Pyside2 is no longer supported

PySide2 is no longer maintained, so we dropped support for it in napari 0.7.0. PyQt5 remains supported, but we recommend the Qt6 backends.

Using constraints files#

Since napari 0.4.18, we store constraints files with information about each exact dependency version against which napari was tested. This could be useful if you need to install napari as a package from PyPI, and prevents creating environments where napari does not start or work properly.

The constraints files are stored in the napari repository under resources/constraints/constraints_py3.10.txt. To find constraints for specific releases, go under the link https://github.com/napari/napari/tree/{tag}/resources/constraints replacing {tag} with the desired napari version.

pip install napari[backend_selection] -c path/to/constraints/file

For example, if you would like to install napari with PyQt6 on python 3.10:

pip install napari[pyqt6, optional] -c constraints_py3.10.txt

Install as an application#

napari can be installed as a standalone application on macOS, Windows, and Linux — no Python knowledge required. This is the simplest way to get started and works best if you want to use napari as a standalone GUI app. Note that some plugins may not be available without a full Python environment.

Select your platform below to download napari 0.7.0 directly:

For earlier versions of the napari app, scroll below the latest release on the napari GitHub releases page. Each release (0.4.15 and above) includes installers for all platforms under the “Assets” section.

Windows#

Download from Github: napari-0.7.0-Windows-x86_64.exe

Double-click the downloaded .exe file to begin setup.

Montage of the napari EXE installer icon with an arrow pointing to the Welcome page of the napari EXE installer on Windows.

Click Next to proceed to the License Agreement. Read the license and click I Agree to continue.

Cropped screenshot of the License Agreement page of the napari EXE installer. A scrollable text area displays the legal text. Three buttons are available: Back, I Agree, and Cancel.

When prompted for an installation type, choose Just Me (recommended — no administrator privileges required):

Cropped screenshot of the Setup Installation Type page of the napari EXE installer. Two options are available: Just Me (recommended), and All Users (requires admin privileges). At the bottom, three buttons Back, Next and Cancel are displayed.

Confirm the installation location (or click Browse to change it) and click Next.

Cropped screenshot of the Choose Install Location page of the napari EXE installer. A text field next to a Browse button shows the default installation path. Additional text below reports the required space for the installation (2.6 GB) and the total space available on disk (61.1 GB). The three buttons at the bottom read Back, Next and Cancel.

Click Install to begin. Click Show details to monitor progress.

Cropped screenshot of the Installation process page of the napari EXE installer. A progress bar at around 95% reads "Setting up the package cache...". A button with the text "Show details" is available below. At the bottom of the dialog, three grayed out buttons read Back, Next, and Cancel.

Once complete, click Finish to close the installer.

Cropped screenshot of the final page of the napari EXE installer. It reports that the installation has finished successfully and that the dialog can be closed by clicking on the Finish button at the bottom.

napari is now installed. Launch it from the Windows Start menu.

napari includes sample images from scikit-image. Use File > Open Sample > napari to open one, or use File > Open (or drag and drop files onto the viewer) to open your own images.

Next, check out our tutorial on the viewer or explore the Usage tab.

macOS#

Download the installer for your Mac:

Double-click the downloaded .pkg file to launch the Installer.

Cropped screenshot of macOS desktop UI showing the icon of the PKG installer file, and an arrow pointing to the Welcome page in the opened PKG installer.

Click Continue to open the Software License Agreement.

Cropped screenshot of the License page in an opened PKG installer, showing the BSD 3-Clause License text and four buttons: Print, Save, Go Back and Continue.

Read the agreement and click Continue again. You will be prompted to agree before installation can proceed.

Cropped screenshot of the License page prompting the user to agree to the napari Software License Agreement. The dialog contains three buttons: Read License, Disagree and Agree.

Click Agree. On the next page, review the disk space required and click Install to begin the standard installation.

Cropped screenshot of the Installation Type page on the PKG installer. It reports the estimated space the installation will use (2.45 GB in this example) and shows four buttons: Change Install Location, Customize, Go Back and Install.

To install to a different location, click Change Install Location… before proceeding. You can also click Customize to adjust optional installation components.

Installation progress is shown in the next window, with status notifications appearing in the top-right corner of your display.

Cropped screenshot of the Installation page of the PKG installer. This page displays a progress bar at a 10%. In the top right corner, an example of a system notification with the text 'Installing packages. This might take a few minutes' is shown

Note

If an error occurs during installation, do not close the installer immediately. Inspect the log via Window > Installer log (or +L), set the Detail Level to Show All Logs, and save a copy. Include this log if you submit an issue.

When installation finishes successfully, you will see “The installation was successful”:

Cropped screenshot of the final page of the PKG installer, Summary, reporting "The installation was successful" with a green check mark icon. A blue Close button is available.

Click Close. napari is now installed and can be launched from Launchpad or found in Finder under 🏠 [User directory] > Applications.

Montage of two cropped screenshots. On the left, the macOS finder icon and the Launchpad icon, highlighted with a red circle. On the right, the opened launchpad UI showing a 4x4 grid of applications icon, with napari appearing in the bottom right corner.

napari includes sample images from scikit-image. Use File > Open Sample > napari to open one, or use File > Open (or drag and drop files onto the viewer) to open your own images.

Next, check out our tutorial on the viewer or explore the Usage tab.

Linux#

Download from Github: napari-0.7.0-Linux-x86_64.sh

Open a terminal, navigate to your downloads folder (cd ~/Downloads), and run:

bash napari-REL-Linux-x86_64.sh  # replace REL with the release version, e.g. 0.7.0

Montage of the SH installer icon on Ubuntu, with an arrow pointing to an open terminal instance with a pre-typed command that reads 'bash napari-0.4.14.dev73-Linux-x86_64.sh'.

Press Enter to display the License Agreement.

Cropped screenshot of the default Ubuntu terminal displaying the welcome paragraphs of the text-based installer of napari for Linux systems.

Read through the agreement. Type yes and press Enter to accept and continue.

Cropped screenshot of the default Ubuntu terminal displaying the first paragraphs of a BSD-3 Clause License text.

Cropped screenshot of the default Ubuntu terminal displaying the last paragraphs of a BSD-3 Clause License text, plus a prompt asking 'Do you accept the license terms?', to which the user must respond 'yes' or 'no'.

You will be shown the default installation location. Press Enter to confirm, or type an absolute path to use a different location. The installation will then begin automatically.

Montage of two instances of the default Ubuntu terminal showing the default installation path, followed by the first extraction steps of the installation process.

When complete, the terminal will display “installation finished. Thank you for installing napari!”.

Cropped screenshot of the default Ubuntu terminal displaying the last steps of the installation process. The last line of text reads 'installation finished'.

napari is now installed. A launcher shortcut should appear in your desktop application menu; under some desktop environments you can also search for “napari” using the search bar.

Full screenshot of the application menu in the Ubuntu desktop environment. A 6x4 grid of application icons includes the napari icon on the third row, third column, highlighted with a red circle.

Full screenshot of the Ubuntu search menu, with the query 'napari', displaying some results which include the application icon for the installed napari.

napari includes sample images from scikit-image. Use File > Open Sample > napari to open one, or use File > Open (or drag and drop files onto the viewer) to open your own images.

Next, check out our tutorial on the viewer or explore the Usage tab.

Plugins#

napari’s functionality can be extended through the use of plugins. Plugins can be installed as Python packages via pip or conda, or directly from within napari using the napari plugin manager.

To explore existing plugins, visit the napari hub. For more details, check out our documentation on finding and installing plugins.

Next steps#

  • To start learning how to use napari, checkout our getting started tutorial

  • If you are interested in contributing to napari, please check our contributing guidelines

  • If you are running into issues or bugs, please open a new issue on our issue tracker

  • If you want help using napari, we are a community partner on the imagesc forum and all usage support requests should be posted on the forum with the tag napari. We look forward to interacting with you there!