Brian2CUDA
==========
Brian2CUDA is an extension of the spiking neural network simulator
[Brian2](https://github.com/brian-team/brian2), written in Python. It
generates C++/CUDA code to run simulations on NVIDIA GPUs.
For **support**, please use the [Brian forum](https://brian.discourse.group/). If
you think you found a bug in Brian2CUDA, please report it at the
[GitHub issue tracker](https://github.com/brian-team/brian2cuda/issues).
For **installation and usage instructions**, check out the
[Brian2CUDA documentation](https://brian2cuda.readthedocs.io).
For information on general Brian2 usage, check out the
[Brian2 documentation](http://brian2.readthedocs.io).
## Quick start
### Installation
You can install Brian2CUDA via `pip`:
```bash
python -m pip install brian2cuda
```
This will install a compatible version of Brian2 as dependency. For installation requirements and GPU configuration, check out the [Brian2CUDA documentation](https://brian2cuda.readthedocs.io/en/latest/index.html).
### Usage
Use your Brian2 code (see [Brian2 documentation](http://brian2.readthedocs.io/en/stable/index.html)) and modify the imports to:
```python
# Standard Brian2 import
from brian2 import *
# Enable GPU usage via Brian2CUDA
import brian2cuda
set_device("cuda_standalone")
```
See [Brian2's standalone code generation](https://brian2.readthedocs.io/en/stable/user/computation.html?highlight=set_device#standalone-code-generation) for more options for the `set_device` call.
## Citation
If you use this software in a published article, please cite
[our Brian2CUDA publication](https://www.frontiersin.org/articles/10.3389/fninf.2022.883700):
> Alevi, D, Stimberg, M, Sprekeler, H, Obermayer, K, Augustin, M. “Brian2CUDA: flexible and efficient simulation of spiking neural network models on GPUs” Frontiers in Neuroinformatics (2022). doi: 10.3389/fninf.2022.883700.
## License
Brian2CUDA is free software licensed under the [GNU General Public License v3 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.en.html).
## Testing
To run the test suite on Google Collab (no installation or GPU required), click on the badge below:
[](https://colab.research.google.com/github/brian-team/brian2cuda/blob/master/brian2cuda/tools/test_suite/run_tests.ipynb)
Raw data
{
"_id": null,
"home_page": null,
"name": "Brian2Cuda",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "computational neuroscience, simulation, neural networks, spiking neurons, gpu, cuda",
"author": "Denis Alevi, Moritz Augustin, Marcel Stimberg",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a8/a5/010370d521bdda7f207ec8f4b507be91037377cb5e4e90b37ae85a9bed1d/Brian2Cuda-1.0a4.tar.gz",
"platform": null,
"description": "Brian2CUDA\n==========\n\nBrian2CUDA is an extension of the spiking neural network simulator\n[Brian2](https://github.com/brian-team/brian2), written in Python. It\ngenerates C++/CUDA code to run simulations on NVIDIA GPUs.\n\nFor **support**, please use the [Brian forum](https://brian.discourse.group/). If\nyou think you found a bug in Brian2CUDA, please report it at the\n[GitHub issue tracker](https://github.com/brian-team/brian2cuda/issues).\n\nFor **installation and usage instructions**, check out the\n[Brian2CUDA documentation](https://brian2cuda.readthedocs.io).\nFor information on general Brian2 usage, check out the\n[Brian2 documentation](http://brian2.readthedocs.io).\n\n## Quick start\n### Installation\n\nYou can install Brian2CUDA via `pip`:\n\n```bash\npython -m pip install brian2cuda\n```\n\nThis will install a compatible version of Brian2 as dependency. For installation requirements and GPU configuration, check out the [Brian2CUDA documentation](https://brian2cuda.readthedocs.io/en/latest/index.html).\n\n### Usage\nUse your Brian2 code (see [Brian2 documentation](http://brian2.readthedocs.io/en/stable/index.html)) and modify the imports to:\n\n```python\n# Standard Brian2 import\nfrom brian2 import *\n\n# Enable GPU usage via Brian2CUDA\nimport brian2cuda\nset_device(\"cuda_standalone\")\n```\n\nSee [Brian2's standalone code generation](https://brian2.readthedocs.io/en/stable/user/computation.html?highlight=set_device#standalone-code-generation) for more options for the `set_device` call.\n\n\n## Citation\nIf you use this software in a published article, please cite\n[our Brian2CUDA publication](https://www.frontiersin.org/articles/10.3389/fninf.2022.883700):\n\n> Alevi, D, Stimberg, M, Sprekeler, H, Obermayer, K, Augustin, M. \u201cBrian2CUDA: flexible and efficient simulation of spiking neural network models on GPUs\u201d Frontiers in Neuroinformatics (2022). doi: 10.3389/fninf.2022.883700.\n\n## License\nBrian2CUDA is free software licensed under the [GNU General Public License v3 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.en.html).\n\n## Testing\nTo run the test suite on Google Collab (no installation or GPU required), click on the badge below:\n\n[](https://colab.research.google.com/github/brian-team/brian2cuda/blob/master/brian2cuda/tools/test_suite/run_tests.ipynb)\n",
"bugtrack_url": null,
"license": null,
"summary": "A Brian2 extension to simulate spiking neural networks on GPUs",
"version": "1.0a4",
"project_urls": {
"Documentation": "https://brian2cuda.readthedocs.io/",
"Source": "https://github.com/brian-team/brian2cuda",
"Tracker": "https://github.com/brian-team/brian2cuda/issues"
},
"split_keywords": [
"computational neuroscience",
" simulation",
" neural networks",
" spiking neurons",
" gpu",
" cuda"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "944eec467bd0dc5636b0da3cf10f515f419927e4ed24730396aba2fe3e845a84",
"md5": "6720cbe5432ba5d778bc35e588e9e7be",
"sha256": "3b77beee122deed79711ec98c8da11b067ff69a5eeb3d0671ddade7fc903be00"
},
"downloads": -1,
"filename": "Brian2Cuda-1.0a4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6720cbe5432ba5d778bc35e588e9e7be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 206432,
"upload_time": "2024-03-26T19:48:05",
"upload_time_iso_8601": "2024-03-26T19:48:05.901401Z",
"url": "https://files.pythonhosted.org/packages/94/4e/ec467bd0dc5636b0da3cf10f515f419927e4ed24730396aba2fe3e845a84/Brian2Cuda-1.0a4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8a5010370d521bdda7f207ec8f4b507be91037377cb5e4e90b37ae85a9bed1d",
"md5": "c5fb9178e08b544323dde348e3188f41",
"sha256": "5f3bdbfa79edd36adda30e3c6a975ab5dd1ce2c9a8eabcd6606fe5a37c5ab172"
},
"downloads": -1,
"filename": "Brian2Cuda-1.0a4.tar.gz",
"has_sig": false,
"md5_digest": "c5fb9178e08b544323dde348e3188f41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 218471,
"upload_time": "2024-03-26T19:48:07",
"upload_time_iso_8601": "2024-03-26T19:48:07.266388Z",
"url": "https://files.pythonhosted.org/packages/a8/a5/010370d521bdda7f207ec8f4b507be91037377cb5e4e90b37ae85a9bed1d/Brian2Cuda-1.0a4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 19:48:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brian-team",
"github_project": "brian2cuda",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "brian2cuda"
}
JSON
