Skip to main content

Diametrize cells

Project description

Version Build status Codecov.io License Documentation status DOI

Diameter synthesis

This code aims at generating synthetic diameters for neurons, with parameters learned from a set of biological neurons.

Installation

Use pip:

pip install diameter-synthesis

Main usage

Step 1: Building models

In folder example, you first have to modify create_jsons.py to suit your needs.

You have the following important parameters for the dict extract_models_params:

  • morph_path: path to morphology files
  • mtypes_sort: how to learn distributions: all to use all together, mtypes to use by mtypes , super_mtypes to use home made cells types (see diameter_types below)
  • models: to create several models (for now they are all the same, just different realisation of random numbers)
  • neurite_types: types of neurite to learn parameters for
  • extra_params: dict of additional model parameters

Step 2: Building diameters

Then simply run ./run_models.sh to create the models (saved in a json file).

In create_jsons.py, the dict generate_diameters_params needs to be updated, too, with entries matching the previous dict. The path in new_morph_path will be where the new morphologies will be saved.

Then run ./run_diamters.sh to generate diameters.

Additional scripts

Several additional scripts in folder scripts:

  • diameter-checks: run the diameter-check code (bluepymm) on the biological and sampled cells
  • diameter_types: cluster mtypes using distributions of surface areas (uses two privates repositories a the moment)
  • extract_morphometrics: from bio and sample cells, extracts and plot distribution of surface area and diameter as a function of branch order and path lengths
  • extract_morphologies: from a cell release, find the ones that can be run through diameter-check
  • plot_morphologies: plot all morphologies in mtype folders

Examples

The examples folder contains a simple example that will fetch morphologies from neuromorpho.org, learn a diameter model, rediametrize these morphologies, and perform some analysis of the results to compare original and diametrized morphologies. This example can simply be run using the following command:

./run.sh

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 © 2021-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

diameter-synthesis-0.5.0.tar.gz (422.0 kB view details)

Uploaded Source

Built Distribution

diameter_synthesis-0.5.0-py3-none-any.whl (482.2 kB view details)

Uploaded Python 3

File details

Details for the file diameter-synthesis-0.5.0.tar.gz.

File metadata

  • Download URL: diameter-synthesis-0.5.0.tar.gz
  • Upload date:
  • Size: 422.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for diameter-synthesis-0.5.0.tar.gz
Algorithm Hash digest
SHA256 b743e423ec58b762c9406348002112ece570b65387cc01e7575318fb857a9b91
MD5 d29335b63bb259c506e0a08012e47e62
BLAKE2b-256 bf78cc30046cb87ac05bddb23b57a4baf7b03a10908d0524d3b7ba7ac9de3191

See more details on using hashes here.

Provenance

File details

Details for the file diameter_synthesis-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for diameter_synthesis-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c1cd17d0ab45db9a95ef1e13cca438c5f4abe784223cac79053d096e8fca2968
MD5 3d80c9b377f7dc4d5cc65b4b77b3e33c
BLAKE2b-256 7a5831971f806df93285080b53231f85774e88c1327b1c8651a3f6e33b0afa3f

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