Skip to main content

TotalSync

PyPI Python versions Documentation License: GPL v3+

TotalSync is a low-cost, open-source teensy-based synchronization system for multiple recording techniques.

uv tool install totalsync

Read the documentation →

Getting started

Command reference

  • totalsync — record a session and serve the live browser interface
  • totalsync-decode — decode recorded .b64 files into numpy, MATLAB or pynapple formats, with named channels
  • totalsync-pinsheet — generate the pinSheet.json channel map from the Teensy firmware source
  • totalsync-pinout — draw that channel map onto a labelled picture of the Teensy, to check a wiring job at the bench
  • totalsync-firmware — copy the Teensy firmware out to a PlatformIO project of your own
  • totalsync-2p — align ScanImage two-photon recordings with TotalSync telemetry

Recording techniques

Chapters for two-photon microscopy, electrophysiology / Neuropixel and virtual reality are planned; their placeholder files under docs/ are not part of the site yet.

Repository layout

This is a uv workspace of four distributions. pip install totalsync gets all of them; each is also installable on its own, so a machine that only analyses recordings need not pull in the serial and GUI dependencies.

Path Distribution Provides
packages/totalsync_webinterface totalsync-webinterface totalsync — acquisition, recording and the live browser interface
packages/totalsync_utils totalsync-utils totalsync-decode, totalsync-pinsheet, totalsync-pinout, totalsync-firmware
packages/totalsync_2p totalsync-2p totalsync-2p
. totalsync umbrella that depends on the three above

firmware/ holds the Teensy firmware as a PlatformIO project, and docs/ the documentation above.

Contribute

Please contact Morgane Audrain (morgane.audrain@donders.ru.nl) with questions or concerns.

Metadata

Release files for totalsync 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for totalsync 0.3.0
File Size Uploaded
totalsync-0.3.0.tar.gz 17.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for totalsync 0.3.0
File Interpreter ABI Platform
totalsync-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 32.4 kB

Release files / totalsync-0.3.0.tar.gz

Download URL totalsync-0.3.0.tar.gz
Size 17.3 kB
Tags Source
SHA-256 checksum
How to use checksums
94e5597a8cc873bcea0afd64dc1063a1443caf821bafc2ae86c2f8ead76ece4c
BLAKE2b-256 checksum
How to use checksums
7bb2286af9f09069e690170544f50359302b32accb27523392ca484547d3dcd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / totalsync-0.3.0-py3-none-any.whl

Download URL totalsync-0.3.0-py3-none-any.whl
Size 15.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c9c489c1a8fd040092d5d26be106b301ab84eded5f362cff01b40b9f9647a4f3
BLAKE2b-256 checksum
How to use checksums
0d6a76b9093bb5a683cc151a85ea1ce98258b730deeb984b1fc9206eba7c47d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

0.5.0

2 release files

0.4.0

2 release files

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page