Contents Menu Expand Light mode Dark mode Auto light/dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
NaviNIBS documentation
Logo
NaviNIBS documentation

Usage

  • Feature comparison
  • Workflow
  • Setup
    • Installation
    • NDI tracking setup
    • OptiTrack tracking setup
    • Development
  • Core features
    • Session Management
    • Tool configuration
    • MRI
    • Head model
    • Target planning
    • Subject registration
    • Coil calibration
    • Basic navigation
    • Triggering configuration
    • Electrode digitization
  • Addons
    • Simulated tools
    • Cobot control
    • LSL Output
  • Data model
  • Troubleshooting
  • Citing NaviNIBS

Development

  • Code
    • NaviNIBS package
      • NaviNIBS.Devices package
        • NaviNIBS.Devices.IGTLinkToolPositionsServer module
        • NaviNIBS.Devices.ToolPositionsClient module
        • NaviNIBS.Devices.ToolPositionsServer module
      • NaviNIBS.Navigator package
        • NaviNIBS.Navigator.GUI package
          • NaviNIBS.Navigator.GUI.CollectionModels package
            • NaviNIBS.Navigator.GUI.CollectionModels.DigitizedLocationsTableModel module
            • NaviNIBS.Navigator.GUI.CollectionModels.FiducialsTableModels module
            • NaviNIBS.Navigator.GUI.CollectionModels.HeadPointsTableModel module
            • NaviNIBS.Navigator.GUI.CollectionModels.HotkeysTableModel module
            • NaviNIBS.Navigator.GUI.CollectionModels.SamplesTableModel module
            • NaviNIBS.Navigator.GUI.CollectionModels.TargetsTableModel module
            • NaviNIBS.Navigator.GUI.CollectionModels.ToolsTableModel module
          • NaviNIBS.Navigator.GUI.EditWindows package
            • NaviNIBS.Navigator.GUI.EditWindows.CoilCalibrationWindow module
            • NaviNIBS.Navigator.GUI.EditWindows.ImportSessionWindow module
            • NaviNIBS.Navigator.GUI.EditWindows.PointerCalibrationWindow module
            • NaviNIBS.Navigator.GUI.EditWindows.ToolCalibrationWindow module
          • NaviNIBS.Navigator.GUI.ViewPanels package
            • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel package
              • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers package
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.MeshSurfaceLayer module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.OrientationsLayers module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.PlotLayersGroup module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.SampleMetadataOrientationsLayer module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.TargetingAngleErrorLayer module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.TargetingCrosshairsLayer module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.TargetingErrorLineLayer module
                • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.TargetingPointLayer module
              • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.NavigatePanel module
              • NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.NavigationView module
            • NaviNIBS.Navigator.GUI.ViewPanels.TriggerSettingsPanel package
              • NaviNIBS.Navigator.GUI.ViewPanels.TriggerSettingsPanel.HotkeyTriggerSourceSettingsWidget module
              • NaviNIBS.Navigator.GUI.ViewPanels.TriggerSettingsPanel.LSLTriggerSourceSettingsWidget module
              • NaviNIBS.Navigator.GUI.ViewPanels.TriggerSettingsPanel.TriggerSourceSettingsWidget module
            • NaviNIBS.Navigator.GUI.ViewPanels.CameraPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.CoordinateSystemsPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.DigitizeLocationsPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.FiducialsPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.HeadModelPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.MRIPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.MainViewPanelWithDockWidgets module
            • NaviNIBS.Navigator.GUI.ViewPanels.ManageSessionPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.SubjectRegistrationPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.TargetsPanel module
            • NaviNIBS.Navigator.GUI.ViewPanels.ToolsPanel module
          • NaviNIBS.Navigator.GUI.Widgets package
            • NaviNIBS.Navigator.GUI.Widgets.CollectionTableWidget module
            • NaviNIBS.Navigator.GUI.Widgets.EditGridWidget module
            • NaviNIBS.Navigator.GUI.Widgets.EditTargetWidget module
            • NaviNIBS.Navigator.GUI.Widgets.MRIViews module
            • NaviNIBS.Navigator.GUI.Widgets.SurfViews module
            • NaviNIBS.Navigator.GUI.Widgets.TrackingStatusWidget module
          • NaviNIBS.Navigator.GUI.NavigatorGUI module
        • NaviNIBS.Navigator.Model package
          • NaviNIBS.Navigator.Model.Addons module
          • NaviNIBS.Navigator.Model.Calculations module
          • NaviNIBS.Navigator.Model.CoordinateSystems module
          • NaviNIBS.Navigator.Model.DigitizedLocations module
          • NaviNIBS.Navigator.Model.DockWidgetLayouts module
          • NaviNIBS.Navigator.Model.GenericCollection module
          • NaviNIBS.Navigator.Model.HeadModel module
          • NaviNIBS.Navigator.Model.MRI module
          • NaviNIBS.Navigator.Model.MiscSettings module
          • NaviNIBS.Navigator.Model.Samples module
          • NaviNIBS.Navigator.Model.Session module
          • NaviNIBS.Navigator.Model.SubjectRegistration module
          • NaviNIBS.Navigator.Model.Targets module
          • NaviNIBS.Navigator.Model.Tools module
          • NaviNIBS.Navigator.Model.Triggering module
        • NaviNIBS.Navigator.TargetingCoordinator module
      • NaviNIBS.util package
        • NaviNIBS.util.GUI package
          • NaviNIBS.util.GUI.Dock module
          • NaviNIBS.util.GUI.ErrorDialog module
          • NaviNIBS.util.GUI.IconWidget module
          • NaviNIBS.util.GUI.Icons module
          • NaviNIBS.util.GUI.QAppWithAsyncioLoop module
          • NaviNIBS.util.GUI.QCollapsibleSection module
          • NaviNIBS.util.GUI.QDial module
          • NaviNIBS.util.GUI.QFileSelectWidget module
          • NaviNIBS.util.GUI.QFlowLayout module
          • NaviNIBS.util.GUI.QLineEdit module
          • NaviNIBS.util.GUI.QMouseWheelAdjustmentGuard module
          • NaviNIBS.util.GUI.QScrollContainer module
          • NaviNIBS.util.GUI.QTableWidgetDragRows module
          • NaviNIBS.util.GUI.QValidators module
          • NaviNIBS.util.GUI.QWidgetWithCloseSignal module
          • NaviNIBS.util.GUI.QueuedRedrawMixin module
          • NaviNIBS.util.GUI.StyleSheets module
        • NaviNIBS.util.lsl package
          • NaviNIBS.util.lsl.LSLStreamResolver module
          • NaviNIBS.util.lsl.LSLStreamSelector module
        • NaviNIBS.util.pyvista package
          • NaviNIBS.util.pyvista.RemotePlotting package
            • NaviNIBS.util.pyvista.RemotePlotting.RemoteLayeredPlotter module
            • NaviNIBS.util.pyvista.RemotePlotting.RemoteLayeredPlotterProxies module
            • NaviNIBS.util.pyvista.RemotePlotting.RemotePlotter module
            • NaviNIBS.util.pyvista.RemotePlotting.RemotePlotterProxy module
          • NaviNIBS.util.pyvista.PlotInteraction module
          • NaviNIBS.util.pyvista.dataset module
          • NaviNIBS.util.pyvista.plotting module
          • NaviNIBS.util.pyvista.ticks module
        • NaviNIBS.util.AsyncRunner module
        • NaviNIBS.util.Asyncio module
        • NaviNIBS.util.CoilOrientations module
        • NaviNIBS.util.Transforms module
        • NaviNIBS.util.ZMQAsyncioFix module
        • NaviNIBS.util.ZMQConnector module
        • NaviNIBS.util.attrs module
        • NaviNIBS.util.json module
        • NaviNIBS.util.logging module
        • NaviNIBS.util.numpy module
        • NaviNIBS.util.test_attrs module
  • Changelog

Links

  • Github
  • Precision Neurotherapeutics Lab
Back to top
View this page

SetupΒΆ

  • Installation
    • Install Python
    • Install core NaviNIBS
    • Install NaviNIBS addons
    • Install other dependencies
  • NDI tracking setup
    • Installation
      • Plus Toolkit installation
    • Configuration
      • Plus Server device set specification
    • Usage
  • OptiTrack tracking setup
    • Installation
      • Motive installation
      • Plus Toolkit installation
    • Configuration
      • Motive configuration
      • Plus Server device set specification
    • Usage
  • Development
    • Install Poetry
    • Clone core repo
    • Install dependencies
    • Testing setup
Next
Installation
Previous
Workflow
Copyright © 2025, Christopher Cline
Made with Sphinx and @pradyunsg's Furo