[](https://github.com/BlueBrain/diameter-synthesis/releases)
[](https://github.com/BlueBrain/diameter-synthesis/actions)
[](https://codecov.io/github/BlueBrain/diameter-synthesis?branch=main)
[](https://github.com/BlueBrain/diameter-synthesis/blob/main/LICENSE.txt)
[](https://diameter-synthesis.readthedocs.io/)
[](https://doi.org/10.1016/j.celrep.2022.110586)
# Diameter synthesis
This code aims at generating synthetic diameters for neurons, with parameters learned from a set of biological neurons.
## Installation
Use pip:
```bash
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](http://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:
```bash
./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
Raw data
{
"_id": null,
"home_page": "https://diameter-synthesis.readthedocs.io",
"name": "diameter-synthesis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Blue Brain Project, EPFL",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/63/45e8fe557581e1b3a1e5473a44d81055208789bb19a9ba5984b62ef53775/diameter_synthesis-0.6.1.tar.gz",
"platform": null,
"description": "[](https://github.com/BlueBrain/diameter-synthesis/releases)\n[](https://github.com/BlueBrain/diameter-synthesis/actions)\n[](https://codecov.io/github/BlueBrain/diameter-synthesis?branch=main)\n[](https://github.com/BlueBrain/diameter-synthesis/blob/main/LICENSE.txt)\n[](https://diameter-synthesis.readthedocs.io/)\n[](https://doi.org/10.1016/j.celrep.2022.110586)\n\n\n# Diameter synthesis\n\nThis code aims at generating synthetic diameters for neurons, with parameters learned from a set of biological neurons.\n\n\n## Installation\n\nUse pip:\n\n```bash\npip install diameter-synthesis\n```\n\n## Main usage\n\n### Step 1: Building models\n\nIn folder `example`, you first have to modify `create_jsons.py` to suit your needs.\n\nYou have the following important parameters for the dict `extract_models_params`:\n\n- `morph_path`: path to morphology files\n- `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)\n- `models`: to create several models (for now they are all the same, just different realisation of random numbers)\n- `neurite_types`: types of neurite to learn parameters for\n- `extra_params`: dict of additional model parameters\n\n### Step 2: Building diameters\n\nThen simply run `./run_models.sh` to create the models (saved in a json file).\n\nIn `create_jsons.py`, the dict `generate_diameters_params` needs to be updated, too, with entries matching the previous dict.\nThe path in `new_morph_path` will be where the new morphologies will be saved.\n\nThen run `./run_diamters.sh` to generate diameters.\n\n\n## Additional scripts\n\nSeveral additional scripts in folder `scripts`:\n\n- `diameter-checks`: run the diameter-check code (bluepymm) on the biological and sampled cells\n- `diameter_types`: cluster mtypes using distributions of surface areas (uses two privates repositories a the moment)\n- `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\n- `extract_morphologies`: from a cell release, find the ones that can be run through diameter-check\n- `plot_morphologies`: plot all morphologies in mtype folders\n\n\n## Examples\n\nThe `examples` folder contains a simple example that will fetch morphologies from [neuromorpho.org](http://neuromorpho.org), learn a diameter model, rediametrize these morphologies, and perform some analysis of the results to compare original and diametrized morphologies.\nThis example can simply be run using the following command:\n```bash\n./run.sh\n```\n\n\n## Funding & Acknowledgment\n\nThe development of this software was supported by funding to the Blue Brain Project, a research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government\u2019s ETH Board of the Swiss Federal Institutes of Technology.\n\nFor license and authors, see `LICENSE.txt` and `AUTHORS.md` respectively.\n\nCopyright \u00a9 2021-2022 Blue Brain Project/EPFL\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Diametrize cells.",
"version": "0.6.1",
"project_urls": {
"Homepage": "https://diameter-synthesis.readthedocs.io",
"Source": "https://github.com/BlueBrain/diameter-synthesis",
"Tracker": "https://github.com/BlueBrain/diameter-synthesis/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c4caef0833aa4adb46a0e3215683a952d05dffc5acdebabd068c1dc6b3718d9",
"md5": "a7f1994d04d3603678988b4a27f539e1",
"sha256": "dd2944a18e49119539549f48ec8fda19d8c7c78d886a150e3e3db9a0f9895d3f"
},
"downloads": -1,
"filename": "diameter_synthesis-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7f1994d04d3603678988b4a27f539e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34852,
"upload_time": "2024-05-15T14:14:33",
"upload_time_iso_8601": "2024-05-15T14:14:33.484351Z",
"url": "https://files.pythonhosted.org/packages/5c/4c/aef0833aa4adb46a0e3215683a952d05dffc5acdebabd068c1dc6b3718d9/diameter_synthesis-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "956345e8fe557581e1b3a1e5473a44d81055208789bb19a9ba5984b62ef53775",
"md5": "13e5d771566f000d0f772aabecb3fd8a",
"sha256": "46d87f209fe8876d14162d84c5c189d7cc8d05edbd53fa4546aba3275bfe815b"
},
"downloads": -1,
"filename": "diameter_synthesis-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "13e5d771566f000d0f772aabecb3fd8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 418287,
"upload_time": "2024-05-15T14:15:03",
"upload_time_iso_8601": "2024-05-15T14:15:03.622697Z",
"url": "https://files.pythonhosted.org/packages/95/63/45e8fe557581e1b3a1e5473a44d81055208789bb19a9ba5984b62ef53775/diameter_synthesis-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 14:15:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBrain",
"github_project": "diameter-synthesis",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "diameter-synthesis"
}
JSON
