| Name | visiomode JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | None |
| Summary | An open-source platform for touchscreen-based visuomotor tasks in rodents. |
| upload_time | 2023-04-26 13:26:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2019 Constantinos Eleftheriou
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
behaviour
neuroscience
rodent
touchscreen
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
---
[](https://github.com/celefthe/visiomode/actions)
[](https://codecov.io/gh/celefthe/visiomode)
[](https://github.com/psf/black)
Visiomode is an open-source platform for rodent touchscreen-based visuomotor tasks. It has been designed to promote the use of touchscreens as an accessible option for implementing a variety of visual task paradigms, with low-cost and ease-of-use as a priority. Visiomode is implemented on the popular Raspberry Pi computer, and provides the user with an intuitive web interface to design and manage experiments. It can be deployed as a stand-alone cognitive testing solution in both freely-moving and head-restrained environments.
## Installation
### Raspberry Pi OS (recommended)
The recommended way to install Visiomode is by using `pipx` (<https://pypa.github.io/pipx/>). `pipx` will create an isolated python environment from which Visiomode will run, leaving the system python alone.
> WARNING: If you're using Pimoroni's Hyperpixel 4.0 display, you'll need Raspberry Pi OS "Buster" (<https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-legacy>), as the Hyperpixel 4.0 display does not yet support the latest Bullseye version (see <https://github.com/pimoroni/hyperpixel4/issues/155>).
First, make sure that your Raspberry Pi OS is up-to-date.
```bash
sudo apt update && sudo apt upgrade
```
Visiomode runs on SDL 2.0. To make sure all system dependencies are present, run
```bash
sudo apt install libsdl2-mixer-2.0-0 libsdl2-image-2.0-0 libsdl2-2.0-0 libsdl2-ttf-2.0-0
```
Install `pipx` using
```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```
And finally, install Visiomode using `pipx`:
```bash
pipx install visiomode
```
### Linux / MacOS
While Visiomode primarily targets the Raspberry Pi OS, it can be installed on any Linux or MacOS machine, which can be useful for trying out the software before deployment, or for testing. Please note that only the Raspberry Pi OS is officially supported - your milage with any other Linux distribution or MacOS in production may vary.
The recommended way to install Visiomode is via `pipx` (<https://pypa.github.io/pipx/>).
```bash
pipx install visiomode
```
## Usage
To launch Visiomode, open a terminal and run
```bash
visiomode
```
If running over `ssh`, you will need to prepend `DISPLAY=:0` to the `visiomode` command to run the behaviour window on the primary display.
```bash
DISPLAY=:0 visiomode
```
This will launch the behaviour window (what the animal sees). The web interface can be accessed from any machine connected on the same network as the Raspberry Pi running Visiomode at `http://<YOUR-PI-HOSTNAME>.local:5000`, where `<YOUR-PI-HOSTNAME>` is the hostname of your Raspberry Pi. If you're unsure on what this is, run `hostname` in a terminal window.
## Upgrading
Use `pipx` to upgrade visiomode:
```bash
pipx upgrade visiomode
```
## Contributing
Visiomode is currently closed to PRs, except bugfixes. Please open an issue if you wish to contribute.
## Funders
<p align="left">
<img width="250" src="./resources/sidb.jpg" alt="logo"/>
</p>
Raw data
{
"_id": null,
"home_page": null,
"name": "visiomode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "behaviour,neuroscience,rodent,touchscreen",
"author": null,
"author_email": "Constantinos Eleftheriou <Constantinos.Eleftheriou@ed.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/4e/1b/fef6eb54dafff91ca39e80c2e266e8d2473d53d2bc68e57c33d47e5b59f8/visiomode-0.5.2.tar.gz",
"platform": null,
"description": "\n\n---\n\n [](https://github.com/celefthe/visiomode/actions)\n[](https://codecov.io/gh/celefthe/visiomode)\n[](https://github.com/psf/black)\n\n\nVisiomode is an open-source platform for rodent touchscreen-based visuomotor tasks. It has been designed to promote the use of touchscreens as an accessible option for implementing a variety of visual task paradigms, with low-cost and ease-of-use as a priority. Visiomode is implemented on the popular Raspberry Pi computer, and provides the user with an intuitive web interface to design and manage experiments. It can be deployed as a stand-alone cognitive testing solution in both freely-moving and head-restrained environments.\n\n\n## Installation\n\n\n### Raspberry Pi OS (recommended)\n\nThe recommended way to install Visiomode is by using `pipx` (<https://pypa.github.io/pipx/>). `pipx` will create an isolated python environment from which Visiomode will run, leaving the system python alone.\n\n> WARNING: If you're using Pimoroni's Hyperpixel 4.0 display, you'll need Raspberry Pi OS \"Buster\" (<https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-legacy>), as the Hyperpixel 4.0 display does not yet support the latest Bullseye version (see <https://github.com/pimoroni/hyperpixel4/issues/155>).\n\nFirst, make sure that your Raspberry Pi OS is up-to-date.\n\n```bash\nsudo apt update && sudo apt upgrade\n```\n\nVisiomode runs on SDL 2.0. To make sure all system dependencies are present, run\n\n```bash\nsudo apt install libsdl2-mixer-2.0-0 libsdl2-image-2.0-0 libsdl2-2.0-0 libsdl2-ttf-2.0-0\n```\n\nInstall `pipx` using\n\n```bash\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n```\n\nAnd finally, install Visiomode using `pipx`:\n\n```bash\npipx install visiomode\n```\n\n\n### Linux / MacOS\n\nWhile Visiomode primarily targets the Raspberry Pi OS, it can be installed on any Linux or MacOS machine, which can be useful for trying out the software before deployment, or for testing. Please note that only the Raspberry Pi OS is officially supported - your milage with any other Linux distribution or MacOS in production may vary.\n\nThe recommended way to install Visiomode is via `pipx` (<https://pypa.github.io/pipx/>).\n\n```bash\npipx install visiomode\n```\n\n## Usage\n\nTo launch Visiomode, open a terminal and run\n\n```bash\nvisiomode\n```\n\nIf running over `ssh`, you will need to prepend `DISPLAY=:0` to the `visiomode` command to run the behaviour window on the primary display.\n\n```bash\nDISPLAY=:0 visiomode\n```\n\nThis will launch the behaviour window (what the animal sees). The web interface can be accessed from any machine connected on the same network as the Raspberry Pi running Visiomode at `http://<YOUR-PI-HOSTNAME>.local:5000`, where `<YOUR-PI-HOSTNAME>` is the hostname of your Raspberry Pi. If you're unsure on what this is, run `hostname` in a terminal window.\n\n\n## Upgrading\n\nUse `pipx` to upgrade visiomode:\n\n```bash\npipx upgrade visiomode\n```\n\n## Contributing\n\nVisiomode is currently closed to PRs, except bugfixes. Please open an issue if you wish to contribute.\n\n\n## Funders\n\n<p align=\"left\">\n <img width=\"250\" src=\"./resources/sidb.jpg\" alt=\"logo\"/>\n</p>\n",
"bugtrack_url": null,
"license": "MIT License\n \n \n Copyright (c) 2019 Constantinos Eleftheriou\n \n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "An open-source platform for touchscreen-based visuomotor tasks in rodents.",
"version": "0.5.2",
"split_keywords": [
"behaviour",
"neuroscience",
"rodent",
"touchscreen"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "42425bce4d8ee58c409bd4864f4350bb15a1e07b914d4954d427639e1f3c577c",
"md5": "cec6f1543412e7448535edd19fdb17b6",
"sha256": "fff1dba850cf93455d718b89b5b57c5a77190373102863cec5d80339fa8eac6d"
},
"downloads": -1,
"filename": "visiomode-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cec6f1543412e7448535edd19fdb17b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1681667,
"upload_time": "2023-04-26T13:26:31",
"upload_time_iso_8601": "2023-04-26T13:26:31.696727Z",
"url": "https://files.pythonhosted.org/packages/42/42/5bce4d8ee58c409bd4864f4350bb15a1e07b914d4954d427639e1f3c577c/visiomode-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4e1bfef6eb54dafff91ca39e80c2e266e8d2473d53d2bc68e57c33d47e5b59f8",
"md5": "7638d9b6383ec82646912a11c00a19a6",
"sha256": "db3c58cb9f47369d6f29f0f10bc8fd743723554b09fe1e5fcc5550fb531f9b15"
},
"downloads": -1,
"filename": "visiomode-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "7638d9b6383ec82646912a11c00a19a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3383264,
"upload_time": "2023-04-26T13:26:34",
"upload_time_iso_8601": "2023-04-26T13:26:34.335480Z",
"url": "https://files.pythonhosted.org/packages/4e/1b/fef6eb54dafff91ca39e80c2e266e8d2473d53d2bc68e57c33d47e5b59f8/visiomode-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-26 13:26:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "visiomode"
}
