Skip to content

iahncajigas/AlphaOmega-Reporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AlphaOmega-Reporter

alphaomega-reporter is the command-line AlphaOmega reporting engine. It takes a case directory as input and generates PDF and HDF5 outputs without requiring the GUI application.

Scope

  • Native AlphaOmega case-directory loading
  • MER and LFP trajectory-centric PDF reports
  • HDF5 export
  • XML target inference
  • Synthetic fixtures and notebook examples
  • Optional spikeinterface integration

This repo is the non-GUI core. The macOS desktop application lives in the separate AlphaOmega-Reporter-App repo and depends on this package.

Install

Base install:

python -m pip install -e .

Developer install:

python -m pip install -e '.[dev]'

Optional extras:

python -m pip install -e '.[mpx]'
python -m pip install -e '.[spikeinterface]'

Quickstart

Build a default report:

ao-report build \
  --case-dir /path/to/case_directory \
  --out report.pdf

Build a high-beta report with extra rendered bands:

ao-report build \
  --case-dir /path/to/case_directory \
  --out report_highbeta.pdf \
  --band highbeta \
  --plot-band alpha \
  --plot-band gamma

Export HDF5:

ao-report export-h5 \
  --case-dir /path/to/case_directory \
  --out session.h5

Development

Validation:

make lint
make test

Examples and sample config are in examples/.

About

Standalone Python toolbox for AlphaOmega MER and LFP depth-to-target reporting

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors