Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve flow of install page #274

Merged
merged 2 commits into from
Nov 23, 2023
Merged

Improve flow of install page #274

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b8d239
Improve flow of install page
dstansby Nov 20, 2023
2830d10
Merge branch 'main' into improve-install-page
psobolewskiPhD Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions docs/tutorials/fundamentals/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,8 @@ This guide will teach you how to do a clean install of **napari** and launch the
If you want to contribute code back into napari, you should follow the [development installation instructions in the contributing guide](https://napari.org/developers/contributing.html) instead.
```

## Prerequisites

Prerequisites differ depending on how you want to install napari.
## Install as Python package (recommended)

### Prerequisites for installing napari as a 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.
Expand All @@ -42,15 +39,6 @@ You may also want:
- an environment manager like [conda](https://docs.conda.io/en/latest/miniconda.html) or
[venv](https://docs.python.org/3/library/venv.html) **(Highly recommended)**

psobolewskiPhD marked this conversation as resolved.
Show resolved Hide resolved
### Prerequisites for installing napari as a bundled app
This is the easiest way to install napari if you only wish to use it as a standalone GUI app.
This installation method does not have any prerequisites.

[Click here](#install-as-a-bundled-app) to see instructions
for installing the bundled app.

## Install as Python package (recommended)

Python package distributions of napari can be installed via `pip`, `conda-forge`, or from source.

````{important}
Expand Down Expand Up @@ -153,7 +141,7 @@ python -m pip install "git+https://github.com/napari/napari.git#egg=napari[all]"
````

<!-- #region -->
## Checking it worked
### Checking it worked

After installation you should be able to launch napari from the command line by
simply running
Expand All @@ -177,7 +165,7 @@ launches should be quick. However, anti-malware and other security software
measures may further delay launches—even after the first launch.
````

## Choosing a different Qt backend
### Choosing a different Qt backend

napari needs a library called [Qt](https://www.qt.io/) to run its user interface
(UI). In Python, there are two alternative libraries to run this, called
Expand Down Expand Up @@ -218,7 +206,7 @@ If you switch backends, it's a good idea to `pip uninstall` the one
you're not using.
```

## Using constraints files
### 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.
Expand Down