| Name | neura-library JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Utility tools for system neuroscience research, including Open Source Wrapper or Parser |
| upload_time | 2025-03-14 16:03:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause License
Copyright (c) 2023, YT.WEI
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
neuroscience
visual neuroscience
cellular imaging
brain mapping
spatial navigation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# neuralib
[](https://badge.fury.io/py/neura-library)
[](https://pepy.tech/project/neura-library)
[](https://github.com/astral-sh/ruff)
[](https://github.com/astral-sh/uv)
[](https://neuralib.readthedocs.io/en/latest/index.html)
## Utility tools for rodent system neuroscience research, including Open Source Wrapper or Parser
## See the [Documentation ](https://neuralib.readthedocs.io/en/latest/index.html) and [Examples](https://github.com/ytsimon2004/neuralib/tree/main/doc/source/notebooks)
## Checkout [Release notes](https://github.com/ytsimon2004/neuralib/releases)
# Installation
## conda environment
- Create and activate a new conda environment (Python >=3.10, but >=3.12 not yet tested), then install:
```shell
conda create -n neuralib python=3.10
conda activate neuralib
pip install neura-library
```
- If you wish to install **all dependencies**, run:
```shell
pip install neura-library[all]
```
- If you wish to install the **minimal required dependencies** according to usage purpose:
Choices in []: atlas, scanner, imaging, segmentation, model, track, gpu, profile, imagelib, tools, full
Example of using the atlas module:
```shell
pip install neura-library[atlas]
```
- If installing in developer mode (Install pre-commit and linter check by ruff)
```shell
pip install neura-library[dev]
pre-commit install
ruff check .
```
## uv virtual environment
- Install uv, run in Unix or git bash (Windows):
```shell
curl -LsSf https://astral.sh/uv/install.sh | sh
```
- Follow uv project structure [doc](https://docs.astral.sh/uv/guides/projects/#creating-a-new-project):
```shell
uv init
```
- Make sure python version (>=3.10, but >=3.12 not yet tested), both in `pyproject.py` and `.python-version`
```shell
uv python install 3.10
```
- If you wish to install **all dependencies**, run:
```shell
uv add neura-library[all]
```
- If you wish to install the **minimal required dependencies** according to usage purpose:
Choices in []: atlas, scanner, imaging, segmentation, model, track, gpu, profile, imagelib, tools, full
Example of using the atlas module:
```shell
uv add neura-library[atlas]
```
- If installing in developer mode (Install pre-commit and linter check by ruff)
```shell
uv add neura-library[dev]
pre-commit install
ruff check .
```
Raw data
{
"_id": null,
"home_page": null,
"name": "neura-library",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Neuroscience, visual neuroscience, cellular imaging, brain mapping, spatial navigation",
"author": null,
"author_email": "Yu-Ting Wei <ytsimon2004@gmail.com>, Ta-Shun Su <antoniost29@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7e/1f/3c145c702597b02e4a927c40cd56f998fe8d4d7dd370d018024275b5de14/neura_library-0.4.0.tar.gz",
"platform": null,
"description": "# neuralib\n\n\n[](https://badge.fury.io/py/neura-library)\n[](https://pepy.tech/project/neura-library)\n\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/astral-sh/uv)\n[](https://neuralib.readthedocs.io/en/latest/index.html)\n\n## Utility tools for rodent system neuroscience research, including Open Source Wrapper or Parser\n\n## See the [Documentation ](https://neuralib.readthedocs.io/en/latest/index.html) and [Examples](https://github.com/ytsimon2004/neuralib/tree/main/doc/source/notebooks)\n\n## Checkout [Release notes](https://github.com/ytsimon2004/neuralib/releases)\n\n# Installation\n\n## conda environment\n\n- Create and activate a new conda environment (Python >=3.10, but >=3.12 not yet tested), then install:\n\n```shell\nconda create -n neuralib python=3.10\nconda activate neuralib\npip install neura-library\n```\n\n- If you wish to install **all dependencies**, run:\n\n```shell\npip install neura-library[all]\n```\n\n- If you wish to install the **minimal required dependencies** according to usage purpose:\n\nChoices in []: atlas, scanner, imaging, segmentation, model, track, gpu, profile, imagelib, tools, full\nExample of using the atlas module:\n\n```shell\npip install neura-library[atlas]\n```\n\n- If installing in developer mode (Install pre-commit and linter check by ruff)\n\n```shell\npip install neura-library[dev]\npre-commit install\nruff check .\n```\n\n## uv virtual environment\n\n- Install uv, run in Unix or git bash (Windows):\n\n```shell\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n```\n\n- Follow uv project structure [doc](https://docs.astral.sh/uv/guides/projects/#creating-a-new-project):\n\n```shell\nuv init\n```\n\n- Make sure python version (>=3.10, but >=3.12 not yet tested), both in `pyproject.py` and `.python-version`\n\n```shell\nuv python install 3.10\n```\n\n- If you wish to install **all dependencies**, run:\n\n```shell\nuv add neura-library[all]\n```\n\n- If you wish to install the **minimal required dependencies** according to usage purpose:\n\nChoices in []: atlas, scanner, imaging, segmentation, model, track, gpu, profile, imagelib, tools, full\nExample of using the atlas module:\n\n```shell\nuv add neura-library[atlas]\n```\n\n- If installing in developer mode (Install pre-commit and linter check by ruff)\n\n```shell\nuv add neura-library[dev]\npre-commit install\nruff check .\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2023, YT.WEI\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Utility tools for system neuroscience research, including Open Source Wrapper or Parser",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://neuralib.readthedocs.io/en/latest/index.html",
"Homepage": "https://github.com/ytsimon2004/neuralib",
"Issues": "https://github.com/ytsimon2004/neuralib/issues",
"Repository": "https://github.com/ytsimon2004/neuralib"
},
"split_keywords": [
"neuroscience",
" visual neuroscience",
" cellular imaging",
" brain mapping",
" spatial navigation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "65c38698cb22c6cf18ddbb7896d4360bff301b36ec16d4e762198f881fc4c663",
"md5": "1fa4e4bf3278daa1f95f088c8ad56c5d",
"sha256": "5ee2c8d4a6ba98b26f9a24f4e90509c51f64e5bee22f76396de9146e4106150b"
},
"downloads": -1,
"filename": "neura_library-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1fa4e4bf3278daa1f95f088c8ad56c5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 274268,
"upload_time": "2025-03-14T16:02:58",
"upload_time_iso_8601": "2025-03-14T16:02:58.585056Z",
"url": "https://files.pythonhosted.org/packages/65/c3/8698cb22c6cf18ddbb7896d4360bff301b36ec16d4e762198f881fc4c663/neura_library-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7e1f3c145c702597b02e4a927c40cd56f998fe8d4d7dd370d018024275b5de14",
"md5": "5222ea2da29d78f33ab1648cc81654ea",
"sha256": "ff17c45e8640cff5dd5623246d2a644d1c96871f176174b1ac7eb5bec5fa9140"
},
"downloads": -1,
"filename": "neura_library-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "5222ea2da29d78f33ab1648cc81654ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 220161,
"upload_time": "2025-03-14T16:03:00",
"upload_time_iso_8601": "2025-03-14T16:03:00.423327Z",
"url": "https://files.pythonhosted.org/packages/7e/1f/3c145c702597b02e4a927c40cd56f998fe8d4d7dd370d018024275b5de14/neura_library-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-14 16:03:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ytsimon2004",
"github_project": "neuralib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neura-library"
}
