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.3.0.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

NeuroTS-3.3.0-py3-none-any.whl (103.9 kB view details)

Uploaded Python 3

File details

Details for the file NeuroTS-3.3.0.tar.gz.

File metadata

  • Download URL: NeuroTS-3.3.0.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for NeuroTS-3.3.0.tar.gz
Algorithm Hash digest
SHA256 f7bd8eddc0a18762bd479df2fe2080e4b930ac26dbc5b2f32fa086b964a79ea7
MD5 a7e3feaf80935afc51e676def1610ad8
BLAKE2b-256 da9513afc1517c42f4d49c8194c1618a723e6e871ceb4a2b6010c802b3207f12

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: NeuroTS-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 103.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for NeuroTS-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca6a7a3099a93dc6b60f16228229f3c76d6d559d15bdab22e57c472a85fabe55
MD5 e34c42e6da239e3d22d99c34c0e737c5
BLAKE2b-256 6627fa4e41748b27aedc4a669a9dfcaa78c3ba39a05323d1696a3b49429b3826

See more details on using hashes here.

Provenance

Supported by

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