aeon_api

Project Aeon low-level library for interfacing with acquired data. Contains modules for loading and processing raw data.

Set-up Instructions

We recommend uv for python version, environment, and package dependency management. However, any other tool compatible with the pyproject.toml standard should work.

Install from PyPI

uv pip install swc-aeon

Install from source

git clone https://github.com/SainsburyWellcomeCentre/aeon_api
cd aeon_api
uv sync --all-extras

Repository Contents

• .github/workflows/ : GitHub actions workflows for building the environment and running tests
• aeon/ : Source code for the Aeon Python package
  • aeon/analysis: Source code for processing and plotting the raw data
  • aeon/io: Source code for loading raw data
  • aeon/schema: Core modules for defining data schemas used to load raw data from particular experiments
• tests/ : API unit tests
  • tests/data : Data used by tests
  • tests/io : Unit tests for the low-level raw data access API.
  • tests/schema : Schemas used to load sample data in test functions.

Citation Policy

If you use this software, please cite it as below:

D. Campagner, J. Bhagat, G. Lopes, L. Calcaterra, A. G. Pouget, A. Almeida, T. T. Nguyen, C. H. Lo, T. Ryan, B. Cruz, F. J. Carvalho, Z. Li, A. Erskine, J. Rapela, O. Folsz, M. Marin, J. Ahn, S. Nierwetberg, S. C. Lenzi, J. D. S. Reggiani, SGEN group – SWC GCNU Experimental Neuroethology Group. Aeon: an open-source platform to study the neural basis of ethological behaviours over naturalistic timescales. Preprint at https://doi.org/10.1101/2025.07.31.664513 (2025)