semvec/pypi-packages huggingface dataset:
braintrace 0.1.2
Enabling Scalable Online Learning for Brain Dynamics.
License: Apache-2.0 license
Requires Python: >=3.10
Keywords: computational neuroscience, brain-inspired computing, brain modeling, online learning

<h1 align="center">BrainTrace</h1>
<h2 align="center">Eligibility Trace-based Online Learning for Brain Dynamics</h2>

<p align="center">
  	<img alt="Header image of braintrace." src="https://raw.githubusercontent.com/chaobrain/braintrace/main/docs/_static/braintrace.png" width=40%>
</p>

<p align="center">
	<a href="https://pypi.org/project/braintrace/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/braintrace"></a>
	<a href="https://github.com/chaobrain/braintrace/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
  	<a href="https://braintrace.readthedocs.io/?badge=latest"><img alt="Documentation" src="https://readthedocs.org/projects/braintrace/badge/?version=latest"></a>
  	<a href="https://badge.fury.io/py/braintrace"><img alt="PyPI version" src="https://badge.fury.io/py/braintrace.svg"></a>
    <a href="https://github.com/chaobrain/braintrace/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/braintrace/actions/workflows/CI.yml/badge.svg"></a>
</p>

[``braintrace``](https://github.com/chaobrain/braintrace) provides online learning algorithms for biological neural networks.
It has been integrated into our establishing [brain modeling ecosystem](https://brainmodeling.readthedocs.io/).

## Installation

``braintrace`` can run on Python 3.10+ installed on Linux, MacOS, and Windows. You can install ``braintrace`` via pip:

```bash
pip install braintrace --upgrade
```

Alternatively, you can install `BrainX`, which bundles `braintrace` 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://braintrace.readthedocs.io](https://braintrace.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 = {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

``braintrace`` is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/