Metadata-Version: 2.4
Name: brainpy-state
Version: 0.0.1
Summary: brainpy.state: stateful spiking neural network models in BrainPy
Keywords: computational neuroscience,brain-inspired computation,brain modeling,brain dynamics modeling,brain dynamics programming
Author-email: BrainX Team <chao.brain@qq.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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: Programming Language :: Python :: 3.14
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
License-File: LICENSE
Requires-Dist: numpy>=1.15
Requires-Dist: jax
Requires-Dist: tqdm
Requires-Dist: brainstate>=0.2.0
Requires-Dist: brainunit
Requires-Dist: brainevent>=0.0.4
Requires-Dist: braintools>=0.0.9
Requires-Dist: jax[cpu] ; extra == "cpu"
Requires-Dist: brainstate ; extra == "cpu"
Requires-Dist: brainunit ; extra == "cpu"
Requires-Dist: brainevent ; extra == "cpu"
Requires-Dist: braintools ; extra == "cpu"
Requires-Dist: jax[cuda12] ; extra == "cuda12"
Requires-Dist: brainstate ; extra == "cuda12"
Requires-Dist: brainunit ; extra == "cuda12"
Requires-Dist: brainevent ; extra == "cuda12"
Requires-Dist: braintools ; extra == "cuda12"
Requires-Dist: jax[cuda13] ; extra == "cuda13"
Requires-Dist: brainstate ; extra == "cuda13"
Requires-Dist: brainunit ; extra == "cuda13"
Requires-Dist: brainevent ; extra == "cuda13"
Requires-Dist: braintools ; extra == "cuda13"
Requires-Dist: jax[tpu] ; extra == "tpu"
Requires-Dist: brainstate ; extra == "tpu"
Requires-Dist: brainunit ; extra == "tpu"
Requires-Dist: brainevent ; extra == "tpu"
Requires-Dist: braintools ; extra == "tpu"
Project-URL: Bug Tracker, https://github.com/chaobrain/brainpy.state/issues
Project-URL: Documentation, https://brainpy-state.readthedocs.io/
Project-URL: Source Code, https://github.com/chaobrain/brainpy.state
Provides-Extra: cpu
Provides-Extra: cuda12
Provides-Extra: cuda13
Provides-Extra: tpu

  	Header image of brainpy.state - brain dynamics programming in Python.

``brainpy.state`` modernizes [BrainPy](https://github.com/brainpy/BrainPy) simulator of spiking neural networks with state-based syntax in [brainstate](https://github.com/chaobrain/brainstate).
Moreover, ``brainpy.state`` provides more features compared to ``BrainPy``, including:




## Links


- **Source**: https://github.com/chaobrain/brainpy.state
- **Documentation**: https://brainpy-state.readthedocs.io/
- **Bug reports**: https://github.com/chaobrain/brainpy.state/issues
- **Ecosystem**: https://brainmodeling.readthedocs.io/


## Installation

``brainpy.state`` is based on Python (>=3.10) and can be installed on Linux (Ubuntu 16.04 or later), macOS (10.12 or later), and Windows platforms. 

```bash
pip install brainpy-state -U
```

If you want to use ``brainpy.state`` with different hardware support, please install the corresponding version:

```bash
pip install brainpy-state[cpu] -U  # install with CPU support only
pip install brainpy-state[cuda12] -U  # install with CUDA 12.x support
pip install brainpy-state[cuda13] -U  # install with CUDA 13.x support
pip install brainpy-state[tpu] -U  # install with TPU support
```


Install the ``brainpy.state`` with the ecosystem packages:

```bash
pip install BrainX -U
```



## Citing 

If you are using ``brainpy.state``, please consider citing the corresponding paper:

```bibtex
@article {10.7554/eLife.86365,
    article_type = {journal},
    title = {BrainPy, a flexible, integrative, efficient, and extensible framework for general-purpose brain dynamics programming},
    author = {Wang, Chaoming and Zhang, Tianqiu and Chen, Xiaoyu and He, Sichao and Li, Shangyang and Wu, Si},
    editor = {Stimberg, Marcel},
    volume = 12,
    year = 2023,
    month = {dec},
    pub_date = {2023-12-22},
    pages = {e86365},
    citation = {eLife 2023;12:e86365},
    doi = {10.7554/eLife.86365},
    url = {https://doi.org/10.7554/eLife.86365},
    abstract = {Elucidating the intricate neural mechanisms underlying brain functions requires integrative brain dynamics modeling. To facilitate this process, it is crucial to develop a general-purpose programming framework that allows users to freely define neural models across multiple scales, efficiently simulate, train, and analyze model dynamics, and conveniently incorporate new modeling approaches. In response to this need, we present BrainPy. BrainPy leverages the advanced just-in-time (JIT) compilation capabilities of JAX and XLA to provide a powerful infrastructure tailored for brain dynamics programming. It offers an integrated platform for building, simulating, training, and analyzing brain dynamics models. Models defined in BrainPy can be JIT compiled into binary instructions for various devices, including Central Processing Unit (CPU), Graphics Processing Unit (GPU), and Tensor Processing Unit (TPU), which ensures high running performance comparable to native C or CUDA. Additionally, BrainPy features an extensible architecture that allows for easy expansion of new infrastructure, utilities, and machine-learning approaches. This flexibility enables researchers to incorporate cutting-edge techniques and adapt the framework to their specific needs},
    journal = {eLife},
    issn = {2050-084X},
    publisher = {eLife Sciences Publications, Ltd},
}
```




