# Octarine NAVis Plugin
This plugin enables [Octarine](https://github.com/schlegelp/octarine)
to visualize [NAVis](https://github.com/navis-org/navis) data such as skeletons, meshes,
volumes, etc.
## Installation
```bash
pip install octarine-navis-plugin -U
```
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`.
```python
import navis
import octarine as oc
# Initialize the viewer
v = oc.Viewer()
# Grab some neurons
n = navis.example_neurons(5, kind='mesh')
# Add them to the viewer
v.add(n)
# Alternatively use the specialized method with additional options
navis.strahler_index(n)
v.clear()
v.add_neurons(n, color_by='strahler_index', palette='viridis')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/navis-org/octarine-navis-plugin",
"name": "octarine-navis-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "octarine navis 3D visualization",
"author": "Philipp Schlegel",
"author_email": "pms70@cam.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/3e/bb/679853e0fceba7a1c89745cbda291dc00d294b6eafd80fde728be00c4657/octarine_navis_plugin-0.1.2.tar.gz",
"platform": null,
"description": "# Octarine NAVis Plugin\nThis plugin enables [Octarine](https://github.com/schlegelp/octarine)\nto visualize [NAVis](https://github.com/navis-org/navis) data such as skeletons, meshes,\nvolumes, etc.\n\n## Installation\n\n```bash\npip install octarine-navis-plugin -U\n```\n\nNote that you will have to install `Octarine` and `NAVis` separately!\nThis is intentional so that you can choose the install options\n(e.g. the Window manager) yourself.\n\n## Usage\n\nThe plugin will automatically be loaded alongside `Octarine` and extends the functionality by:\n\n1. Allowing to pass `navis.Neuron/Lists`, `navis.Volumes` and `skeletor.Skeletons` to the generic `Viewer.add()` method.\n2. Adding a dedicated `Viewer.add_neurons` method with various specialized parameters that shadow the options in `navis.plot3d`.\n\n```python\nimport navis\nimport octarine as oc\n\n# Initialize the viewer\nv = oc.Viewer()\n\n# Grab some neurons\nn = navis.example_neurons(5, kind='mesh')\n\n# Add them to the viewer\nv.add(n)\n\n# Alternatively use the specialized method with additional options\nnavis.strahler_index(n)\nv.clear()\nv.add_neurons(n, color_by='strahler_index', palette='viridis')\n```\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Octarine plugin to visualize NAVis data in 3D.",
"version": "0.1.2",
"project_urls": {
"Changelog": "https://github.com/navis-org/octarine-navis-plugin/releases",
"Documentation": "https://github.com/navis-org/octarine-navis-plugin",
"Homepage": "https://github.com/navis-org/octarine-navis-plugin",
"Source": "https://github.com/navis-org/octarine-navis-plugin"
},
"split_keywords": [
"octarine",
"navis",
"3d",
"visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08cf150fe52bda86b0d6e7b8995a3e63e871ac36e12678f693874a5279d61935",
"md5": "595be7cc20c842e22cf1bf3c9c14e593",
"sha256": "64cce9f774827b4c6190dea2cfe20126da26c28ea28caff2ac5c03080172fecd"
},
"downloads": -1,
"filename": "octarine_navis_plugin-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "595be7cc20c842e22cf1bf3c9c14e593",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22447,
"upload_time": "2024-09-22T16:08:58",
"upload_time_iso_8601": "2024-09-22T16:08:58.965121Z",
"url": "https://files.pythonhosted.org/packages/08/cf/150fe52bda86b0d6e7b8995a3e63e871ac36e12678f693874a5279d61935/octarine_navis_plugin-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ebb679853e0fceba7a1c89745cbda291dc00d294b6eafd80fde728be00c4657",
"md5": "21f3e1d150bcea80d15c579112b7a5d7",
"sha256": "7a06b3341d334420aa3a3ed5cb0b8f4ac57ebec2e93f1c4ae7071ba3be734fd1"
},
"downloads": -1,
"filename": "octarine_navis_plugin-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "21f3e1d150bcea80d15c579112b7a5d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21521,
"upload_time": "2024-09-22T16:09:00",
"upload_time_iso_8601": "2024-09-22T16:09:00.446544Z",
"url": "https://files.pythonhosted.org/packages/3e/bb/679853e0fceba7a1c89745cbda291dc00d294b6eafd80fde728be00c4657/octarine_navis_plugin-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-22 16:09:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "navis-org",
"github_project": "octarine-navis-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "octarine-navis-plugin"
}
JSON
