/ecomp_experiment

Experiment code for the eComp experiment 2021

Primary LanguagePythonMIT LicenseMIT

Python build Python style Python test codecov DOI

eComp Experiment

This Python package implements the eComp experiment.

The archived version can be found on Zenodo:

Installation

  1. Download miniconda
  2. Run conda install mamba -c conda-forge
  3. Run the following commands from the root of this repository
mamba env create -f environment.yml
conda activate ecomp_experiment
pre-commit install
pip install -e .

Versioning

We follow a CalVer inspired versioning scheme.

Namely, each version consists of YYYY.MINOR.MICRO[.devX], where YYYY is the full year, MINOR is increased for each release that includes new features or behavior changes, MICRO is increased for each release that only consists of bug fixes or changes that don't impact the behavior of the software.

The [.devX] modifier is added for unreleased versions, where X is replaced by a number starting with 0.

For example, we started developing this package in 2021 in an unreleased version, so the initial version of the package was 2021.1.0.dev0, signalling that the next release (currently in development iteration 0; see dev0), will most likely be 2021.1.

Running the experiment

The experiment is intended to be run with simultaneous recording of EEG and eye-tracking data.

For more information on this, please see the EEG and eye-tracking directories respectively.

Further resources

All important details are reported in the original paper for the project:

The analysis code is available:

The data is available in several formats: