PhysPlot Logo

Contents

  • Installation
  • PhysPlot GUI Walkthrough
  • Video Tutorials
  • Sequence Walkthrough: Record, Save, Reuse and Bulk-Run
  • UI Reference
  • Data Entry
  • Data Import
  • Data Manipulation
  • Protocol Sequences
  • Plot Generation
  • Curve Fitting
  • Plot Customization
  • Data Export

Build Modules with AI

  • Build Modules with an AI Assistant
  • AI Module Examples

Extend and Reference

  • Extension Guides
  • API Reference
    • Application API
    • GUI API (physplot_gui)
    • Utilities API
    • Function Plugin API
    • Curve-Fitting Plugin API
    • File Loader API
    • Configuration API
  • Class Reference
  • PhysPlot Project Guide
PhysPlot
  • API Reference
  • View page source

API Reference

These pages document the Python modules that make up PhysPlot and its extension plugin interfaces. PhysPlot is primarily a desktop GUI application, but these references are useful for contributors and for users writing new loaders, functions, or curve-fitting models.

  • Application API
    • Main Application Module
    • Package Entry Points
  • GUI API (physplot_gui)
    • Package and entry point
    • Application
    • Panels
    • Widgets
    • Templates, fit styles and theme
  • Utilities API
    • Utility Helpers
    • Constants
  • Function Plugin API
    • Required Module Variables
    • Required Function
    • Plugin Files Included with PhysPlot
    • Implementation Notes
    • Transformation Resolution
  • Curve-Fitting Plugin API
    • Required Module Variables
    • Polynomial Fit Variables
    • Callable Fit Function
    • Included Fit Plugins
    • Implementation Notes
  • File Loader API
    • Package Contract
    • Built-In Backend Loaders
    • Loader Base Classes
    • XRDML Loader
    • Instrument Text Tables
    • Loader Plugins
  • Configuration API
    • Configuration Package
    • Legacy Curve-Fit Configuration
Previous Next

© Copyright .

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