Installation¶
Installing pypillometry and its dependencies is automated and can be done by running the following lines (on Mac OS X or Linux).
$ git clone https://github.com/ihrke/pypillometry.git
$ cd pypillometry
$ pip install .
pypillometry is on PyPI and released versions can be installed with pip (this will also install the dependencies automatically):
$ pip install pypillometry
(link to the PyPI project page).
It is also possible to install the developer’s version directly from github using pip
$ pip install git+https://github.com/ihrke/pypillometry.git
Requirements¶
pypillometry requires Python 3.10 or newer and a range of standard numerical computing packages (all of which are listed in pyproject.toml and installed automatically)
numpy,scipyandmatplotlibcmdstanpy
Eyelink’s .edf files are read with the eyelinkio package, which is installed as well.
Saved eyedata files are compressed with zstd, which is part of Python’s standard library from Python 3.14 (on older versions, the backports.zstd package is installed).
The interactive viewer uses PyQt5 and vispy, which are installed by default.
For development, pip install -e ".[test]" installs the test dependencies as well.
It can be useful to access pypillometry through Jupyter or Jupyter Notebook, so installing those packages is also useful but not necessary.
Virtual environments¶
It can sometimes be useful to install a new package in a new virtual environment using either Python’s virtual environments or conda.
$ conda create -n pypil python=3
$ conda activate pypil
$ conda install anaconda
$ pip install pypillometry
The anaconda package contains all the requirements except cmdstanpy which can be installed from conda-forge
$ conda install -c conda-forge cmdstanpy
CmdStanPy¶
pypillometry uses cmdstanpy to interface with the Stan probabilistic programming language. cmdstanpy is a Python interface to the CmdStan command-line interface to Stan.
Please refer to the CmdStanPy documentation for more information on how to install and use it.
