Skip to content

index.rst

Latest commit

 

History

History
35 lines (29 loc) · 1.28 KB

index.rst

File metadata and controls

35 lines (29 loc) · 1.28 KB
Raw

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.remote — reading raw data that isn't on this machine: the store protocol, the bounded fetch cache, and the pre-flight check.
  • meanap.viewer — the local web viewer that redraws figures from a bundle.
  • 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 :doc:`../gui-guide` for how to use the GUI itself.

.. autosummary::
   :toctree: generated
   :recursive:
   :caption: Package reference

   meanap.params
   meanap.network_plot
   meanap.pipeline
   meanap.catnap
   meanap.remote
   meanap.viewer