Metadata-Version: 2.4
Name: brainstate
Version: 0.2.2
Summary: A State-based Transformation System for Brain Modeling.
Author-email: BrainState Developers <chao.brain@qq.com>
License: Apache-2.0 license
Project-URL: homepage, https://github.com/chaobrain/brainstate
Project-URL: repository, https://github.com/chaobrain/brainstate
Project-URL: Documentation, https://brainstate.readthedocs.io/
Project-URL: Source Code, https://github.com/chaobrain/brainstate
Project-URL: Bug Tracker, https://github.com/chaobrain/brainstate/issues
Keywords: computational neuroscience,brain-inspired computing,brain simulation,brain modeling,spiking neural networks
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: numpy>=1.15
Requires-Dist: tqdm
Requires-Dist: brainunit
Requires-Dist: brainevent
Provides-Extra: cpu
Requires-Dist: jax[cpu]; extra == "cpu"
Requires-Dist: brainunit; extra == "cpu"
Requires-Dist: brainevent; extra == "cpu"
Provides-Extra: cuda12
Requires-Dist: jax[cuda12]; extra == "cuda12"
Requires-Dist: brainunit; extra == "cuda12"
Requires-Dist: brainevent; extra == "cuda12"
Provides-Extra: cuda13
Requires-Dist: jax[cuda13]; extra == "cuda13"
Requires-Dist: brainunit; extra == "cuda13"
Requires-Dist: brainevent; extra == "cuda13"
Provides-Extra: tpu
Requires-Dist: jax[tpu]; extra == "tpu"
Requires-Dist: brainunit; extra == "tpu"
Requires-Dist: brainevent; extra == "tpu"
Provides-Extra: testing
Requires-Dist: absl-py; extra == "testing"
Requires-Dist: pytest; extra == "testing"
Requires-Dist: jax; extra == "testing"
Requires-Dist: brainunit; extra == "testing"
Requires-Dist: brainevent; extra == "testing"
Dynamic: license-file


# A ``State``-based Transformation System for Brain Modeling



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



<p align="center">
	<a href="https://pypi.org/project/brainstate/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/brainstate"></a>
	<a href="https://github.com/chaobrain/brainstate/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
  	<a href='https://brainstate.readthedocs.io/?badge=latest'>
        <img src='https://readthedocs.org/projects/brainstate/badge/?version=latest' alt='Documentation Status' />
    </a>
    <a href="https://badge.fury.io/py/brainstate"><img alt="PyPI version" src="https://badge.fury.io/py/brainstate.svg"></a>
    <a href="https://github.com/chaobrain/brainstate/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/brainstate/actions/workflows/CI.yml/badge.svg"></a>
    <a href="https://pepy.tech/projects/brainstate"><img src="https://static.pepy.tech/badge/brainstate" alt="PyPI Downloads"></a>
    <a href="https://doi.org/10.5281/zenodo.14970015"><img src="https://zenodo.org/badge/811300394.svg" alt="DOI"></a>
</p>


## Installation

You can install ``brainstate`` via pip:

```bash
pip install brainstate --upgrade
```

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



## See also the ecosystem

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


