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.

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

Added info for conda installation problems #51

Merged
merged 20 commits into from
Jan 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ jobs:
with:
path: napari
repository: napari/napari
# ensure version metadata is proper
fetch-depth: 0

- name: Copy examples to docs folder
run: |
Expand Down
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from jinja2.filters import FILTERS

import napari
from napari._version import __version_tuple__

release = napari.__version__
if "dev" in release:
Expand Down Expand Up @@ -159,6 +160,13 @@

myst_heading_anchors = 3

version_string = '.'.join(str(x) for x in __version_tuple__[:3])

myst_substitutions = {
"napari_conda_version": f"`napari={version_string}`",
"napari_version": version_string,
}

nb_output_stderr = 'show'

panels_add_bootstrap_css = False
Expand Down
18 changes: 17 additions & 1 deletion docs/tutorials/fundamentals/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,20 @@ If you want to install napari with PySide2 as the backend you need to install it

```sh
conda install -c conda-forge "napari=*=*pyside2"
```
```
````

````{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.9` to get
Python 3.9 and {{ napari_conda_version }} to specify the napari version as
{{ napari_version }}, the current release.
2. You can try installing [`mamba`](https://github.com/mamba-org/mamba) in your base
environment with `conda install -n base -c conda-forge mamba` and use its faster solver
by replacing `conda` for `mamba` in the above instructions.
````


Expand All @@ -143,6 +155,10 @@ napari

An empty napari viewer should appear as follows.

````{note}
You can check the napari version, to ensure it's what you expect, for example
the current release {{ napari_version }}, using command: `napari --version` .
````
![macOS desktop with a napari viewer window without any image opened in the foreground, and a terminal in the background with the appropriate conda environment activated (if applicable) and the command to open napari entered.](../assets/tutorials/launch_cli_empty.png)

## Choosing a different Qt backend
Expand Down