Details Project Aeon, with a focus on dev practices and notes on technology review, challenges and insights.
ProjectAeon is a collaborative effort to perform behavioral neuroscience experiments where the behavior and neural activity of freely moving animals engaging in a complex task are continuously recorded. This project is contributed to by researchers and support staff at UCL's SWC, Neurogears, and Datajoint.
If you are interested in joining this project, please contact the project maintainers.
Below are the required sets of credentials for Project Aeon's members:
- Microsoft Teams: contact Jai Bhagat, Goncalo Lopes, or Dario Campagner
- SWC Github organization: contact SWC Helpdesk(helpdesk@swc.ucl.ac.uk)
- SWC Github 'aeon' project: contact Jai Bhagat or Goncalo Lopes
- SWC HPC: contact SWC Helpdesk
- 'aeon' HPC Linux group: contact SWC Helpdesk
- Datajoint database username: contact Thinh Nguyen (thinh@vathes.com)
To be granted these credentials, please send a single email to all contact parties requesting this access.
You must be an SWC Github 'aeon' project member to view some of these repositories.
Project Aeon's main library for interfacing with acquired data. Contains Python modules for raw data file io, data querying, data processing, data qc, database ingestion, and building computational data pipelines. This is the main user repository.
Note: All experiment data is acquired and/or triggered and/or synced by Harp devices. Code in the 'aeon_acquisition' and 'aeon_mecha' repos makes use of the Harp protocol during data acquisition, raw data file writing, and raw data file reading. In the 'harp-tech/protocol' Github repo, you can find documentation on Harp device operation and common registers, the Harp binary protocol, and Harp clock synchronization.
Contains experiment workflows written in the Bonsai visual programming language.
Contains the source code for the 'aeon_acquisition' Bonsai package, which is heavily used in workflows in 'aeon_experiments'.
Contains Python modules for analysis of Aeon experiment data.
Contains source code for actuating a linear drive motor used in Aeon experiments (designed primarily for moving electrophysiology cabling during freely-moving experiments).
Contains low-level source code for pellet delivery via feeders used in Aeon experiments.
Contains source code for the Aeon docs site, built via Sphinx. Built docs at: https://sainsburywellcomecentre.github.io/aeon_docs/
Our SDLC roughly follows the iterative model.
We version all the following, according to SemVer numbering:
- Experiments, by name, including full hardware specs (arena, I/O devices, acquisition computer, etc.)
- Repositories, including code related to:
- Bonsai experiment workflows
- Quality Control protocols (for raw and preprocessed data)
- Data processing algorithms
- aeon-db Database
- aeon-db tables
We prioritize and track dev progress using Github Discussions and Github Issues in Github Projects. Issues and Discussions should ideally be created in the specific repository appropriate for the Issue/Discussion; all experiment and general Issues and Discussions should be created in 'aeon_experiments'.
We use Github Actions to run CI. We run unit tests on Github Virtual Machines on Windows, MacOS, and Ubuntu. We run integration tests on the SWC HPC. Workflows of the CI jobs we run can be found in each repo's respective .github/workflows/ directory.
Each repository roughly follows the github flow (which is adapted from the more general gitflow).
In brief, each of our repos has 'main' and 'prod' branches. Feature and bug fix branches are branched off of 'main', with Pull Requests sent back into 'main'. 'main' contains the full commit history of the project, up to the latest stable commit. Upon merges into 'main', a squash merge is performed into 'prod', such that 'prod' contains an abbreviated commit history of the project, with commits pertaining only to Pull Request merges. 'prod' thus serves as a "production" branch to allow for easier readability of project history and easier reversion of uncaught bug commits. At certain agreed upon timepoints we create "stable releases" (available in the "releases" section of the repository) which serve as a snapshot of the code at the time, version numbered according to SemVer.
When contributing to any repository, the change to be made should first be discussed in a Github Discussion or a Github Issue. Thereafter, contributors should create a new branch (branched off of 'main') that contains the changes/additions they wish to make, and then create a pull request for merging this branch into 'main'.
All pull requests will be reviewed by the project maintainers. Minimally, maintainers should follow the below steps when reviewing pull requests:
-
Ensure new code adheres to the style and documentation guidelines, is covered by a test, and passes a build test. These can all be checked via CI.
-
As necessary, ensure
changelog,readme, config and doc files are updated. -
When a branch is ready to be merged back into 'main', always make sure to first pull 'main' locally, then rebase the feature branch onto 'main' (cleaning up any merge conflicts as necessary), before merging the PR. The squash merge into 'prod' can be handled via CI. E.g., see here
Please see our style and documentation guidelines.
We also believe in the readme manifesto, which says that readme files should provide at least a general description that covers all of a project's files, and that one readme per subdirectory is generally good practice.
Please see our code of conduct.
Jai Bhagat (jai.bhagat.21@ucl.ac.uk)
Gonçalo Lopes (g.lopes@neurogears.org)
Dario Campagner (d.campagner@ucl.ac.uk)
code_of_conduct.md: Project Aeon's code of conduct.data_contract.md: An example of a data contract for devices <-> generated Aeon experiment data.design_considerations.md: Design considerations for Project Aeon.glossary.tsv: A glossary of Project Aeon terminology.init_proj.sh: A shell script for initializing a project repository.style_and_doc_guidelines.md: Code style and documentation guidelines for Project Aeon.
If you use this software, please cite it as below:
Sainsbury Wellcome Centre Foraging Behaviour Working Group. (2023). Aeon: An open-source platform to study the neural basis of ethological behaviours over naturalistic timescales, https://doi.org/10.5281/zenodo.8413142
