Start · Install

Development docs · 996102e0

View source

Install & environment center

Use this page to answer four setup questions before starting an analysis:

Which GazeAudit version am I installing?
Which Python versions are supported and currently tested?
Which optional dependency set do I actually need?
How do I verify that the installed environment matches what I intended?

Generated from package metadata. The version, Python requirement, base dependencies, extras, tested Python matrix, and console scripts on this page come from pyproject.toml and the repository test workflow. CI regenerates the metadata and fails if this reference drifts.

Current compatibility snapshot

Public release 0.2.0

Declared Python >=3.10

CI-tested Python 3.10, 3.11, 3.12, 3.13

Base dependencies 3

The site documents the current main branch as well as release 0.2.0. If reproducibility matters, record the installed package version and, for source checkouts, the exact Git commit. The Docs provenance reference explains the distinction.

1. Create an isolated environment

PyPA recommends using a virtual environment for third-party packages so project dependencies do not interfere with other Python environments.

Windows

py -m venv .venv
.venv\Scripts\activate
py -m pip install --upgrade pip

macOS / Linux

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip

After activation, python -m pip should point into the new environment.

2. Build the install command

The controls below only build a package-install command. They do not choose a scientific method, detector, threshold, AOI definition, or analysis pipeline.

Choose the source and optional capability. The command updates immediately; all controls have labels and the generated command is also announced as status text.

Installation source Public release 0.2.0 Current source checkout (editable)

Optional capability Choose only the extra required by the software capability you plan to use.

Generated install command

python -m pip install gazeaudit==0.2.0

Core public release command selected.

Without JavaScript, use the static commands and dependency tables below.

3. Choose the smallest relevant extra

PyPA extras add optional dependencies to the base package; they do not replace the base dependencies.

Extra	Adds	Typical software purpose
`plot`	matplotlib>=3.8	Generate GazeAudit figures with Matplotlib.
`pymovements`	pymovements>=0.28,<0.29	Use the pymovements adapter.
`peyes`	peyes>=0.2.2,<0.3; python_version >= '3.12'	Use the pEYES detector bridge; its dependency marker currently requires Python 3.12+.
`interop`	pymovements>=0.28,<0.29 peyes>=0.2.2,<0.3; python_version >= '3.12'	Install both supported interoperability dependency families where environment markers permit.
`gazebase`	pymovements==0.28.0 peyes==0.2.2; python_version >= '3.12'	Reproduce the repository's pinned GazeBase software environment.
`test`	pytest>=8 pytest-cov>=5 matplotlib>=3.8	Run the test suite and coverage locally.
`dev`	pytest>=8 pytest-cov>=5 ruff>=0.6	Run development tests, coverage, and Ruff.

Examples for release 0.2.0:

python -m pip install "gazeaudit[plot]==0.2.0"
python -m pip install "gazeaudit[pymovements]==0.2.0"
python -m pip install "gazeaudit[peyes]==0.2.0"
python -m pip install "gazeaudit[interop]==0.2.0"

For a local repository checkout:

python -m pip install -e .
python -m pip install -e ".[plot]"
python -m pip install -e ".[dev]"

4. Know what is always installed

The base package declares:

numpy>=1.24
packaging>=23
pandas>=2.0

These are package dependencies, not scientific-method endorsements. Dependency versions describe software compatibility constraints.

5. Verify the environment

Check the interpreter and installed release:

python --version
python -m pip show gazeaudit
python -c "import gazeaudit; print(gazeaudit.__version__)"

Then run a minimal import check:

from gazeaudit import GazeStudy, PipelineSpace, aoi_probabilities

print("GazeAudit public imports are available.")

For a more structured verification exercise, use Install → verify → first import.

6. Installed console commands

The package declares 8 console-script entry points. Packaging tools create command wrappers for these names when the distribution is installed.

Command	Entry point
`gazeaudit-gazebase-run`	`gazeaudit.gazebase_cli:main`
`gazeaudit-korthals-source-intake`	`gazeaudit.korthals_source_cli:main`
`gazeaudit-korthals-source-freeze`	`gazeaudit.korthals_freeze_cli:main`
`gazeaudit-korthals-source-intake-v2`	`gazeaudit.korthals_source_v2_cli:main`
`gazeaudit-korthals-source-freeze-v2`	`gazeaudit.korthals_freeze_v2_cli:main`
`gazeaudit-pedrotti-source-intake`	`gazeaudit.pedrotti_source_cli:main`
`gazeaudit-pedrotti-source-freeze`	`gazeaudit.pedrotti_freeze_cli:main`
`gazeaudit-revision-package`	`gazeaudit.revision_package_cli:main`

For the user-facing behavior of those commands, use the CLI reference.

7. Record the environment for reproducibility

At minimum, preserve:

python --version
python -m pip show gazeaudit
python -m pip freeze > requirements-lock.txt

For a source checkout, also record:

git rev-parse HEAD

A freeze file records the resolved environment; it does not prove that every resolved dependency was scientifically necessary. Keep the environment record separate from the scientific decision log.

Compatibility boundaries

The package declares Python >=3.10.
Repository CI currently tests Python 3.10, 3.11, 3.12, 3.13.
A dependency’s own environment marker can further narrow one optional feature. For example, the current pEYES dependency is conditional on Python 3.12+.
Passing installation or import checks establishes software availability, not measurement validity or inferential robustness.
The current documentation may describe post-release development on main; do not assume every main feature exists in PyPI release 0.2.0.

Authoritative packaging references

For GazeAudit-specific setup decisions, continue to Environment setup & reproducibility.