Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
schlegelp committed Aug 16, 2024
1 parent 479ffd7 commit 28dab77
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,16 @@ volumes, etc.
pip install octarine-navis-plugin -U
```

Note that you will have to install `Octarine` and `NAVis` separately.
This is intentional to keep the dependencies light.

Note that you will have to install `Octarine` and `NAVis` separately!
This is intentional so that you can choose the install options
(e.g. the Window manager) yourself.

## Usage

The plugin will automatically be loaded alongside `Octarine` and extends the functionality by:

1. Allowing to pass `navis.Neuron/Lists`, `navis.Volumes` and `skeletor.Skeletons` to the generic `Viewer.add()` method.
2. Adding a dedicated `Viewer.add_neurons` method with
various specialized parameters that shadow the options in `navis.plot3d`.
2. Adding a dedicated `Viewer.add_neurons` method with various specialized parameters that shadow the options in `navis.plot3d`.

```python
import navis
Expand Down

0 comments on commit 28dab77

Please sign in to comment.