|
1 | | -# ``brainpy.state`` README |
| 1 | +# `brainpy.state` - State-based Brain Dynamics Programming |
2 | 2 |
|
3 | | -This module is being maintained by [brainpy_state](https://github.com/chaobrain/brainpy.state). |
| 3 | +## Overview |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +## Features |
| 10 | + |
| 11 | +- **Explicit State Management**: Clear separation between model state and computation logic |
| 12 | +- **Composable State Transformations**: Build complex models from simple, reusable state components |
| 13 | +- **JAX-compatible**: Fully compatible with JAX's functional programming paradigm and JIT compilation |
| 14 | +- **Hardware Acceleration**: Leverage CPU, GPU, and TPU acceleration through JAX backend |
| 15 | + |
| 16 | +## Documentation |
| 17 | + |
| 18 | +For comprehensive documentation on state-based programming in BrainPy, please visit: |
| 19 | + |
| 20 | +- **State-based Documentation**: https://brainpy-state.readthedocs.io/ |
| 21 | +- **Main BrainPy Documentation**: https://brainpy.readthedocs.io/ |
| 22 | + |
| 23 | +## Source Repository |
| 24 | + |
| 25 | +This module is maintained in a separate repository: |
| 26 | + |
| 27 | +- **GitHub**: https://github.com/chaobrain/brainpy.state |
| 28 | + |
| 29 | +## Installation |
| 30 | + |
| 31 | +The `brainpy.state` module is included when you install BrainPy: |
| 32 | + |
| 33 | +```bash |
| 34 | +pip install brainpy -U |
| 35 | +``` |
| 36 | + |
| 37 | +For development or to install the state module separately: |
| 38 | + |
| 39 | +```bash |
| 40 | +pip install brainpy_state -U |
| 41 | +``` |
| 42 | + |
| 43 | +## Usage |
| 44 | + |
| 45 | +Import the state module from BrainPy: |
| 46 | + |
| 47 | +```python |
| 48 | +import brainpy as bp |
| 49 | +from brainpy import state |
| 50 | + |
| 51 | +# Use state-based components |
| 52 | +# (See documentation for detailed examples) |
| 53 | +``` |
| 54 | + |
| 55 | +## Support |
| 56 | + |
| 57 | +- **Bug Reports**: Please report issues at https://github.com/brainpy/BrainPy/issues |
| 58 | +- **State Module Issues**: For state-specific issues, see https://github.com/chaobrain/brainpy.state/issues |
| 59 | + |
| 60 | +## License |
| 61 | + |
| 62 | +Copyright 2025 BrainX Ecosystem Limited. Licensed under the Apache License, Version 2.0. |
0 commit comments