| Name | neuroc JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | NeuroC: a collection of tools for morphology cloning applications |
| upload_time | 2024-06-25 11:20:20 |
| maintainer | None |
| docs_url | None |
| author | Blue Brain Project, EPFL |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NeuroC
A collections of programs morphology cloning
The following packages can be found
- axon shrinker:
For each morphology of the FILES\_FOLDER, remove the axon splice described by the corresponding annotation (ie. located between the end of the dendritic annotation and the start of the axonal annotation) and replace it by an intermediate vertical segment. For each input morphology,
NSAMPLES output morphologies are generated, each with a different length of the replaced segment. Lengths spans from 0 to the length of initially spliced segment
- jitter:
Create clones of a given morphology with some jitter to make them all different. There are two kinds of jitter: rotation and scaling.
Rotational jitter rotates each section around its parent axis or around the PCA ([Principal Component Analysis](https://en.wikipedia.org/wiki/Principal_component_analysis)) of all descendant points.
# Installation
In a fresh virtualenv:
```bash
pip install --index-url https://bbpteam.epfl.ch/repository/devpi/bbprelman/dev/+simple/ neuroc[plotly]
```
# Usage
In a shell, do:
```bash
neuroc --help
```
to list all functionalities.
## Axon shrinker
```bash
neuroc axon_shrinker files_dir annotations_dir output_dir
```
to shrink axons.
## Rat to human scaling
```bash
neuroc scale rat-to-human HUMAN_DIR RAT_DIR MTYPE_MAPPING OUTPUT_DIR
```
Will scale the rat cells in RAT\_DIR to human cells dimensions.
HUMAN\_DIR should be a dir with the following structure:
- Must be **only** composed of sub-folders whose filename is a layer name
- Each sub folder should be composed of morphology files whose first part of the filename before the '_' is considered as the **mtype**
RAT\_DIR should be a directory containing rat morphology files **and a neuronDB.xml file.
MTYPE\_MAPPING\_FILE is a YAML file containing a dictionary where:
- a key is a human mtype or **all**
- the value is a list of rat mtypes to associate with the key. Or a list of one 'all' element
```
ls
$ RAT_DIR
$ RAT_DIR\L1
$ RAT_DIR\L2
$ ...
$ RAT_DIR\L6
$ RAT_DIR\L1\AC_cell_name.swc
$ RAT_DIR\L1\BTC_cell_name.swc
$ ...
```
## Acknowledgements
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.
This project/research received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Framework Partnership Agreement No. 650003 (HBP FPA).
For license and authors, see LICENSE.txt.
Copyright (c) 2013-2024 Blue Brain Project/EPFL
Raw data
{
"_id": null,
"home_page": null,
"name": "neuroc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Blue Brain Project, EPFL",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/94/d4/13761fbb152dab2708d420bce16dc5302e3ff0f974d33df296c45704102a/neuroc-0.3.0.tar.gz",
"platform": null,
"description": "# NeuroC\n\nA collections of programs morphology cloning\nThe following packages can be found\n- axon shrinker:\n\nFor each morphology of the FILES\\_FOLDER, remove the axon splice described by the corresponding annotation (ie. located between the end of the dendritic annotation and the start of the axonal annotation) and replace it by an intermediate vertical segment. For each input morphology,\n NSAMPLES output morphologies are generated, each with a different length of the replaced segment. Lengths spans from 0 to the length of initially spliced segment\n\n- jitter:\nCreate clones of a given morphology with some jitter to make them all different. There are two kinds of jitter: rotation and scaling.\nRotational jitter rotates each section around its parent axis or around the PCA ([Principal Component Analysis](https://en.wikipedia.org/wiki/Principal_component_analysis)) of all descendant points.\n\n\n\n\n# Installation\n\nIn a fresh virtualenv:\n```bash\npip install --index-url https://bbpteam.epfl.ch/repository/devpi/bbprelman/dev/+simple/ neuroc[plotly]\n```\n\n# Usage\nIn a shell, do:\n\n```bash\nneuroc --help\n```\nto list all functionalities.\n\n\n## Axon shrinker\n\n\n```bash\nneuroc axon_shrinker files_dir annotations_dir output_dir\n```\nto shrink axons.\n\n\n## Rat to human scaling\n```bash\nneuroc scale rat-to-human HUMAN_DIR RAT_DIR MTYPE_MAPPING OUTPUT_DIR\n```\n\nWill scale the rat cells in RAT\\_DIR to human cells dimensions.\nHUMAN\\_DIR should be a dir with the following structure:\n- Must be **only** composed of sub-folders whose filename is a layer name\n- Each sub folder should be composed of morphology files whose first part of the filename before the '_' is considered as the **mtype**\n\nRAT\\_DIR should be a directory containing rat morphology files **and a neuronDB.xml file.\n\nMTYPE\\_MAPPING\\_FILE is a YAML file containing a dictionary where:\n- a key is a human mtype or **all**\n- the value is a list of rat mtypes to associate with the key. Or a list of one 'all' element\n```\nls\n$ RAT_DIR\n\n$ RAT_DIR\\L1\n$ RAT_DIR\\L2\n$ ...\n$ RAT_DIR\\L6\n\n$ RAT_DIR\\L1\\AC_cell_name.swc\n$ RAT_DIR\\L1\\BTC_cell_name.swc\n$ ...\n```\n\n## Acknowledgements\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\nThis project/research received funding from the European Union\u2019s Horizon 2020 Framework Programme for Research and Innovation under the Framework Partnership Agreement No. 650003 (HBP FPA).\n\nFor license and authors, see LICENSE.txt. \n\nCopyright (c) 2013-2024 Blue Brain Project/EPFL\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "NeuroC: a collection of tools for morphology cloning applications",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://github.com/BlueBrain/neuroc",
"Homepage": "https://github.com/BlueBrain/neuroc",
"Repository": "https://github.com/BlueBrain/neuroc.git",
"Tracker": "https://github.com/BlueBrain/neuroc/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94d413761fbb152dab2708d420bce16dc5302e3ff0f974d33df296c45704102a",
"md5": "98eac1a01441efda021a4ab0b2c80298",
"sha256": "fc6a1649a8f10f942f8eda90649112f61ca31c8c227d2ead74975af76ea649c1"
},
"downloads": -1,
"filename": "neuroc-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "98eac1a01441efda021a4ab0b2c80298",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 306289,
"upload_time": "2024-06-25T11:20:20",
"upload_time_iso_8601": "2024-06-25T11:20:20.475451Z",
"url": "https://files.pythonhosted.org/packages/94/d4/13761fbb152dab2708d420bce16dc5302e3ff0f974d33df296c45704102a/neuroc-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 11:20:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBrain",
"github_project": "neuroc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "neuroc"
}
