Welcome to Synaptipy’s Documentation

GitHub repository Python 3.10-3.12 Platform: Windows | macOS | Linux License: AGPL-3.0 CI status Docs build Documentation Status Code style: flake8 Code Coverage Collaborators Welcome Release

Synaptipy is a cross-platform electrophysiology visualization and analysis application. The primary experimental focus is whole-cell patch-clamp and intracellular recordings; file I/O is implemented via the Neo library, which supports over 30 acquisition formats including extracellular and multi-channel data.

The software is implemented in Python using the Qt6 framework (PySide6). Signal visualization employs GPU-accelerated rendering via PyQtGraph. The application includes 17 built-in analysis modules spanning intrinsic membrane properties, action potential characterization, synaptic event detection, and evoked responses (Evoked Sync, Paired-Pulse Ratio, Stimulus Train STP). A batch processing engine implements composable analysis pipelines. An extensible plugin interface permits integration of user-written analysis routines without modification to the core package. Three example plugins are distributed with the application. File I/O is handled via Neo, supporting Axon ABF, WinWCP, CED/Spike2, Intan, Igor Pro, NWB, Open Ephys, and additional formats. NWB 2.x export is provided via PyNWB.

The source code is hosted on GitHub.

Tutorial

Walkthrough of Explorer, Analyser, Batch Processing, and Exporter interfaces. Includes mathematical definitions for each analysis module.

Synaptipy User Tutorial and Documentation
User Guide

Installation procedures, supported file formats, and application interface description.

Synaptipy User Guide
API Reference

Public Python API for programmatic use.

Synaptipy API Reference
Developer Guide

Project structure, coding standards, testing, and contribution workflow.

Synaptipy Developer Guide
Algorithmic Definitions

Mathematical definitions for all analysis metrics.

Algorithmic Definitions
NWB Export Mapping

Mapping of electrophysiology data to NWB 2.x containers, including electrode metadata and unit conventions.

NWB Export Mapping
Plugin Development

Reference for custom analysis routines. Includes ui_params, plots, return-dict conventions, and example plugins.

Writing Custom Analysis Plugins for Synaptipy
Scientific References

Full annotated bibliography — all algorithms, methods, and upstream libraries with verified DOIs.

Scientific References
Source on GitHub

Browse the source code, open issues, or submit pull requests on GitHub.

https://github.com/anzalks/synaptipy
Changelog

Release history and notable changes between versions.

https://github.com/anzalks/synaptipy/blob/main/CHANGELOG.md

Indices and Tables