Installation

PyPlr is registered on PyPI, which means the latest version can be installed easily via the pip packaging tool (this will also install the dependencies automatically):

$ pip install pyplr

(link to the PyPI project page).

The latest development version can also be installed from GitHub with pip:

$ pip install git+https://github.com/PyPlr/cvd_pupillometry.git

Alternatively, you can clone from from git and install with setuptools:

$ git clone https://github.com/PyPlr/cvd_pupillometry.git PyPlr
$ cd PyPlr
$ python setup.py install

If you want to make changes to the code and have those changes instantly available on sys.path you can use setuptools’ develop mode:

$ python setup.py develop

Requirements

PyPlr requires Python3 and a set of standard numerical computing packages, all of which are listed in requirements.txt:

matplotlib==3.3.4
msgpack==1.0.2
numexpr==2.7.2
numpy==1.19.1
pandas==1.2.2
pyzmq==22.0.2
requests==2.24.0
scipy==1.6.0
seaborn==0.10.1
seabreeze==1.1.0
tables==3.6.1

The following additional packages may also be helpful for development:

All requirements can be installed by running pip install -r requirements.txt.

Virtual environments

We recommend installing PyPlr in a virtual environment. This can be done using either Python’s virtual environments or conda:

$ conda create -n pyplr python=3.7.7
$ conda activate pyplr
$ python setup.py install

Notes/Potential Issues

We are aware of the following:

  • psychopy thread issue - revert to pyglet=1.4.10

Tables and indices