Skip to content

Latest commit

 

History

History
132 lines (103 loc) · 7.91 KB

README.md

File metadata and controls

132 lines (103 loc) · 7.91 KB
Raw

Documentation Status Tests Run notebooks Coverage Status Open In Colab DOI Downloads

NAVis is a Python 3 library for Neuron Analysis and Visualization.

Documentation

NAVis is on ReadTheDocs.

Features

  • works as Jupyter notebook, script or from terminal
  • support for various neuron types: skeletons, meshes, dotprops, voxels
  • 2D (matplotlib) and 3D (vispy, plotly or k3d) plotting
  • neuron surgery: cutting, stitching, pruning, rerooting, intersections, ...
  • morphometrics: Strahler analysis, cable length, volume, tortuosity, ...
  • compare & cluster by morphology (e.g. NBLAST, persistence, form factor) and connectivity
  • transform data between template brains (support for e.g. HDF5, CMTK, Elastix and thin plate spline transforms)
  • load neurons directly from neuPrint, neuromorpho.org and others
  • simulate neurons and networks using the NEURON simulator
  • interface with Blender 3D for high quality renderings
  • interface with R neuron libraries (e.g. nat, rcatmaid, elmr)
  • import-export from/to SWC, neuroglancer's "precomputed" format and more
  • scalable thanks to out-of-the-box support for multiprocessing
  • designed to be extensible - see for example pymaid

Getting started

See the documentation for detailed installation instructions, tutorials and examples. For the impatient:

pip3 install 'navis[all]'

which includes all optional extras providing features and/or performance improvements. Currently, this is igraph, pathos, shapely, kdtree, hash, flybrains, cloudvolume, meshes, and vispy-default.

3D plotting from a python REPL is provided by vispy, which has a choice of backends. Different backends work best on different combinations of hardware, OS, python distribution, and REPL, so there may be some trial and error involved. vispy's backends are listed here, and each can be installed as a navis extra, e.g. pip3 install 'navis[vispy-pyqt6]'.

movie

Changelog

A summary of changes can be found here.

NAVis & friends

NAVis comes with batteries included but is also highly extensible. Some libraries built on top of NAVis:

  • flybrains provides templates and transforms for Drosophila brains to use with navis
  • pymaid pulls and pushes data from/to CATMAID servers
  • fafbseg contains tools to work with auto-segmented data for the FAFB EM dataset including FlyWire

Who uses NAVis?

NAVis has been used in a range of neurobiological publications. Here's a semi-random sample of recent papers:

BIFROST: a method for registering diverse imaging datasets, Brezovec et al., bioRxiv (2023); doi: https://doi.org/10.1101/2023.06.09.544408

Vimo: Visual Analysis of Neuronal Connectivity Motifs, Troidl et al., bioRxiv (2022); doi: https://doi.org/10.1101/2022.12.09.519772

Information flow, cell types and stereotypy in a full olfactory connectome, Schlegel, Bates et al., eLife (2021); doi: https://doi.org/10.7554/eLife.66018

Synaptic wiring motifs in posterior parietal cortex support decision-making, Kuan et al., bioRxiv (2022); doi: https://doi.org/10.1101/2022.04.13.488176

Want to see your work listed here? Open an Issue and tell us about it!

Citing NAVis

We'd love to know if you found NAVis useful for your research! You can help us spread the word by citing the DOI provided by Zenodo DOI

License

This code is under GNU GPL V3.

Acknowledgments

NAVis is inspired by and inherits much of its design from the excellent natverse R packages by Greg Jefferis, Alex Bates, James Manton and others.

References

NAVis implements or provides interfaces with algorithms described in:

  1. Comparison of neurons based on morphology: Neuron. 2016 doi: 10.1016/j.neuron.2016.06.012 NBLAST: Rapid, Sensitive Comparison of Neuronal Structure and Construction of Neuron Family Databases. Costa M, Manton JD, Ostrovsky AD, Prohaska S, Jefferis GSXE. link
  2. Comparison of neurons based on connectivity: Science. 2012 Jul 27;337(6093):437-44. doi: 10.1126/science.1221762. The connectome of a decision-making neural network. Jarrell TA, Wang Y, Bloniarz AE, Brittin CA, Xu M, Thomson JN, Albertson DG, Hall DH, Emmons SW. link
  3. Comparison of neurons based on synapse distribution: eLife. doi: 10.7554/eLife.16799 Synaptic transmission parallels neuromodulation in a central food-intake circuit. Schlegel P, Texada MJ, Miroschnikow A, Schoofs A, Hückesfeld S, Peters M, … Pankratz MJ. link
  4. Synapse flow centrality and segregation index: eLife. doi: 10.7554/eLife.12059 Quantitative neuroanatomy for connectomics in Drosophila. Schneider-Mizell CM, Gerhard S, Longair M, Kazimiers T, Li, Feng L, Zwart M … Cardona A. link

Contributing

  1. Fork this repository
  2. git clone it to your local machine
  3. Install the full development dependencies with pip install -r requirements.txt
  4. Install the package in editable mode with pip install -e ".[all]"
  5. Create, git add, git commit, git push, and pull request your changes.

Run the tests locally with pytest -v.

Docstrings should use the numpydoc format, and make sure you include any relevant links and citations. Unit tests should be doctests and/or use pytest in the ./tests directory.

Doctests have access to the tmp_dir: pathlib.Path variable, which should be used if any files need to be written.