Skip to main content

Synthesis of artificial neurons using their topological profiles package.

Project description

NeuroTS Logo

Version Build status Codecov.io Code style: black License Documentation status DOI Binder

NeuroTS

Computational generation of artificial neuronal trees based on the topology of reconstructed cells and their statistical properties.

Main usage

Neuronal morphologies provide the foundation for the electrical behavior of neurons, the connectomes they form, and the dynamical properties of the brain. Comprehensive neuron models are essential for defining cell types, discerning their functional roles, and investigating brain disease related dendritic alterations. However, a lack of understanding of the principles underlying neuron morphologies has hindered attempts to computationally synthesize morphologies for decades. We introduce a synthesis algorithm based on a topological descriptor of neurons, which enables the rapid digital reconstruction of entire brain regions from few reference cells. This topology-guided synthesis (NeuroTS) generates dendrites that are statistically similar to biological reconstructions in terms of morpho-electrical and connectivity properties and offers a significant opportunity to investigate the links between neuronal morphology and brain function across different spatio-temporal scales.

NeuroTS can be used for the creation of neuronal morphologies from biological reconstructions. The user needs to extract the distributions of topological and statistical properties using the software in order to create the necessary synthesis inputs. Examples of parameters and distributions can be found in the Parameters and distributions page of the doc.

Once the input_parameters and input_distributions have been defined, then NeuroTS can generate one or multiple cells based on the respective inputs. The generated cells can be saved in a variety of file formats (SWC, ASC, H5) so that they can be analyzed and visualized by a variety of different software packages. You can find examples on how to extract distributions, generate cells and run basic validations below.

Examples

We provide some basic examples to showcase the basic functionality of NeuroTS:

  • synthesize a single neuron from a basic set of inputs
  • synthesize many neurons with the same input parameters and distributions
  • synthesize a single neuron with its diameters using a simple method
  • synthesize a single neuron with its diameters using an external diametrizer
  • extract parameters and distributions that can be used as synthesis inputs

All the scripts of these examples and the required input data are located in the examples directory of the repository.

More information can be found in Examples page of the doc.

Installation

It is recommended to install NeuroTS using pip:

pip install neurots

Citation

When you use the NeuroTS software or method for your research, we ask you to cite the publication associated to this repository (use the Cite this repository button on the main page of the code).

Funding & Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

For license and authors, see LICENSE.txt and AUTHORS.md respectively.

Copyright © 2022 Blue Brain Project/EPFL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neurots-3.7.0.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

NeuroTS-3.7.0-py3-none-any.whl (86.9 kB view details)

Uploaded Python 3

File details

Details for the file neurots-3.7.0.tar.gz.

File metadata

  • Download URL: neurots-3.7.0.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for neurots-3.7.0.tar.gz
Algorithm Hash digest
SHA256 61a332ccc6952379fce8ffaf0f35e0767c49856af2f7e0548f8c09b94e059230
MD5 9d9d0651e90d8e4894e39ffa0081587c
BLAKE2b-256 cf8ad97388159fdda03bb8b9a4b9a8c3df89e5a46a4063f2922beb8c16759415

See more details on using hashes here.

File details

Details for the file NeuroTS-3.7.0-py3-none-any.whl.

File metadata

  • Download URL: NeuroTS-3.7.0-py3-none-any.whl
  • Upload date:
  • Size: 86.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for NeuroTS-3.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ff134cfb5ffd2581922d0857bc79d17957ca91451532580d27a4a7b1e7b0627
MD5 a445bba88701504d299a024c907023b1
BLAKE2b-256 5e486a9e114ba2e896ead16089c0d6cd4dfb7777cde3bdec1f2bd82456cdcc41

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page