ESIBD Explorer Logo

Contents:

  • 1. Installation
    • 1.1. Standalone Windows installer
    • 1.2. From PyPi
    • 1.3. From source (Miniconda)
    • 1.4. From source (other)
  • 2. Electrospray ion-beam deposition
  • 3. User’s Guide
    • 3.1. Getting started
    • 3.2. User interface overview
    • 3.3. Configuration and management
      • 3.3.1. Settings
        • 3.3.1.1. General settings
        • 3.3.1.2. Session settings
        • 3.3.1.3. Acquisition settings
        • 3.3.1.4. Other settings
      • 3.3.2. Explorer
      • 3.3.3. Devices
        • 3.3.3.1. Device settings
      • 3.3.4. Channels
      • 3.3.5. Scans
        • 3.3.5.1. Scan settings
      • 3.3.6. Genetic algorithm (GA)
      • 3.3.7. Omni scan
      • 3.3.8. Custom extensions
      • 3.3.9. Custom device extensions
    • 3.4. Displays
      • 3.4.1. Browser
      • 3.4.2. Notes
      • 3.4.3. Text
      • 3.4.4. Tree
      • 3.4.5. MS
      • 3.4.6. Line
      • 3.4.7. PDB
      • 3.4.8. Holo
    • 3.5. Live displays
    • 3.6. Device manager
    • 3.7. Console
    • 3.8. ESIBD specific plugins
      • 3.8.1. ISEG
      • 3.8.2. RBD
      • 3.8.3. Pressure
      • 3.8.4. Temperature
      • 3.8.5. Beam
      • 3.8.6. Energy
      • 3.8.7. Depo
  • 4. Plugin development
    • 4.1. Plugin
    • 4.2. PluginManager
    • 4.3. Devices
    • 4.4. Channels
    • 4.5. Scan
    • 4.6. DeviceController
  • 5. Library Reference
    • 5.1. The plugin module
      • Device
        • Device.SignalCommunicate
        • Device.addChannel()
        • Device.appendOutputData()
        • Device.apply()
        • Device.channelType
        • Device.channels
        • Device.close()
        • Device.convertDataDisplay()
        • Device.documentation
        • Device.exportConfiguration()
        • Device.getChannelByName()
        • Device.getDefaultSettings()
        • Device.getSelectedChannel()
        • Device.getUnit()
        • Device.init()
        • Device.initialized()
        • Device.inout
        • Device.intervalChanged()
        • Device.liveDisplay
        • Device.loadConfiguration()
        • Device.loadValues()
        • Device.name
        • Device.plot()
        • Device.pluginType
        • Device.restoreOutputData()
        • Device.runDataThread()
        • Device.setBackground()
        • Device.startAcquisition()
        • Device.staticDisplay
        • Device.stop()
        • Device.stopAcquisition()
        • Device.supportsFile()
        • Device.toggleRecording()
        • Device.unit
        • Device.updateChannelConfig()
        • Device.updateValues()
        • Device.useBackgrounds
        • Device.version
      • DeviceManager
        • DeviceManager.SignalCommunicate
        • DeviceManager.documentation
        • DeviceManager.getChannelByName()
        • DeviceManager.name
        • DeviceManager.optional
        • DeviceManager.pluginType
        • DeviceManager.previewFileTypes
        • DeviceManager.store()
        • DeviceManager.toggleRecording()
        • DeviceManager.version
      • LiveDisplay
        • LiveDisplay.copyClipboard()
        • LiveDisplay.documentation
        • LiveDisplay.plot()
        • LiveDisplay.pluginType
      • Plugin
        • Plugin.about()
        • Plugin.addAction()
        • Plugin.addContentLayout()
        • Plugin.addContentWidget()
        • Plugin.addRightAxis()
        • Plugin.addStateAction()
        • Plugin.axes
        • Plugin.canvas
        • Plugin.close()
        • Plugin.closeGUI()
        • Plugin.closeUserGUI()
        • Plugin.copyClipboard()
        • Plugin.dependencyPath
        • Plugin.dock
        • Plugin.documentation
        • Plugin.fig
        • Plugin.finalizeInit()
        • Plugin.getDefaultSettings()
        • Plugin.getIcon()
        • Plugin.initDock()
        • Plugin.initFig()
        • Plugin.initGUI()
        • Plugin.initializedDock
        • Plugin.initializedGUI
        • Plugin.labelPlot()
        • Plugin.loadData()
        • Plugin.loading
        • Plugin.makeCoreIcon()
        • Plugin.makeFigureCanvasWithToolbar()
        • Plugin.makeIcon()
        • Plugin.name
        • Plugin.navToolBar
        • Plugin.optional
        • Plugin.plot()
        • Plugin.pluginManager
        • Plugin.pluginType
        • Plugin.previewFileTypes
        • Plugin.print()
        • Plugin.provideDock()
        • Plugin.raiseDock()
        • Plugin.requireGroup()
        • Plugin.requiredPlugin()
        • Plugin.runTestParallel()
        • Plugin.setLabelMargin()
        • Plugin.supportedVersion
        • Plugin.supportsFile()
        • Plugin.test()
        • Plugin.testControl()
        • Plugin.titleBar
        • Plugin.titleBarLabel
        • Plugin.toggleTitleBar()
        • Plugin.updateTheme()
        • Plugin.version
      • Scan
        • Scan.SignalCommunicate
        • Scan.addInputChannel()
        • Scan.display
        • Scan.documentation
        • Scan.estimateScanTime()
        • Scan.file
        • Scan.finished
        • Scan.generatePythonPlotCode()
        • Scan.getChannelByName
        • Scan.getData()
        • Scan.getOutputIndex()
        • Scan.getSteps()
        • Scan.initScan()
        • Scan.inputs
        • Scan.loadDataInternal()
        • Scan.measurementsPerStep
        • Scan.outputs
        • Scan.plot()
        • Scan.pythonPlotCode()
        • Scan.recording
        • Scan.run()
        • Scan.runThread
        • Scan.saveData()
        • Scan.saveScanParallel()
        • Scan.toggleRecording()
        • Scan.useDisplayChannel
      • SettingsManager
        • SettingsManager.initSettingsContextMenuBase()
        • SettingsManager.loadSettings()
        • SettingsManager.pluginType
        • SettingsManager.saveSettings()
        • SettingsManager.updateSettings()
        • SettingsManager.version
      • StaticDisplay
        • StaticDisplay.copyClipboard()
        • StaticDisplay.loadDataInternal()
        • StaticDisplay.plot()
        • StaticDisplay.pluginType
      • providePlugins()
    • 5.2. The core module
      • Action
        • Action.SignalCommunicate
      • BetterDockWidget
        • BetterDockWidget.SignalCommunicate
        • BetterDockWidget.toggleTitleBar()
      • BetterIcon
      • BetterPlotWidget
      • Channel
        • Channel.SignalCommunicate
        • Channel.asDict()
        • Channel.backgrounds
        • Channel.device
        • Channel.displayedParameters
        • Channel.enabledChanged()
        • Channel.getDefaultChannel()
        • Channel.getSortedDefaultChannel()
        • Channel.getValues()
        • Channel.initGUI()
        • Channel.inout
        • Channel.insertDisplayedParameter()
        • Channel.lastAppliedValue
        • Channel.parameters
        • Channel.plotCurve
        • Channel.print
        • Channel.setDisplayedParameters()
        • Channel.tempParameters()
        • Channel.tree
        • Channel.updateColor()
        • Channel.values
      • CheckBox
        • CheckBox.SignalCommunicate
      • CloseDialog
      • CompactComboBox
      • ControlCursor
        • ControlCursor.setPosition()
      • DeviceController
        • DeviceController.SignalCommunicate
        • DeviceController.acquiring
        • DeviceController.acquisitionThread
        • DeviceController.close()
        • DeviceController.init()
        • DeviceController.initComplete()
        • DeviceController.initThread
        • DeviceController.initialized
        • DeviceController.initializing
        • DeviceController.lock
        • DeviceController.parent
        • DeviceController.port
        • DeviceController.print
        • DeviceController.runAcquisition()
        • DeviceController.runInitialization()
        • DeviceController.serialRead()
        • DeviceController.serialWrite()
        • DeviceController.startAcquisition()
        • DeviceController.stop()
        • DeviceController.stopAcquisition()
        • DeviceController.updateValue()
      • DynamicNp
        • DynamicNp.add()
        • DynamicNp.get()
      • EsibdExplorer
        • EsibdExplorer.closeEvent()
        • EsibdExplorer.loadPlugins()
        • EsibdExplorer.restoreUiState()
        • EsibdExplorer.saveUiState()
        • EsibdExplorer.toggleFullscreen()
      • LedIndicator
      • Logger
        • Logger.close()
        • Logger.flush()
        • Logger.open()
        • Logger.openLog()
        • Logger.print()
        • Logger.printFromThreadSignal
        • Logger.write()
      • MZCaculator
        • MZCaculator.determine_mass_to_charge()
      • MetaChannel
      • NumberBar
      • Parameter
        • Parameter.TYPE
        • Parameter.advanced
        • Parameter.applyWidget()
        • Parameter.attr
        • Parameter.equals()
        • Parameter.event
        • Parameter.extendedEvent
        • Parameter.fullName
        • Parameter.header
        • Parameter.indicator
        • Parameter.instantUpdate
        • Parameter.internal
        • Parameter.itemWidget
        • Parameter.items
        • Parameter.max
        • Parameter.min
        • Parameter.name
        • Parameter.print
        • Parameter.toolTip
        • Parameter.tree
        • Parameter.validateComboInput()
        • Parameter.value
        • Parameter.widget
        • Parameter.widgetType
      • PluginManager
        • PluginManager.SignalCommunicate
        • PluginManager.TYPE
        • PluginManager.addPluginTreeWidgetItem()
        • PluginManager.closePlugins()
        • PluginManager.finalizeInit()
        • PluginManager.finalizeUiState()
        • PluginManager.getMainPlugins()
        • PluginManager.getPluginsByType()
        • PluginManager.loadPlugin()
        • PluginManager.loadPlugins()
        • PluginManager.loadPluginsFromModule()
        • PluginManager.loading
        • PluginManager.managePlugins()
        • PluginManager.plugins
        • PluginManager.provideDocks()
        • PluginManager.resetMainDisplayWidgetLimits()
        • PluginManager.runTestParallel()
        • PluginManager.test()
        • PluginManager.updateTheme()
      • QLabviewDoubleSpinBox
        • QLabviewDoubleSpinBox.stepBy()
      • QLabviewSciSpinBox
        • QLabviewSciSpinBox.FloatValidator
        • QLabviewSciSpinBox.stepBy()
      • QLabviewSpinBox
        • QLabviewSpinBox.stepBy()
      • RestoreFloatComboBox
      • SciAxisItem
      • Setting
        • Setting.resetWidget()
        • Setting.setWidget()
        • Setting.settingEvent()
      • SplashScreen
      • StateAction
      • TextEdit
      • ThemedConsole
        • ThemedConsole.setStack()
        • ThemedConsole.write()
      • ThemedNavigationToolbar
        • ThemedNavigationToolbar.updateNavToolbarTheme()
      • TimeoutLock
      • ToolButton
        • ToolButton.SignalCommunicate
      • parameterDict()
    • 5.3. Constants
      • Colors
      • INOUT
        • INOUT.BOTH
        • INOUT.IN
        • INOUT.OUT
      • PRINT
        • PRINT.DEBUG
        • PRINT.ERROR
        • PRINT.MESSAGE
        • PRINT.WARNING
      • getClipboardTheme()
      • getDPI()
      • getDarkMode()
      • getShowDebug()
      • getTestMode()
      • makeSettingWrapper()
      • makeStateWrapper()
      • makeWrapper()
  • 6. Acknowledgments
  • 7. References
ESIBD Explorer
  • Search


© Copyright 2023, Tim Esser.

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