aeon_api

Project Aeon low-level library for interfacing with acquired data. Contains modules for raw data file io, data querying, and data processing.

https://github.com/sainsburywellcomecentre/aeon_api

Science Score: 75.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
    Organization sainsburywellcomecentre has institutional domain (www.ucl.ac.uk)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Project Aeon low-level library for interfacing with acquired data. Contains modules for raw data file io, data querying, and data processing.

Basic Info
  • Host: GitHub
  • Owner: SainsburyWellcomeCentre
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 1.19 MB
Statistics
  • Stars: 1
  • Watchers: 9
  • Forks: 1
  • Open Issues: 14
  • Releases: 1
Created over 1 year ago · Last pushed 11 months ago
Metadata Files
Readme Contributing License Citation

README.md

aeon_api

aeon_api_env_build_and_tests aeon_api_tests_code_coverage

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:

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.8411157

DOI

Owner

  • Name: SainsburyWellcomeCentre
  • Login: SainsburyWellcomeCentre
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors: 
-  family-names: "Sainsbury Wellcome Centre Foraging Behaviour Working Group"
title: "Aeon: An open-source platform to study the neural basis of ethological behaviours over naturalistic timescales"
doi: 10.5281/zenodo.8413142
date-released: 2023-10-05
url: https://github.com/SainsburyWellcomeCentre/aeon_docs

GitHub Events

Total
  • Create event: 18
  • Issues event: 12
  • Release event: 1
  • Delete event: 14
  • Issue comment event: 30
  • Push event: 50
  • Public event: 1
  • Pull request review comment event: 12
  • Pull request review event: 19
  • Pull request event: 27
  • Fork event: 1
Last Year
  • Create event: 18
  • Issues event: 12
  • Release event: 1
  • Delete event: 14
  • Issue comment event: 30
  • Push event: 50
  • Public event: 1
  • Pull request review comment event: 12
  • Pull request review event: 19
  • Pull request event: 27
  • Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 9
  • Total pull requests: 16
  • Average time to close issues: 6 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.25
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 9
  • Pull requests: 16
  • Average time to close issues: 6 days
  • Average time to close pull requests: 6 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.25
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • glopesdev (6)
  • anayapouget (2)
  • lochhh (1)
Pull Request Authors
  • glopesdev (10)
  • lochhh (3)
  • anayapouget (3)
Top Labels
Issue Labels
proposal (5) bug (3) question (2)
Pull Request Labels
feature (5) fix (4) documentation (1)

Dependencies

.github/workflows/build_env_run_tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v4 composite
pyproject.toml pypi
  • dotmap *
  • fastparquet *
  • graphviz *
  • matplotlib *
  • numpy >=1.21.0, <2
  • opencv-python *
  • pandas >=1.3
  • scikit-learn *
  • scipy *
  • seaborn *