DBS Annotator

Getting Started

  • Installation
    • For end users
    • Windows — SmartScreen warnings
    • Windows — install via PowerShell
    • macOS / Linux — shell install
    • Updating
      • Re-run the same install command
      • Automatic update notification
      • Installer from GitHub Releases
    • Data storage
  • Quick Start
    • Launching the Application
    • Choosing Your Workflow
    • Interface Overview
      • Theme Toggle
    • Next Steps

User Guide

  • Complete Workflow
    • Step 0 — File setup
      • Output filename
    • Step 1 — Initial Configuration
      • Electrode Model
      • Contact Selection
      • Stimulation Parameters
      • Clinical Scales
    • Step 2 — Session Scale Selection
      • Built-in presets
    • Step 3 — Active Recording
      • Adjusting Stimulation Parameters
      • Recording an Entry
      • Session Table
      • Exporting the Report
      • Report Contents
    • Closing the Session
  • Annotations-only Workflow
    • Opening the Annotations-only Workflow
    • Recording an Annotation
    • Output File
    • Exporting a Report
    • Closing
  • Longitudinal Report
    • Opening the Longitudinal View
    • Loading Session Files
      • Drag and Drop
      • Browse Button
      • Managing the File List
    • Generating the Report
      • Step 1 — Scale Optimisation
      • Step 2 — Report Sections
      • Step 3 — Save Location
    • Report Contents
      • Sessions Overview
      • Session Data
      • Electrode Configuration
      • Programming Summary
    • Tips
  • Output Format
    • TSV Data File
      • Filename Convention
      • Columns
      • Programming session TSV columns
      • Annotations-only TSV columns
      • Row layout and block_ID
      • Example rows
    • Word / PDF Reports
      • Single-Session Report
      • Example export
      • Longitudinal Report
      • Example export
    • Timestamps and timezone

Reference

  • Frequently Asked Questions
    • General
    • Files & Data
    • Reports
    • Troubleshooting
    • Contact & Support
  • Changelog
    • [Unreleased]
      • Fixed
    • [0.4.0] - 2026-06-01
      • Changed
      • Fixed
    • [0.4.0b2] - 2026-05-21
      • Added
      • Changed
      • Fixed
    • [0.4.0b1] - 2026-05-08
      • Changed
      • Fixed
    • [0.4.0a2] - 2026-04-22
      • Added
    • [0.4.0a1] - 2026-04-22
      • Added
      • Changed

Developer Guide

  • Contributing to DBS Annotator
    • Getting Started
      • Prerequisites
      • Development Setup
    • Types of Contributions
      • Bug Reports
      • Feature Requests
      • Code Contributions
      • Documentation Improvements
    • Code Standards
      • Style Guidelines
      • Testing
      • GUI Testing
    • Pull Request Process
      • Before Submitting
      • Pull Request Template
      • Review Process
    • Community Guidelines
      • Code of Conduct
      • Communication Channels
      • Recognition
      • Research Impact
    • Development Workflow
      • Branch Strategy
      • Release Process
      • Continuous Integration
    • Specialised Contributions
      • Clinical Domain Experts
      • GUI / UX Contributors
      • Data Scientists
    • Thank You
  • Releasing
    • Version sources
    • Day-to-day: changelog fragments
    • Option A — Prepare the release PR locally
    • Option B — Prepare the release PR from GitHub Actions
    • Publish: tag after merge (deliberate final step)
      • Publish when origin is a fork
    • Troubleshooting
  • API Reference
    • dbs_annotator.config
      • dbs_annotator.config.github_repository_slug
    • dbs_annotator.config_electrode_models
      • dbs_annotator.config_electrode_models.get_all_manufacturers
      • dbs_annotator.config_electrode_models.get_all_model_names
      • dbs_annotator.config_electrode_models.get_model_by_name
      • dbs_annotator.config_electrode_models.get_models_by_manufacturer
      • dbs_annotator.config_electrode_models.ContactState
      • dbs_annotator.config_electrode_models.ElectrodeModel
      • dbs_annotator.config_electrode_models.StimulationRule
    • dbs_annotator.controllers
      • dbs_annotator.controllers.wizard_controller
    • dbs_annotator.logging_config
      • dbs_annotator.logging_config.setup_bootstrap_logging
      • dbs_annotator.logging_config.setup_logging
    • dbs_annotator.models
      • dbs_annotator.models.clinical_scale
      • dbs_annotator.models.electrode_viewer
      • dbs_annotator.models.session_data
      • dbs_annotator.models.stimulation
    • dbs_annotator.utils
      • dbs_annotator.utils.auto_update
      • dbs_annotator.utils.graphics
      • dbs_annotator.utils.longitudinal_exporter
      • dbs_annotator.utils.program_config_manager
      • dbs_annotator.utils.report_chart_utils
      • dbs_annotator.utils.resources
      • dbs_annotator.utils.responsive
      • dbs_annotator.utils.scale_preset_manager
      • dbs_annotator.utils.session_exporter
      • dbs_annotator.utils.theme_manager
      • dbs_annotator.utils.tsv_columns
      • dbs_annotator.utils.updater
      • dbs_annotator.utils.user_data
    • dbs_annotator.version
      • dbs_annotator.version.get_pep440_base_version
      • dbs_annotator.version.get_version
DBS Annotator
  • Overview: module code

All modules for which code is available

  • dbs_annotator.config
  • dbs_annotator.config_electrode_models
  • dbs_annotator.controllers.wizard_controller
  • dbs_annotator.logging_config
  • dbs_annotator.models.clinical_scale
  • dbs_annotator.models.electrode_viewer
  • dbs_annotator.models.session_data
  • dbs_annotator.models.stimulation
  • dbs_annotator.utils.auto_update
  • dbs_annotator.utils.graphics
  • dbs_annotator.utils.longitudinal_exporter
  • dbs_annotator.utils.program_config_manager
  • dbs_annotator.utils.report_chart_utils
  • dbs_annotator.utils.resources
  • dbs_annotator.utils.responsive
  • dbs_annotator.utils.scale_preset_manager
  • dbs_annotator.utils.session_exporter
  • dbs_annotator.utils.theme_manager
  • dbs_annotator.utils.tsv_columns
  • dbs_annotator.utils.updater
  • dbs_annotator.utils.user_data
  • dbs_annotator.version

© Copyright 2025-2026, Massachusetts General Hospital, Wyss Center for Bio and Neuroengineering, and Charité Universitätsmedizin Berlin.

Built with Sphinx using a theme provided by Read the Docs.