Skip to content

Commit

Permalink
switched to pip install of napari[all]
Browse files Browse the repository at this point in the history
  • Loading branch information
niksirbi committed Jun 17, 2024
1 parent 5159230 commit 6f0b424
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 21 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,16 @@ conda create -n movement-env -c conda-forge python=3.11 pytables
conda activate movement-env
```

Then install the `movement` package:
Then install the core `movement` package:
```
pip install movement
```

If you want to use the graphical user interface (GUI), which is provided via
a [`napari`](https://napari.org/) plugin, run these commands instead:
a [`napari`](https://napari.org/) plugin, run this command instead:

```
conda create -n movement-env -c conda-forge python=3.11 pytables napari pyqt
conda activate movement-env
pip install movement[napari]
pip install "movement[napari]"
```

> [!Note]
Expand Down
16 changes: 3 additions & 13 deletions docs/source/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,6 @@ conda create -n movement-env -c conda-forge python=3.11 pytables
conda activate movement-env
```

If you want to use the graphical user interface (GUI), which is provided via
a [`napari`](napari:) plugin, you'd also need to include `napari` and `pyqt`
in the environment:

```sh
conda create -n movement-env -c conda-forge python=3.11 pytables napari pyqt
conda activate movement-env
```


## Install the package

Then install the `movement` package as described below.
Expand All @@ -53,13 +43,13 @@ pip install --upgrade movement
To install the package including the GUI (napari plugin) from PyPI:

```sh
pip install movement[napari]
pip install "movement[napari]"
```
If you have an older version of `movement` installed in the same environment,
you can update to the latest version with:

```sh
pip install --upgrade movement[napari]
pip install --upgrade "movement[napari]"
```
:::

Expand All @@ -70,7 +60,7 @@ and then run from inside the repository:

```sh
pip install -e .[dev] # works on most shells
pip install -e '.[dev]' # works on zsh (the default shell on macOS)
pip install -e ".[dev]" # works on zsh (the default shell on macOS)
```

This will install the package in editable mode, including all `dev` dependencies.
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ entry-points."napari.manifest".movement = "movement.napari:napari.yaml"
"User Support" = "https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement"

[project.optional-dependencies]
# will change to brainglobe-utils[qt]>=0.6 after release
napari = [
"napari[all]>=0.4.19",
# the rest will be replaced by brainglobe-utils[qt]>=0.6 after release
"brainglobe-atlasapi>=2.0.7",
"brainglobe-utils>=0.5",
"qtpy",
Expand Down Expand Up @@ -162,8 +163,6 @@ python =
[testenv]
conda_deps =
pytables
napari>=0.4.19
pyqt
conda_channels =
conda-forge
passenv =
Expand Down

0 comments on commit 6f0b424

Please sign in to comment.