Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ajitjohnson committed Apr 2, 2024
1 parent 7eb856d commit 2ae1159
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,19 @@ conda activate scimap
```

Install `scimap` directly into an activated virtual environment:

**By default, we recommend installing scimap alongside napari for visualization purposes. Please note that napari requires a GUI toolkit like PyQt. If you encounter any errors due to your operating system, you should install scimap and napari separately, following napari's documentation.**

```python
pip install scimap[napari]
```

**If installation fails due to pyqt6; install scimap without napari.**

```python

pip install scimap

# Install scimap with napari for visualization
# Please note that napari requires a GUI toolkit like PyQt. If you encounter any errors due to your operating system, you should install scimap and napari separately, following their own documentation, and make sure to add them into the same virtual environment, instead of using this command.
pip install scimap[napari]
```

After installation, the package can be imported as:
Expand Down
14 changes: 11 additions & 3 deletions docs/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,22 @@ conda activate scimap
```

Install `scimap` directly into an activated virtual environment:

**By default, we recommend installing scimap alongside napari for visualization purposes. Please note that napari requires a GUI toolkit like PyQt. If you encounter any errors due to your operating system, you should install scimap and napari separately, following napari's documentation.**

```python
pip install scimap[napari]
```

**If installation fails due to pyqt6; install scimap without napari.**

```python
pip install scimap
```

# install scimap with napari for visualization
# Please note that napari requires a GUI toolkit like PyQt. If you encounter any errors due to your operating system, you should install scimap and napari separately, following their own documentation, and make sure to add them into the same virtual environment, instead of using this command.
pip install scimap[napari]
Open python and import scimap

```
>>> import scimap as sm
```

Expand Down

0 comments on commit 2ae1159

Please sign in to comment.