Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ We provide a Binder environment for BrainPy. You can use the following button to

## Ecosystem

- **[BrainPy](https://github.com/brainpy/BrainPy)**: The solution for the general-purpose brain dynamics programming.
- **[brainpy-examples](https://github.com/brainpy/examples)**: Comprehensive examples of BrainPy computation.
- **[brain modeling ecosystem](https://brainmodeling.readthedocs.io/)**: A collection of tools and libraries for brain modeling and simulation.
- **[brainpy-examples](https://github.com/brainpy/examples)**: Comprehensive examples of BrainPy computation.
- **[brainpy-state](https://github.com/chaobrain/brainpy.state)**: Moderize BrainPy simulation with `brainstate` syntax.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Fix the typo "Moderize" → "Modernize".

Change the description to “Modernize BrainPy simulation with brainstate syntax.”

Suggested change
- **[brainpy-state](https://github.com/chaobrain/brainpy.state)**: Moderize BrainPy simulation with `brainstate` syntax.
- **[brainpy-state](https://github.com/chaobrain/brainpy.state)**: Modernize BrainPy simulation with `brainstate` syntax.

- [《神经计算建模实战》 (Neural Modeling in Action)](https://github.com/c-xy17/NeuralModeling)
- [第一届神经计算建模与编程培训班 (First Training Course on Neural Modeling and Programming)](https://github.com/brainpy/1st-neural-modeling-and-programming-course)
- [第二届神经计算建模与编程培训班 (Second Training Course on Neural Modeling and Programming)](https://github.com/brainpy/2nd-neural-modeling-and-programming-course)
Expand Down
63 changes: 61 additions & 2 deletions brainpy/state/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,62 @@
# ``brainpy.state`` README
# `brainpy.state` - State-based Brain Dynamics Programming

This module is being maintained by [brainpy_state](https://github.com/chaobrain/brainpy.state).
## Overview

The `brainpy.state` module provides a state-based programming interface for brain dynamics modeling in BrainPy. This module is maintained as a separate package [`brainpy_state`](https://github.com/chaobrain/brainpy.state) and re-exported through BrainPy for seamless integration.

State-based programming offers an alternative paradigm for defining and managing neural models, emphasizing explicit state management and transformations for building complex brain dynamics systems.

## Features

- **Explicit State Management**: Clear separation between model state and computation logic
- **Composable State Transformations**: Build complex models from simple, reusable state components
- **JAX-compatible**: Fully compatible with JAX's functional programming paradigm and JIT compilation
- **Hardware Acceleration**: Leverage CPU, GPU, and TPU acceleration through JAX backend
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): Consider adding "the" before "JAX backend" for smoother grammar.

For example: “Leverage CPU, GPU, and TPU acceleration through the JAX backend.”

Suggested change
- **Hardware Acceleration**: Leverage CPU, GPU, and TPU acceleration through JAX backend
- **Hardware Acceleration**: Leverage CPU, GPU, and TPU acceleration through the JAX backend


## Documentation

For comprehensive documentation on state-based programming in BrainPy, please visit:

- **State-based Documentation**: https://brainpy-state.readthedocs.io/
- **Main BrainPy Documentation**: https://brainpy.readthedocs.io/

## Source Repository

This module is maintained in a separate repository:

- **GitHub**: https://github.com/chaobrain/brainpy.state

## Installation

The `brainpy.state` module is included when you install BrainPy:

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

For development or to install the state module separately:

```bash
pip install brainpy_state -U
```

## Usage

Import the state module from BrainPy:

```python
import brainpy as bp
from brainpy import state

# Use state-based components
# (See documentation for detailed examples)
```

## Support

- **Bug Reports**: Please report issues at https://github.com/brainpy/BrainPy/issues
- **State Module Issues**: For state-specific issues, see https://github.com/chaobrain/brainpy.state/issues

## License

Copyright 2025 BrainX Ecosystem Limited. Licensed under the Apache License, Version 2.0.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ dependencies = [
"brainunit",
"brainevent>=0.0.4",
"braintools>=0.0.9",
'brainpy_state>=0.0.2',
'brainpy_state>=0.0.3',
]

dynamic = ['version']
Expand Down
Loading
Loading