<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 brain modeling ecosystem
We are building the brain modeling ecosystem: https://brainmodeling.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/chaobrain/brainscale",
"name": "brainscale",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "brain simulation, brain-inspired computing",
"author": "BrainScale Developers",
"author_email": "BrainScale Developers <chao.brain@qq.com>",
"download_url": null,
"platform": null,
"description": "<h1 align=\"center\">BrainScale</h1>\r\n<h2 align=\"center\">Scalable Online Learning for Brain Dynamics</h2>\r\n\r\n<p align=\"center\">\r\n \t<img alt=\"Header image of brainscale.\" src=\"https://raw.githubusercontent.com/chaobrain/brainscale/main/docs/_static/brainscale.jpg\" width=40%>\r\n</p> \r\n\r\n\r\n\r\n<p align=\"center\">\r\n\t<a href=\"https://pypi.org/project/brainscale/\"><img alt=\"Supported Python Version\" src=\"https://img.shields.io/pypi/pyversions/brainscale\"></a>\r\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>\r\n \t<a href=\"https://brainscale.readthedocs.io/?badge=latest\"><img alt=\"Documentation\" src=\"https://readthedocs.org/projects/brainscale/badge/?version=latest\"></a>\r\n \t<a href=\"https://badge.fury.io/py/brainscale\"><img alt=\"PyPI version\" src=\"https://badge.fury.io/py/brainscale.svg\"></a>\r\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>\r\n</p>\r\n\r\n\r\n[``brainscale``](https://github.com/chaobrain/brainscale) provides online learning algorithms for biological neural networks. \r\nIt has been integrated into our establishing [brain modeling ecosystem](https://brainmodeling.readthedocs.io/). \r\n\r\n\r\n## Installation\r\n\r\n``brainscale`` can run on Python 3.10+ installed on Linux, MacOS, and Windows. You can install ``brainscale`` via pip:\r\n\r\n```bash\r\npip install brainscale --upgrade\r\n```\r\n\r\nAlternatively, you can install `BrainX`, which bundles `brainscale` with other compatible packages for a comprehensive brain modeling ecosystem:\r\n\r\n```bash\r\npip install BrainX -U\r\n```\r\n\r\n\r\n## Documentation\r\n\r\nThe official documentation is hosted on Read the Docs: [https://brainscale.readthedocs.io](https://brainscale.readthedocs.io)\r\n\r\n\r\n## Citation\r\n\r\nIf you use this package in your research, please cite:\r\n\r\n```bibtex\r\n@article {Wang2024.09.24.614728,\r\n\tauthor = {Wang, Chaoming and Dong, Xingsi and Ji, Zilong and Jiang, Jiedong and Liu, Xiao and Wu, Si},\r\n\ttitle = {BrainScale: Enabling Scalable Online Learning in Spiking Neural Networks},\r\n\telocation-id = {2024.09.24.614728},\r\n\tyear = {2025},\r\n\tdoi = {10.1101/2024.09.24.614728},\r\n\tpublisher = {Cold Spring Harbor Laboratory},\r\n\tURL = {https://www.biorxiv.org/content/early/2025/07/27/2024.09.24.614728},\r\n\teprint = {https://www.biorxiv.org/content/early/2025/07/27/2024.09.24.614728.full.pdf},\r\n\tjournal = {bioRxiv}\r\n}\r\n```\r\n\r\n\r\n\r\n\r\n## See also the brain modeling ecosystem\r\n\r\nWe are building the brain modeling ecosystem: https://brainmodeling.readthedocs.io/\r\n\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Enabling Scalable Online Learning for Brain Dynamics.",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/chaobrain/brainscale",
"homepage": "http://github.com/chaobrain/brainscale",
"repository": "http://github.com/chaobrain/brainscale"
},
"split_keywords": [
"brain simulation",
" brain-inspired computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdf7ccd001780c661cf086dcac4688df693995affd6fde3639a0aa8eb91781ea",
"md5": "137c2803b4eb39aaf76d19a2d25f6ec1",
"sha256": "5184da355697ed74341582068f37cbd948f34a10b9704df204d8c11874fb76a6"
},
"downloads": -1,
"filename": "brainscale-0.0.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "137c2803b4eb39aaf76d19a2d25f6ec1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 156787,
"upload_time": "2025-07-29T02:28:01",
"upload_time_iso_8601": "2025-07-29T02:28:01.855603Z",
"url": "https://files.pythonhosted.org/packages/cd/f7/ccd001780c661cf086dcac4688df693995affd6fde3639a0aa8eb91781ea/brainscale-0.0.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-29 02:28:01",
"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": []
}
],
"lcname": "brainscale"
}
JSON
