microsync 2.6.3__tar.gz

microsync-2.6.3/MANIFEST.in

@@ -0,0 +1,23 @@
+# Include Python source files
+include *.py
+
+# Include Jupyter notebook
+include *.ipynb
+
+# Exclude build artifacts
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude *.pyd
+global-exclude __pycache__
+global-exclude .git*
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.dll
+global-exclude *.dylib
+global-exclude *.exe
+global-exclude build/
+global-exclude dist/
+global-exclude *.egg-info/
+
+global-exclude .coverage
+global-exclude htmlcov/ 

microsync-2.6.3/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: microsync
+Version: 2.6.3
+Summary: Python driver for 32-bit microscope synchronization device.
+Author-email: Roman Kiselev <roman.kiselev@stjude.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/stjude-smc/microsync
+Project-URL: Repository, https://github.com/stjude-smc/microsync
+Project-URL: Documentation, https://stjude-smc.github.io/microsync/
+Project-URL: Bug Tracker, https://github.com/stjude-smc/microsync/issues
+Keywords: microscope,synchronization,device,arduino,sam3x,serial,timing,laser,camera,ptirf
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: pyserial>=3.0
+Requires-Dist: bokeh>=3.0.0
+Requires-Dist: selenium>=4.0.0
+Requires-Dist: webdriver-manager>=4.0.0
+Provides-Extra: dev
+Requires-Dist: jupyter>=1.0; extra == "dev"
+Requires-Dist: sphinx>=4.0; extra == "dev"
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == "dev"
+
+# `microsync` — Python driver for microscope synchronization device
+
+**Python driver for `microsync` — a universal 32-bit Arduino Due-based triggering device**. Control lasers, cameras, and timing with microsecond precision.
+
+- **Full documentation:** [stjude-smc.github.io/microsync](https://stjude-smc.github.io/microsync/)
+- **Repository:** [github.com/stjude-smc/microsync](https://github.com/stjude-smc/microsync)
+
+## Install
+
+Requires Python 3.7+ and `pyserial` (installed automatically):
+
+```bash
+pip install microsync
+```
+
+## Quick start
+
+Upload the microsync firmware to an Arduino Due, then:
+
+```python
+from microsync import SyncDevice
+
+sd = SyncDevice("COM4")   # or "/dev/ttyUSB0" on Linux
+sd.pos_pulse("D8", 1000, ts=1000)   # 1 ms pulse on D8 after 1 ms delay
+sd.go()
+```
+
+## Features
+
+- Microsecond-precision event scheduling (pulses, toggles, camera triggers)
+- Laser shutter and interlock safety logic
+- Acquisition modes: continuous, stroboscopic, ALEX
+- Interactive event visualization (Bokeh)
+- Context manager for jitter-free batch commands
+

microsync-2.6.3/README.md

@@ -0,0 +1,35 @@
+# `microsync` — Python driver for microscope synchronization device
+
+**Python driver for `microsync` — a universal 32-bit Arduino Due-based triggering device**. Control lasers, cameras, and timing with microsecond precision.
+
+- **Full documentation:** [stjude-smc.github.io/microsync](https://stjude-smc.github.io/microsync/)
+- **Repository:** [github.com/stjude-smc/microsync](https://github.com/stjude-smc/microsync)
+
+## Install
+
+Requires Python 3.7+ and `pyserial` (installed automatically):
+
+```bash
+pip install microsync
+```
+
+## Quick start
+
+Upload the microsync firmware to an Arduino Due, then:
+
+```python
+from microsync import SyncDevice
+
+sd = SyncDevice("COM4")   # or "/dev/ttyUSB0" on Linux
+sd.pos_pulse("D8", 1000, ts=1000)   # 1 ms pulse on D8 after 1 ms delay
+sd.go()
+```
+
+## Features
+
+- Microsecond-precision event scheduling (pulses, toggles, camera triggers)
+- Laser shutter and interlock safety logic
+- Acquisition modes: continuous, stroboscopic, ALEX
+- Interactive event visualization (Bokeh)
+- Context manager for jitter-free batch commands
+

microsync-2.6.3/install.py

@@ -0,0 +1,104 @@
+#!/usr/bin/env python3
+"""
+Simple installation script for microsync package.
+
+This script provides an easy way to install the microsync package
+either in development mode or as a regular installation.
+
+Usage:
+    python install.py [--dev] [--user]
+
+Options:
+    --dev    Install in development mode (editable install)
+    --user   Install for current user only
+"""
+
+import sys
+import subprocess
+import argparse
+from pathlib import Path
+
+
+def run_command(cmd, description):
+    """Run a command and handle errors."""
+    print(f"Running: {description}")
+    print(f"Command: {' '.join(cmd)}")
+    
+    try:
+        result = subprocess.run(cmd, check=True, capture_output=True, text=True)
+        print("✓ Success!")
+        if result.stdout:
+            print(result.stdout)
+        return True
+    except subprocess.CalledProcessError as e:
+        print(f"✗ Error: {e}")
+        if e.stdout:
+            print("STDOUT:", e.stdout)
+        if e.stderr:
+            print("STDERR:", e.stderr)
+        return False
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Install microsync package",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+    python install.py              # Install normally
+    python install.py --dev        # Install in development mode
+    python install.py --user       # Install for current user only
+    python install.py --dev --user # Install in dev mode for current user
+        """
+    )
+    
+    parser.add_argument(
+        '--dev', 
+        action='store_true',
+        help='Install in development mode (editable install)'
+    )
+    
+    parser.add_argument(
+        '--user',
+        action='store_true', 
+        help='Install for current user only'
+    )
+    
+    args = parser.parse_args()
+    
+    # Check if we're in the right directory
+    if not Path('pyproject.toml').exists():
+        print("Error: pyproject.toml not found. Please run this script from the python/ directory.")
+        sys.exit(1)
+    
+    # Build the pip install command
+    cmd = [sys.executable, '-m', 'pip', 'install']
+    
+    if args.dev:
+        cmd.append('-e')
+        cmd.append('.[dev]')  # Include development dependencies
+    else:
+        cmd.append('.')
+    
+    if args.user:
+        cmd.append('--user')
+    
+    # Run the installation
+    success = run_command(cmd, "Installing microsync package")
+    
+    if success:
+        print("\n🎉 Installation completed successfully!")
+        print("\nYou can now use the package:")
+        print("  import microsync")
+        print("  device = microsync.SyncDevice('COM3')  # or '/dev/ttyUSB0' on Linux")
+        
+        if args.dev:
+            print("\nNote: This is a development installation.")
+            print("Changes to the source code will be immediately available.")
+    else:
+        print("\n❌ Installation failed!")
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()