Neuronal Morphology Analysis Tool
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apps morph_stats and morph_checks print their default config url Jan 9, 2019
benchmarks
doc fix read the docs (#687) Apr 17, 2018
examples Removal of cut plane app Sep 26, 2018
ipynb Merge remote-tracking branch 'neurom/master' Sep 25, 2017
neurom Last soma point is no longer first neurite point in ASC Feb 20, 2019
test_data Fix: Section iterator strategies #690 Oct 9, 2018
tutorial Create plotly module Jul 20, 2018
.codecov.yml Coverage fixes May 13, 2016
.coveragerc Switch to Tox (#720) Jan 9, 2019
.gitignore added .DS_Store and .ipynb_checkpoints to the gitignore Nov 25, 2015
.travis.yml Travis run tox -e lint on python3.5 node Feb 1, 2019
ACKNOWLEDGMENTS.md Add HBP funding acknowledgment and main authors file. Jun 17, 2016
AUTHORS.md
LICENSE.txt Fix license text; May 7, 2015
MANIFEST.in morph_stats and morph_checks print their default config url Jan 9, 2019
README.md
asv.conf.json added ASV benchmarking (#568) Dec 7, 2016
package.json Updated package.json Sep 22, 2017
pylintrc
pyproject.toml
requirements_benchmark.txt added ASV benchmarking (#568) Dec 7, 2016
requirements_dev.txt fix documentation (#681) Apr 16, 2018
setup.py Bump version Feb 20, 2019
tox.ini `tox -e lint` now defaults to Python 3 Feb 1, 2019

README.md

NeuroM

NeuroM is a Python toolkit for the analysis and processing of neuron morphologies.

Build Status codecov.io Documentation Status DOI

Acknowlegments

This work has been partially funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP). For license and authors, see LICENSE.txt and AUTHORS.md respectively.

Documentation

NeuroM documentation is built and hosted on readthedocs.

Installation

It is recommended that you use pip to install NeuroM into a virtualenv. The following assumes a virtualenv named nrm has been set up and activated. We will see three ways to install NeuroM

1. From the Python Package Index

(nrm)$ pip install neurom

2. From git repository

(nrm)$ pip install git+https://github.com/BlueBrain/NeuroM.git

3. From source

Clone the repository and install it:

(nrm)$ git clone https://github.com/BlueBrain/NeuroM.git
(nrm)$ pip install -e ./NeuroM

This installs NeuroM into your virtualenv in "editable" mode. That means changes made to the source code are seen by the installation. To install in read-only mode, omit the -e.

Examples

  • Extract morphometrics from one or many morphology files:
$ morph_stats some/path/morph.swc # single file
{
  "some/path/morph.swc":{
    "axon":{
      "total_section_length":207.87975220908129,
      "max_section_length":11.018460736176685,
      "max_section_branch_order":10,
      "total_section_volume":276.73857657289523
    },
    "all":{
      "total_section_length":840.68521442251949,
      "max_section_length":11.758281556059444,
      "max_section_branch_order":10,
      "total_section_volume":1104.9077419665782
    },
    "mean_soma_radius":0.17071067811865476,
    "apical_dendrite":{
      "total_section_length":214.37304577550353,
      "max_section_length":11.758281556059444,
      "max_section_branch_order":10,
      "total_section_volume":271.9412385728449
    },
    "basal_dendrite":{
      "total_section_length":418.43241643793476,
      "max_section_length":11.652508126101711,
      "max_section_branch_order":10,
      "total_section_volume":556.22792682083821
    }
  }
}

$ morph_stats some/path # all files in directory
  • Perform checks on neuron morphology files:
(nrm)$ morph_check some/data/path/morph_file.swc # single file
INFO: ========================================
INFO: File: some/data/path/morph_file.swc
INFO:                      Is single tree PASS
INFO:                     Has soma points PASS
INFO:                  Has sequential ids PASS
INFO:                  Has increasing ids PASS
INFO:                      Has valid soma PASS
INFO:                  Has valid neurites PASS
INFO:                  Has basal dendrite PASS
INFO:                            Has axon PASS
INFO:                 Has apical dendrite PASS
INFO:     Has all nonzero segment lengths PASS
INFO:     Has all nonzero section lengths PASS
INFO:       Has all nonzero neurite radii PASS
INFO:             Has nonzero soma radius PASS
INFO:                                 ALL PASS
INFO: ========================================

(nrm)$ morph_check some/data/path # all files in directory
    ....
  • Load a neuron and obtain some information from it:
>>> import neurom as nm
>>> nrn = nm.load_neuron('some/data/path/morph_file.swc')
>>> apical_seg_lengths = nm.get('segment_lengths', nrn, neurite_type=nm.APICAL_DENDRITE)
>>> axon_sec_lengths = nm.get('section_lengths', nrn, neurite_type=nm.AXON)
  • Visualize a neuronal morphology:
>>> # Initialize nrn as above
>>> from neurom import viewer
>>> fig, ax = viewer.draw(nrn)
>>> fig.show()
>>> fig, ax = viewer.draw(nrn, mode='3d') # valid modes '2d', '3d', 'dendrogram'
>>> fig.show()

Dependencies

The build-time and runtime dependencies of NeuroM are:

Reporting issues

Issues should be reported to the NeuroM github repository issue tracker. The ability and speed with which issues can be resolved depends on how complete and succinct the report is. For this reason, it is recommended that reports be accompanied with a minimal but self-contained code sample that reproduces the issue, the observed and expected output, and if possible, the commit ID of the version used. If reporting a regression, the commit ID of the change that introduced the problem is also extremely valuable information.