Metadata-Version: 2.1
Name: brainscale
Version: 0.0.5
Summary: Enabling Scalable Online Learning for Brain Dynamics.
Home-page: https://github.com/chaobrain/brainscale
Author: BrainScale Developers
Author-email: BrainScale Developers <chao.brain@qq.com>
License: Apache-2.0 license
Project-URL: homepage, http://github.com/chaobrain/brainscale
Project-URL: repository, http://github.com/chaobrain/brainscale
Keywords: brain simulation,brain-inspired computing
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: brainstate (>=0.1.0)
Requires-Dist: brainunit
Provides-Extra: cpu
Requires-Dist: jax[cpu] ; extra == 'cpu'
Requires-Dist: brainunit[cpu] ; extra == 'cpu'
Requires-Dist: brainstate[cpu] ; extra == 'cpu'
Provides-Extra: cuda12
Requires-Dist: jax[cuda12] ; extra == 'cuda12'
Requires-Dist: brainunit[cuda12] ; extra == 'cuda12'
Requires-Dist: brainstate[cuda12] ; extra == 'cuda12'
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Provides-Extra: tpu
Requires-Dist: jax[tpu] ; extra == 'tpu'
Requires-Dist: brainunit[tpu] ; extra == 'tpu'
Requires-Dist: brainstate[tpu] ; extra == 'tpu'

<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/en/latest/?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)



## See also the brain modeling ecosystem

We are building the brain modeling ecosystem: https://brainmodeling.readthedocs.io/

