API reference

Auto-generated reference for the meanap package, built from the docstrings in src/meanap/. This covers the parts of the package meant to be scripted against directly:

  • meanap.params — the Params dataclass every pipeline step reads from.

  • meanap.pipeline — the pipeline steps themselves (spike detection, firing rates/bursts, STTC, network metrics, the HTML report generator, …).

  • meanap.network_plot — loading a MEA-NAP output .mat file and rendering network plots (what powers the Network Viewer GUI tab).

  • meanap.catnap — the calcium-imaging (CAT-NAP) scanner, loader, and denoising pipeline.

Note

meanap.gui (the PyQt6 desktop app) is intentionally not included here — its classes are UI widgets, not a scripting API. See the GUI guide for how to use the GUI itself.

meanap.params

Pipeline parameter definitions, mirroring the MATLAB Params struct.

meanap.network_plot

MEA network plotting: Python port of StandardisedNetworkPlot.m.

meanap.pipeline

MEA-NAP Python pipeline — spike detection and analysis steps.

meanap.catnap

CAT-NAP: Calcium Transient Network Analysis Pipeline (suite2p data).