pyReiz is a low-level auditory and visual stimulus presentation suite wrapping pyglet, sending markers via a pylsl outlet. You can also read more extensive documentation online.
The requirements for pyReiz are pyglet and pylsl. They are checked, and if necessary installed, during pip install
. There is also a dependency on pyttsx3 to allow on-demand synthesis of auditory cues from text. If you don't need that or can't acquire a version of pyttsx3 for your architecture, install pyreiz without the [tts]
suffix.
pip install Reiz[tts]
The most recent version of pylsl is not yet on pypi. A solution is to install libsl manually. You download a recent build of liblsl from https://github.com/sccn/liblsl/releases. Afterwards, install pylsl directly from github.
pip install git https://github.com/labstreaminglayer/liblsl-Python.git
pip install Reiz[tts]
On Mac, tts and reiz-marker are not supported. These functionalities will be mocked, so at least, you can develop on Mac to deploy on Linux or Windows.
pip install Reiz
git clone https://github.com/pyreiz/pyreiz.git
cd pyreiz
pip install -e .[tts]
After you installed Reiz, you can give it a test-run by calling python -m reiz.examples.basic
from your terminal. This should start a throwaway MarkerServer, and present a series of visual and auditory stimuli. If anything does not work out, inform us of the issue.
Examples can be found in reiz/examples
. A quite extensively documented basic example can be found here: basic example.
Because all markers are send via LSL, i suggest recording with Labrecorder. Use at least 1.13, as this version supports BIDS-conform recording, offers a remote interface and has a critical timing bugfix included.
The key requirements for pyReiz are pyglet and pylsl. We require pylsl>=1.13 because a timing issue was fixed in that version (see sccn/liblsl#8), and pyglet>1.4 because there was a breaking change between 1.3 and 1.4 in the way audio was generated and played (see #2). For text-to-speech, which is included with [tts]
, a key requirement is pyttsx3.
I adapted code from Cocos2d for generation of some openGL primitives.