Skip to content

Getting started

Use the bundled synthetic data to run a complete first workflow without private participant exports.

Install

python -m pip install "gp3tools==0.1.0a1"

python -m pip install --pre gp3tools

uv pip install "gp3tools==0.1.0a1"

The GitHub CI matrix validates Python 3.11, 3.12 and 3.13.

The published distributions are available from PyPI, and the archived software release is available at Zenodo DOI 10.5281/zenodo.22150772.

Verify

import gp3tools as gp3

print(gp3.__version__)
print(len(gp3.R_EXPORTS))
print(len(gp3.__all__))

Validated contracts:

R exports:           278
Python public names: 285

Load example data

master = gp3.load_example_master()
print(master.shape)

Check sampling

sampling = gp3.check_sampling_rate(
    master,
    time_col="TIME",
    group_cols=["subject", "trial_global"],
)

Preprocess pupil data

processed = gp3.preprocess_gazepoint_signals(
    master,
    pupil_col="pupil",
    time_col="TIME",
)

Analyse AOI transitions

transitions = gp3.compute_gazepoint_aoi_transition_matrix(
    master,
    aoi_col="aoi_current",
)

Create a figure

fig = gp3.plot_gazepoint_heatmap(master)

Where next?