<!--
SPDX-FileCopyrightText: 2024 Carlo Castoldi <carlo.castoldi@outlook.com>
SPDX-License-Identifier: CC-BY-4.0
-->
#  BraiAn
[](https://pypi.org/project/braian)
[](https://ci.codeberg.org/repos/13585)
<!--mkdocs-start-->
<!--install-start-->
## Installation
Once you are in an active `python>=3.11,<3.14` environment, you can run:
```bash
python3 -m pip install braian
```
<!--install-end-->
## Citing
If you use BraiAn in your work, please cite the paper below, currently in pre-print:
> Chiaruttini, N., Castoldi, C. et al. **ABBA, a novel tool for whole-brain mapping, reveals brain-wide differences in immediate early genes induction following learning**. _bioRxiv_ (2024).\
> [https://doi.org/10.1101/2024.09.06.611625](https://doi.org/10.1101/2024.09.06.611625)
<!--build-start-->
## Building
### Prerequisites
* [python>=3.11<3.14](https://www.python.org/downloads/).
If needed, you can use [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) or [pyenv](https://github.com/pyenv/pyenv)/[pyenv-win](https://pyenv-win.github.io/pyenv-win/#installation) to manage the correct version;
* [Poetry](https://python-poetry.org/docs/#installation): for dependency management.
### Step 1: clone the repository
```bash
git clone https://codeberg.org/SilvaLab/BraiAn.git /path/to/BraiAn
```
### Step 2: install with Poetry
```bash
cd /path/to/BraiAn
poetry install # --with docs, if building the documentation is of your interest
```
Poetry will automatically create a [virtual environment](https://docs.python.org/3/library/venv.html#how-venvs-work) in which it installs all the dependencies.
If, instead, you want to manage the environment yourself, Poetry use the one active during the installation.
<!--build-end-->
<!--mkdocs-end-->
Raw data
{
"_id": null,
"home_page": null,
"name": "braian",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.11",
"maintainer_email": null,
"keywords": "data-analysis, library, neuroscience, visualisation, visualization, whole-brain",
"author": "Carlo Castoldi",
"author_email": "carlo.castoldi@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/73/99/cd7629fcd30176aaa946f3061c4898c061b0ce3c2d5f601b4edc875e1333/braian-1.0.4.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2024 Carlo Castoldi <carlo.castoldi@outlook.com>\n\nSPDX-License-Identifier: CC-BY-4.0\n-->\n\n#  BraiAn\n[](https://pypi.org/project/braian)\n[](https://ci.codeberg.org/repos/13585)\n<!--mkdocs-start-->\n<!--install-start-->\n## Installation\nOnce you are in an active `python>=3.11,<3.14` environment, you can run:\n```bash\npython3 -m pip install braian\n```\n<!--install-end-->\n\n## Citing\nIf you use BraiAn in your work, please cite the paper below, currently in pre-print:\n\n> Chiaruttini, N., Castoldi, C. et al. **ABBA, a novel tool for whole-brain mapping, reveals brain-wide differences in immediate early genes induction following learning**. _bioRxiv_ (2024).\\\n> [https://doi.org/10.1101/2024.09.06.611625](https://doi.org/10.1101/2024.09.06.611625)\n\n<!--build-start-->\n## Building\n### Prerequisites\n* [python>=3.11<3.14](https://www.python.org/downloads/).\n If needed, you can use [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) or [pyenv](https://github.com/pyenv/pyenv)/[pyenv-win](https://pyenv-win.github.io/pyenv-win/#installation) to manage the correct version;\n\n* [Poetry](https://python-poetry.org/docs/#installation): for dependency management.\n\n### Step 1: clone the repository\n```bash\ngit clone https://codeberg.org/SilvaLab/BraiAn.git /path/to/BraiAn\n```\n\n### Step 2: install with Poetry\n```bash\ncd /path/to/BraiAn\npoetry install # --with docs, if building the documentation is of your interest\n```\nPoetry will automatically create a [virtual environment](https://docs.python.org/3/library/venv.html#how-venvs-work) in which it installs all the dependencies.\nIf, instead, you want to manage the environment yourself, Poetry use the one active during the installation.\n<!--build-end-->\n<!--mkdocs-end-->",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "A python library for easy navigation, visualisation, and analysis of whole-brain quantification data.",
"version": "1.0.4",
"project_urls": null,
"split_keywords": [
"data-analysis",
" library",
" neuroscience",
" visualisation",
" visualization",
" whole-brain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f940344deb33ecaadd0eba3442e5cab7d885c1a1ce8b4136685628f8c307468",
"md5": "c871c5f543d39e6322bd707d52f24d04",
"sha256": "495345b9d569bbe12c9d0074dc262f8bb9bad8e815ee9f78432d47ad9f25b415"
},
"downloads": -1,
"filename": "braian-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c871c5f543d39e6322bd707d52f24d04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.11",
"size": 110281,
"upload_time": "2025-02-07T20:58:23",
"upload_time_iso_8601": "2025-02-07T20:58:23.116998Z",
"url": "https://files.pythonhosted.org/packages/4f/94/0344deb33ecaadd0eba3442e5cab7d885c1a1ce8b4136685628f8c307468/braian-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7399cd7629fcd30176aaa946f3061c4898c061b0ce3c2d5f601b4edc875e1333",
"md5": "a82da4c9a67994387fa1b4369ccb0c93",
"sha256": "01b740df8107b42f3cbdd306023bc9af223ab4f360553983af264676ce79422a"
},
"downloads": -1,
"filename": "braian-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "a82da4c9a67994387fa1b4369ccb0c93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.11",
"size": 91966,
"upload_time": "2025-02-07T20:58:24",
"upload_time_iso_8601": "2025-02-07T20:58:24.512671Z",
"url": "https://files.pythonhosted.org/packages/73/99/cd7629fcd30176aaa946f3061c4898c061b0ce3c2d5f601b4edc875e1333/braian-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 20:58:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "braian"
}
JSON