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.3.tar.gz (422.7 kB view details)

Uploaded Source

Built Distribution

diameter_synthesis-0.5.3-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for diameter-synthesis-0.5.3.tar.gz
Algorithm Hash digest
SHA256 59681e5e2c04d69cdf3e372fbb329fd0dad28d4ebcf9bdde2404827354a60723
MD5 094ebaa0409b05c68e10acc672eb928e
BLAKE2b-256 88a2a9c18d38ac91af79f0f9af731c80bb2b8c0d40a82dee271b1fbae9184d85

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for diameter_synthesis-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ae8749a9625b44cfa2edce991a9200b435a95697a55b78401e9adffdcff7f534
MD5 a71181acfc1ec115ca73e87fcefc9bec
BLAKE2b-256 289fa2384fa05122b7715f728dafa756fc0be320e8ef87480ae15e75ec83f58c

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