Skip to content

Commit d3b9b68

Browse files
Improve flow of install page (#274)
# Description Update installation guide: - If I'm installing the bundled app, I don't care about pre-requisites for installing the Python package, so move that section under the "Installing as a Pytho package" section - Modify the header levels, so the second level now only has "Install as Python package", "Install as bundled app", "Next steps". In particular, two sections which are only relevant to the Python package route have been moved down a level to simplify the top level contents. Co-authored-by: Peter Sobolewski <[email protected]>
1 parent 0b183c3 commit d3b9b68

File tree

1 file changed

+4
-16
lines changed

1 file changed

+4
-16
lines changed

docs/tutorials/fundamentals/installation.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,8 @@ This guide will teach you how to do a clean install of **napari** and launch the
2525
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.
2626
```
2727

28-
## Prerequisites
29-
30-
Prerequisites differ depending on how you want to install napari.
28+
## Install as Python package (recommended)
3129

32-
### Prerequisites for installing napari as a Python package
3330
This installation method allows you to use napari from Python to programmatically
3431
interact with the app. It is the best way to install napari and make full use of
3532
all its features.
@@ -42,15 +39,6 @@ You may also want:
4239
- an environment manager like [conda](https://docs.conda.io/en/latest/miniconda.html) or
4340
[venv](https://docs.python.org/3/library/venv.html) **(Highly recommended)**
4441

45-
### Prerequisites for installing napari as a bundled app
46-
This is the easiest way to install napari if you only wish to use it as a standalone GUI app.
47-
This installation method does not have any prerequisites.
48-
49-
[Click here](#install-as-a-bundled-app) to see instructions
50-
for installing the bundled app.
51-
52-
## Install as Python package (recommended)
53-
5442
Python package distributions of napari can be installed via `pip`, `conda-forge`, or from source.
5543

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

155143
<!-- #region -->
156-
## Checking it worked
144+
### Checking it worked
157145

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

180-
## Choosing a different Qt backend
168+
### Choosing a different Qt backend
181169

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

221-
## Using constraints files
209+
### Using constraints files
222210

223211
Since napari 0.4.18, we store constraints files with information about each exact dependency version against which napari was tested.
224212
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.

0 commit comments

Comments
 (0)