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 Collaborators Welcome Release

Synaptipy is a cross-platform, open-source electrophysiology visualisation and analysis suite. The primary focus is whole-cell patch-clamp and intracellular recordings; however, any electrophysiology signal whose file format is supported by the Neo I/O library can be loaded, visualised, and processed - including extracellular and multi-channel recordings.

Built on Python and Qt6, Synaptipy provides OpenGL-accelerated signal visualisation, 17 built-in analysis modules spanning intrinsic membrane properties, action potential characterisation, synaptic event detection, and evoked responses (Evoked Sync, Paired-Pulse Ratio, Stimulus Train STP), a composable batch processing engine, and an extensible plugin interface that allows custom analysis routines to be integrated without modifying the core package. Three example plugins ship with the application and are loadable via a single checkbox in Preferences. File I/O is handled through Neo, supporting over 30 acquisition formats including Axon ABF, WinWCP, CED/Spike2, Intan, Igor Pro, NWB, Open Ephys, and more. NWB export is provided via PyNWB.

The source code is hosted on GitHub. Collaborations, bug reports, and pull requests are welcome.

Quick-start Tutorial

A full walkthrough of every feature - Explorer, Analyser, Batch Processing, and Exporter - with the maths behind each analysis module.

Synaptipy User Tutorial and Documentation
User Guide

Installation, supported file formats, and a detailed walkthrough of all three application tabs.

Synaptipy User Guide
API Reference

Public Python API for using Synaptipy as a library in your own scripts.

Synaptipy API Reference
Developer Guide

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

Synaptipy Developer Guide
Algorithmic Definitions

Formal mathematical definitions for every analysis metric - suitable for citation in manuscripts and peer review.

Algorithmic Definitions
NWB Export Mapping

How Synaptipy maps electrophysiology data to NWB 2.x containers, including electrode metadata and unit conventions.

NWB Export Mapping
Writing Plugins

Add custom analysis routines without modifying source code - complete reference for ui_params, plots, return-dict conventions, and three bundled example plugins.

Writing Custom Analysis Plugins for Synaptipy
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