Skip to content

Commit

Permalink
Fix Pip install instructions for ZSH
Browse files Browse the repository at this point in the history
The package and optional dependencies group string must be quoted for ZSH.
  • Loading branch information
yoda-vid committed Apr 4, 2023
1 parent eacf7b7 commit 975561d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mm
Or install using Pip (virtual environment [recommended](https://realpython.com/python-virtual-environments-a-primer/)):

```shell
pip install magellanmapper[most] --extra-index-url https://pypi.fury.io/dd8/
pip install "magellanmapper[most]" --extra-index-url https://pypi.fury.io/dd8/
```

The extra index accesses a few [customized dependencies](docs/install.md#custom-packages) for MagellanMapper.
Expand Down Expand Up @@ -82,4 +82,4 @@ To try out functions with sample images, download any of these files:

Licensed under the open-source [BSD-3 license](LICENSE.txt)

Author: David Young, 2017, 2022, Stephan Sanders Lab
Author: David Young, 2017, 2023, Stephan Sanders Lab
4 changes: 2 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The `mm` entry points was added in v1.6.0 to facilitate launching from installed
Install using Pip with Python >= 3.6 (see [Python versions](#python-version-support); [virtual environment](https://realpython.com/python-virtual-environments-a-primer/) recommended):

```shell
pip install magellanmapper[most] --extra-index-url https://pypi.fury.io/dd8/
pip install "magellanmapper[most]" --extra-index-url https://pypi.fury.io/dd8/
```

The `most` group installs the GUI and file import tools (see [optional dependencies below](#optional-installation-groups)). The extra index accesses a few [customized dependencies](#custom-packages) for MagellanMapper.
Expand All @@ -65,7 +65,7 @@ conda env create -n mag -f environment.yml
- Or Pip:

```shell
pip install -e .[most] --extra-index-url https://pypi.fury.io/dd8/
pip install -e ".[most]" --extra-index-url https://pypi.fury.io/dd8/
```

MagellanMapper can be run using `mm` and `mm-cli` as above, or through the run script:
Expand Down

0 comments on commit 975561d

Please sign in to comment.