<!--
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.13` 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](https://www.python.org/downloads/):
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: Set-up an environment for BraiAn
Create and activate a new `python>=3.11,<3.13` environment.
<table border="0">
<tr>
<td>
Using <a href="https://docs.continuum.io/anaconda/"><code>conda</code></a>:</p>
<pre><code class="language-bash">conda create --name braian_env python=3.11
conda activate braian_env</code></pre>
</td>
<td>
Using python venv:</p>
<code class="language-bash">python3.11 -m venv /path/to/new/braian_env</code>
</p>
and <a href="https://docs.python.org/3/library/venv.html#how-venvs-work">activate it</a>
</td>
</tr>
</table>
### Step 2: clone the repository
```bash
git clone https://codeberg.org/SilvaLab/BraiAn.git /path/to/BraiAn
```
### Step 3: install BraiAn inside the environment with Poetry
With the environment set and Poetry installed:
```bash
(braian_env) cd /path/to/BraiAn
(braian_env) poetry install # --with docs, if building the documentation is of your interest
```
<!--build-end-->
<!--mkdocs-end-->
Raw data
{
"_id": null,
"home_page": "https://silvalab.codeberg.page/BraiAn/",
"name": "braian",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=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/ba/92/a62d8ec5adaef250dcf436c69e3b0188221894d127513b93508563849e19/braian-1.0.2.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.13` 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](https://www.python.org/downloads/):\n 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: Set-up an environment for BraiAn\nCreate and activate a new `python>=3.11,<3.13` environment.\n\n<table border=\"0\">\n <tr>\n <td>\n Using <a href=\"https://docs.continuum.io/anaconda/\"><code>conda</code></a>:</p>\n <pre><code class=\"language-bash\">conda create --name braian_env python=3.11\nconda activate braian_env</code></pre>\n </td>\n <td>\n Using python venv:</p>\n <code class=\"language-bash\">python3.11 -m venv /path/to/new/braian_env</code>\n </p>\n and <a href=\"https://docs.python.org/3/library/venv.html#how-venvs-work\">activate it</a>\n </td>\n </tr>\n</table>\n\n### Step 2: clone the repository\n```bash\ngit clone https://codeberg.org/SilvaLab/BraiAn.git /path/to/BraiAn\n```\n\n### Step 3: install BraiAn inside the environment with Poetry\nWith the environment set and Poetry installed:\n```bash\n(braian_env) cd /path/to/BraiAn\n(braian_env) poetry install # --with docs, if building the documentation is of your interest\n```\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.2",
"project_urls": {
"Documentation": "https://silvalab.codeberg.page/BraiAn/api-braian/",
"Homepage": "https://silvalab.codeberg.page/BraiAn/",
"Repository": "https://codeberg.org/SilvaLab/BraiAn"
},
"split_keywords": [
"data-analysis",
" library",
" neuroscience",
" visualisation",
" visualization",
" whole-brain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d1788700930d8c666ca7f485c8a4c13a567d26090be98de261962a54c13d53c",
"md5": "c55e1d83259cc00567f27970eb105114",
"sha256": "71290781739d695cd20395a8d500d978cd49971f25a120ca46b0fee861a54bbb"
},
"downloads": -1,
"filename": "braian-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c55e1d83259cc00567f27970eb105114",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.11",
"size": 109938,
"upload_time": "2024-11-18T11:01:41",
"upload_time_iso_8601": "2024-11-18T11:01:41.949546Z",
"url": "https://files.pythonhosted.org/packages/4d/17/88700930d8c666ca7f485c8a4c13a567d26090be98de261962a54c13d53c/braian-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba92a62d8ec5adaef250dcf436c69e3b0188221894d127513b93508563849e19",
"md5": "bc29e53052deda5fb4b9dd143a24d847",
"sha256": "1a13a20793b0408088bd26d0afc7ebc858e932e271c5f660ba45933af028d715"
},
"downloads": -1,
"filename": "braian-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "bc29e53052deda5fb4b9dd143a24d847",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.11",
"size": 93052,
"upload_time": "2024-11-18T11:01:44",
"upload_time_iso_8601": "2024-11-18T11:01:44.103415Z",
"url": "https://files.pythonhosted.org/packages/ba/92/a62d8ec5adaef250dcf436c69e3b0188221894d127513b93508563849e19/braian-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 11:01:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "SilvaLab",
"codeberg_project": "BraiAn",
"lcname": "braian"
}
JSON