# Enabling Event-driven Computation in Brain Dynamics
[//]: # (<p align="center">)
[//]: # ( <img alt="Header image of brainevent." src="https://github.com/chaobrain/brainevent/blob/main/docs/_static/brainevent.png" width=50%>)
[//]: # (</p> )
<p align="center">
<a href="https://pypi.org/project/brainevent/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/brainevent"></a>
<a href="https://github.com/chaobrain/brainevent/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href='https://brainevent.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/brainevent/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://badge.fury.io/py/brainevent"><img alt="PyPI version" src="https://badge.fury.io/py/brainevent.svg"></a>
<a href="https://github.com/chaobrain/brainevent/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/brainevent/actions/workflows/CI.yml/badge.svg"></a>
<a href="https://pepy.tech/projects/brainevent"><img src="https://static.pepy.tech/badge/brainevent" alt="PyPI Downloads"></a>
</p>
Brain is characterized by the discrete spiking events, which are the fundamental units of computation in the brain.
`BrainEvent` provides a set of data structures and algorithms for such event-driven computation, which can be used to
model the brain dynamics in a more efficient and biologically plausible way.
Particularly, it provides the following class to represent binary events in the brain:
- ``EventArray``: representing array with a vector/matrix of events.
Furthermore, it implements the following commonly used data structures for event-driven computation
of the above class:
- ``COO``: a sparse matrix in COO format for sparse and event-driven computation.
- ``CSR``: a sparse matrix in CSR format for sparse and event-driven computation.
- ``CSC``: a sparse matrix in CSC format for sparse and event-driven computation.
- ``BlockCSR``: a block sparse matrix in CSR format for sparse and event-driven computation.
- ``BlockELL``: a block sparse matrix in ELL format for sparse and event-driven computation.
- ``JITC_CSR``: a just-in-time connectivity sparse matrix in CSR format for sparse and event-driven computation.
- ``JITC_CSC``: a just-in-time connectivity sparse matrix in CSC format for sparse and event-driven computation.
- ``FixedPreNumConn``: a fixed number of pre-synaptic connections for sparse and event-driven computation.
- ``FixedPostNumConn``: a fixed number of post-synaptic connections for sparse and event-driven computation.
- ...
`BrainEvent` is fully compatible with physical units and unit-aware computations provided in [BrainUnit](https://github.com/chaobrain/brainunit).
## Installation
You can install ``brainevent`` via pip:
```bash
pip install brainevent --upgrade
```
## Documentation
The official documentation is hosted on Read the
Docs: [https://brainevent.readthedocs.io/](https://brainevent.readthedocs.io/)
## See also the BDP ecosystem
We are building the Brain Dynamics Programming ecosystem: https://ecosystem-for-brain-dynamics.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/chaobrain/brainevent",
"name": "brainevent",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "computational neuroscience, brain-inspired computation, brain dynamics programming",
"author": "BrainEvent Developers",
"author_email": "BrainEvent Developers <chao.brain@qq.com>",
"download_url": null,
"platform": null,
"description": "# Enabling Event-driven Computation in Brain Dynamics\n\n[//]: # (<p align=\"center\">)\n\n[//]: # ( \t<img alt=\"Header image of brainevent.\" src=\"https://github.com/chaobrain/brainevent/blob/main/docs/_static/brainevent.png\" width=50%>)\n\n[//]: # (</p> )\n\n\n\n<p align=\"center\">\n\t<a href=\"https://pypi.org/project/brainevent/\"><img alt=\"Supported Python Version\" src=\"https://img.shields.io/pypi/pyversions/brainevent\"></a>\n\t<a href=\"https://github.com/chaobrain/brainevent/blob/main/LICENSE\"><img alt=\"LICENSE\" src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"></a>\n \t<a href='https://brainevent.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/brainevent/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://badge.fury.io/py/brainevent\"><img alt=\"PyPI version\" src=\"https://badge.fury.io/py/brainevent.svg\"></a>\n <a href=\"https://github.com/chaobrain/brainevent/actions/workflows/CI.yml\"><img alt=\"Continuous Integration\" src=\"https://github.com/chaobrain/brainevent/actions/workflows/CI.yml/badge.svg\"></a>\n <a href=\"https://pepy.tech/projects/brainevent\"><img src=\"https://static.pepy.tech/badge/brainevent\" alt=\"PyPI Downloads\"></a>\n</p>\n\n\n\n\nBrain is characterized by the discrete spiking events, which are the fundamental units of computation in the brain.\n\n`BrainEvent` provides a set of data structures and algorithms for such event-driven computation, which can be used to\nmodel the brain dynamics in a more efficient and biologically plausible way.\n\nParticularly, it provides the following class to represent binary events in the brain:\n\n- ``EventArray``: representing array with a vector/matrix of events.\n\nFurthermore, it implements the following commonly used data structures for event-driven computation\nof the above class:\n\n- ``COO``: a sparse matrix in COO format for sparse and event-driven computation.\n- ``CSR``: a sparse matrix in CSR format for sparse and event-driven computation.\n- ``CSC``: a sparse matrix in CSC format for sparse and event-driven computation.\n- ``BlockCSR``: a block sparse matrix in CSR format for sparse and event-driven computation.\n- ``BlockELL``: a block sparse matrix in ELL format for sparse and event-driven computation.\n- ``JITC_CSR``: a just-in-time connectivity sparse matrix in CSR format for sparse and event-driven computation.\n- ``JITC_CSC``: a just-in-time connectivity sparse matrix in CSC format for sparse and event-driven computation.\n- ``FixedPreNumConn``: a fixed number of pre-synaptic connections for sparse and event-driven computation.\n- ``FixedPostNumConn``: a fixed number of post-synaptic connections for sparse and event-driven computation.\n- ...\n\n\n`BrainEvent` is fully compatible with physical units and unit-aware computations provided in [BrainUnit](https://github.com/chaobrain/brainunit).\n\n\n## Installation\n\nYou can install ``brainevent`` via pip:\n\n```bash\npip install brainevent --upgrade\n```\n\n## Documentation\n\nThe official documentation is hosted on Read the\nDocs: [https://brainevent.readthedocs.io/](https://brainevent.readthedocs.io/)\n\n## See also the BDP ecosystem\n\nWe are building the Brain Dynamics Programming ecosystem: https://ecosystem-for-brain-dynamics.readthedocs.io/\n\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Event-driven Computation in JAX for Brain Dynamics.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/chaobrain/brainevent",
"homepage": "http://github.com/chaobrain/brainevent",
"repository": "http://github.com/chaobrain/brainevent"
},
"split_keywords": [
"computational neuroscience",
" brain-inspired computation",
" brain dynamics programming"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "04679f4214edbc8c93e53e0c1236cf212402a4fb211b58693d24d90aaced387b",
"md5": "a5f3627868c37ca01ea77904f18054f1",
"sha256": "0bc568cc24286f94e619b9a615fab0152f14fec91f6d03a7f968b5920b680f42"
},
"downloads": -1,
"filename": "brainevent-0.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5f3627868c37ca01ea77904f18054f1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 96556,
"upload_time": "2025-02-02T14:33:14",
"upload_time_iso_8601": "2025-02-02T14:33:14.968834Z",
"url": "https://files.pythonhosted.org/packages/04/67/9f4214edbc8c93e53e0c1236cf212402a4fb211b58693d24d90aaced387b/brainevent-0.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-02 14:33:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaobrain",
"github_project": "brainevent",
"github_not_found": true,
"lcname": "brainevent"
}
JSON
