<h1 align="center">BrainScale</h1>
<h2 align="center">Scalable Online Learning for Brain Dynamics</h2>
<p align="center">
<img alt="Header image of brainscale." src="https://raw.githubusercontent.com/chaobrain/brainscale/main/docs/_static/brainscale.jpg" width=40%>
</p>
<p align="center">
<a href="https://pypi.org/project/brainscale/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/brainscale"></a>
<a href="https://github.com/chaobrain/brainscale/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href="https://brainscale.readthedocs.io/?badge=latest"><img alt="Documentation" src="https://readthedocs.org/projects/brainscale/badge/?version=latest"></a>
<a href="https://badge.fury.io/py/brainscale"><img alt="PyPI version" src="https://badge.fury.io/py/brainscale.svg"></a>
<a href="https://github.com/chaobrain/brainscale/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/brainscale/actions/workflows/CI.yml/badge.svg"></a>
</p>
[``brainscale``](https://github.com/chaobrain/brainscale) provides online learning algorithms for biological neural networks.
It has been integrated into our establishing [brain modeling ecosystem](https://brainmodeling.readthedocs.io/).
## Installation
``brainscale`` can run on Python 3.10+ installed on Linux, MacOS, and Windows. You can install ``brainscale`` via pip:
```bash
pip install brainscale --upgrade
```
Alternatively, you can install `BrainX`, which bundles `brainscale` with other compatible packages for a comprehensive brain modeling ecosystem:
```bash
pip install BrainX -U
```
## Documentation
The official documentation is hosted on Read the Docs: [https://brainscale.readthedocs.io](https://brainscale.readthedocs.io)
## Citation
If you use this package in your research, please cite:
```bibtex
@article {Wang2024.09.24.614728,
author = {Wang, Chaoming and Dong, Xingsi and Ji, Zilong and Jiang, Jiedong and Liu, Xiao and Wu, Si},
title = {BrainScale: Enabling Scalable Online Learning in Spiking Neural Networks},
elocation-id = {2024.09.24.614728},
year = {2025},
doi = {10.1101/2024.09.24.614728},
publisher = {Cold Spring Harbor Laboratory},
URL = {https://www.biorxiv.org/content/early/2025/07/27/2024.09.24.614728},
eprint = {https://www.biorxiv.org/content/early/2025/07/27/2024.09.24.614728.full.pdf},
journal = {bioRxiv}
}
```
## See also the ecosystem
``brainscale`` is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "brainscale",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "computational neuroscience, brain-inspired computing, brain modeling, online learning",
"author": null,
"author_email": "BrainScale Developers <chao.brain@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/43/dd/6363aa8df8548cdebce96fe01e63e6fd2f9b013f475154f730f474d316b6/brainscale-0.0.11.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">BrainScale</h1>\n<h2 align=\"center\">Scalable Online Learning for Brain Dynamics</h2>\n\n<p align=\"center\">\n \t<img alt=\"Header image of brainscale.\" src=\"https://raw.githubusercontent.com/chaobrain/brainscale/main/docs/_static/brainscale.jpg\" width=40%>\n</p> \n\n\n\n<p align=\"center\">\n\t<a href=\"https://pypi.org/project/brainscale/\"><img alt=\"Supported Python Version\" src=\"https://img.shields.io/pypi/pyversions/brainscale\"></a>\n\t<a href=\"https://github.com/chaobrain/brainscale/blob/main/LICENSE\"><img alt=\"LICENSE\" src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"></a>\n \t<a href=\"https://brainscale.readthedocs.io/?badge=latest\"><img alt=\"Documentation\" src=\"https://readthedocs.org/projects/brainscale/badge/?version=latest\"></a>\n \t<a href=\"https://badge.fury.io/py/brainscale\"><img alt=\"PyPI version\" src=\"https://badge.fury.io/py/brainscale.svg\"></a>\n <a href=\"https://github.com/chaobrain/brainscale/actions/workflows/CI.yml\"><img alt=\"Continuous Integration\" src=\"https://github.com/chaobrain/brainscale/actions/workflows/CI.yml/badge.svg\"></a>\n</p>\n\n\n[``brainscale``](https://github.com/chaobrain/brainscale) provides online learning algorithms for biological neural networks. \nIt has been integrated into our establishing [brain modeling ecosystem](https://brainmodeling.readthedocs.io/). \n\n\n## Installation\n\n``brainscale`` can run on Python 3.10+ installed on Linux, MacOS, and Windows. You can install ``brainscale`` via pip:\n\n```bash\npip install brainscale --upgrade\n```\n\nAlternatively, you can install `BrainX`, which bundles `brainscale` with other compatible packages for a comprehensive brain modeling ecosystem:\n\n```bash\npip install BrainX -U\n```\n\n\n## Documentation\n\nThe official documentation is hosted on Read the Docs: [https://brainscale.readthedocs.io](https://brainscale.readthedocs.io)\n\n\n## Citation\n\nIf you use this package in your research, please cite:\n\n```bibtex\n@article {Wang2024.09.24.614728,\n\tauthor = {Wang, Chaoming and Dong, Xingsi and Ji, Zilong and Jiang, Jiedong and Liu, Xiao and Wu, Si},\n\ttitle = {BrainScale: Enabling Scalable Online Learning in Spiking Neural Networks},\n\telocation-id = {2024.09.24.614728},\n\tyear = {2025},\n\tdoi = {10.1101/2024.09.24.614728},\n\tpublisher = {Cold Spring Harbor Laboratory},\n\tURL = {https://www.biorxiv.org/content/early/2025/07/27/2024.09.24.614728},\n\teprint = {https://www.biorxiv.org/content/early/2025/07/27/2024.09.24.614728.full.pdf},\n\tjournal = {bioRxiv}\n}\n```\n\n\n\n\n## See also the ecosystem\n\n``brainscale`` is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/\n\n\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Enabling Scalable Online Learning for Brain Dynamics.",
"version": "0.0.11",
"project_urls": {
"Bug Tracker": "https://github.com/chaobrain/brainscale/issues",
"Documentation": "https://brainscale.readthedocs.io/",
"Homepage": "https://github.com/chaobrain/brainscale",
"Source Code": "https://github.com/chaobrain/brainscale"
},
"split_keywords": [
"computational neuroscience",
" brain-inspired computing",
" brain modeling",
" online learning"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a1ffa694c9507e7422912b0f6f0017c68b35b2821dc80dfaa35ca841e3e1e28e",
"md5": "60857e135ee6890f7262d152b7685643",
"sha256": "2b440c44595c7d18e9d36436e0d3a58404b22400b8bebf285ad900afdc1883ff"
},
"downloads": -1,
"filename": "brainscale-0.0.11-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "60857e135ee6890f7262d152b7685643",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 156879,
"upload_time": "2025-10-09T03:12:03",
"upload_time_iso_8601": "2025-10-09T03:12:03.382941Z",
"url": "https://files.pythonhosted.org/packages/a1/ff/a694c9507e7422912b0f6f0017c68b35b2821dc80dfaa35ca841e3e1e28e/brainscale-0.0.11-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "43dd6363aa8df8548cdebce96fe01e63e6fd2f9b013f475154f730f474d316b6",
"md5": "2f680b9e7b4aa2853a928ed30f57c05c",
"sha256": "f707a0e098a59ed9f82b8b54840d9f7f60799054d7236eda99f91bc3c39064bc"
},
"downloads": -1,
"filename": "brainscale-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "2f680b9e7b4aa2853a928ed30f57c05c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 128057,
"upload_time": "2025-10-09T03:12:04",
"upload_time_iso_8601": "2025-10-09T03:12:04.930022Z",
"url": "https://files.pythonhosted.org/packages/43/dd/6363aa8df8548cdebce96fe01e63e6fd2f9b013f475154f730f474d316b6/brainscale-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-09 03:12:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaobrain",
"github_project": "brainscale",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "jax",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "brainstate",
"specs": []
},
{
"name": "brainunit",
"specs": []
},
{
"name": "brainpy",
"specs": []
},
{
"name": "braintools",
"specs": []
}
],
"lcname": "brainscale"
}
JSON
