| Name | rockpool JSON |
| Version |
2.7
JSON |
| download |
| home_page | |
| Summary | A Python package for developing, simulating and training spiking neural networks, and deploying on neuromorphic hardware |
| upload_time | 2023-09-26 15:33:27 |
| maintainer | |
| docs_url | None |
| author | SynSense |
| requires_python | >=3.8 |
| license | |
| keywords |
spiking
neural
network
snn
neuromorphic
machine
learning
ml
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Rockpool
  [](https://rockpool.ai)  [](https://doi.org/10.5281/zenodo.3773845)
Rockpool is a Python package for developing signal processing applications with spiking neural networks. Rockpool allows you to build networks, simulate, train and test them, deploy them either in simulation or on event-driven neuromorphic compute hardware. Rockpool provides layers with a number of simulation backends, including Brian2, Torch, JAX, Numba and raw numpy. Rockpool is designed to make machine learning based on SNNs easier. It is not designed for detailed simulation of biological networks.
# Documentation and getting started
The best place to start with Rockpool is the [documentation](https://rockpool.ai), which contains tutorials and getting started guides.
The documentation is hosted online: [https://rockpool.ai/](https://rockpool.ai/), or can be built and hosted locally with Sphinx. Much of the documentation is available as Jupyter notebooks, to be used interactively.
# Installation instructions
Use `pip` to install Rockpool and required dependencies
```bash
$ pip install rockpool --user
```
The `--user` option installs the package only for the current user.
If you want to install all the extra dependencies required for Brian, PyTorch and Jax layers, use the command
```bash
$ pip install rockpool[all] --user
```
# License
Rockpool is released under a AGPL license. Commercial licenses are available on request.
# Contributing
Fork the public repository at https://github.com/SynSense/rockpool, then clone your fork.
```bash
$ git clone https://github.com/your-fork-location/rockpool.git rockpool
```
Install the package in development mode using `pip`
```bash
$ cd rockpool
$ pip install -e . --user
```
or
```bash
$ pip install -e .[all] --user
```
The main branch is `development`. You should commit your modifications to a new feature branch.
```bash
$ git checkout -b feature/my-feature develop
...
$ git commit -m 'This is a verbose commit message.'
```
Then push your new branch to your repository
```bash
$ git push -u origin feature/my-feature
```
When you're finished with your modifications, make a merge request on github.com, from your branch in your fork to https://github.com/SynSense/rockpool.
Raw data
{
"_id": null,
"home_page": "",
"name": "rockpool",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "spiking neural network SNN neuromorphic machine learning ML",
"author": "SynSense",
"author_email": "dylan.muir@synsense.ai",
"download_url": "https://files.pythonhosted.org/packages/1e/aa/6eb56862acde00ccd438179a359b0770418b80018de21b0d014187480273/rockpool-2.7.tar.gz",
"platform": null,
"description": "# Rockpool\n\n  [](https://rockpool.ai)  [](https://doi.org/10.5281/zenodo.3773845)\n\n\n\nRockpool is a Python package for developing signal processing applications with spiking neural networks. Rockpool allows you to build networks, simulate, train and test them, deploy them either in simulation or on event-driven neuromorphic compute hardware. Rockpool provides layers with a number of simulation backends, including Brian2, Torch, JAX, Numba and raw numpy. Rockpool is designed to make machine learning based on SNNs easier. It is not designed for detailed simulation of biological networks.\n\n# Documentation and getting started\n\nThe best place to start with Rockpool is the [documentation](https://rockpool.ai), which contains tutorials and getting started guides.\n\nThe documentation is hosted online: [https://rockpool.ai/](https://rockpool.ai/), or can be built and hosted locally with Sphinx. Much of the documentation is available as Jupyter notebooks, to be used interactively.\n\n# Installation instructions\n\nUse `pip` to install Rockpool and required dependencies\n\n```bash\n$ pip install rockpool --user\n```\n\nThe `--user` option installs the package only for the current user.\n\nIf you want to install all the extra dependencies required for Brian, PyTorch and Jax layers, use the command\n\n```bash\n$ pip install rockpool[all] --user\n```\n\n# License\n\nRockpool is released under a AGPL license. Commercial licenses are available on request.\n\n# Contributing\n\nFork the public repository at https://github.com/SynSense/rockpool, then clone your fork.\n\n```bash\n$ git clone https://github.com/your-fork-location/rockpool.git rockpool\n```\n\nInstall the package in development mode using `pip`\n\n```bash\n$ cd rockpool\n$ pip install -e . --user\n```\n\nor\n\n```bash\n$ pip install -e .[all] --user\n```\n\nThe main branch is `development`. You should commit your modifications to a new feature branch.\n\n```bash\n$ git checkout -b feature/my-feature develop\n...\n$ git commit -m 'This is a verbose commit message.'\n```\n\nThen push your new branch to your repository\n\n```bash\n$ git push -u origin feature/my-feature\n```\n\nWhen you're finished with your modifications, make a merge request on github.com, from your branch in your fork to https://github.com/SynSense/rockpool.",
"bugtrack_url": null,
"license": "",
"summary": "A Python package for developing, simulating and training spiking neural networks, and deploying on neuromorphic hardware",
"version": "2.7",
"project_urls": {
"Bug Tracker": "https://github.com/SynSense/rockpool/issues",
"Documentation": "https://rockpool.ai",
"Source Code": "https://github.com/SynSense/rockpool"
},
"split_keywords": [
"spiking",
"neural",
"network",
"snn",
"neuromorphic",
"machine",
"learning",
"ml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1eaa6eb56862acde00ccd438179a359b0770418b80018de21b0d014187480273",
"md5": "137f1602c880c98370d287205cdcdff2",
"sha256": "f7a9f407ed1f9315be012ec68df3e013452a2f80fe4cfa39fa0dd90d634fce68"
},
"downloads": -1,
"filename": "rockpool-2.7.tar.gz",
"has_sig": false,
"md5_digest": "137f1602c880c98370d287205cdcdff2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 477622,
"upload_time": "2023-09-26T15:33:27",
"upload_time_iso_8601": "2023-09-26T15:33:27.023249Z",
"url": "https://files.pythonhosted.org/packages/1e/aa/6eb56862acde00ccd438179a359b0770418b80018de21b0d014187480273/rockpool-2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 15:33:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SynSense",
"github_project": "rockpool",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rockpool"
}
