API Reference

This section contains the auto-generated API documentation.

• Main Module
  • Project Class
  • File Class
• Model/Component/Parameter Module
  • Core Classes
  • Architecture
  • Key Features
  • Model
  • Component
  • Par
  • Dynamics
  • Profile
• Energy Functions
  • Function Conventions
  • Implementation Notes
  • Adding New Functions
  • DS()
  • GLP()
  • GLS()
  • Gauss()
  • GaussAsym()
  • LinBack()
  • Lorentz()
  • Offset()
  • Shirley()
  • Voigt()
• Time Functions
  • Function Conventions
  • Parameter Naming
  • Adding New Functions
  • boxCONV()
  • erfFun()
  • expDecayCONV()
  • expFun()
  • expRiseCONV()
  • expSymCONV()
  • gaussCONV()
  • linFun()
  • none()
  • sinDivX()
  • sinFun()
  • sqrtFun()
  • stepFun()
• Profile Functions
  • Function Conventions
  • Parameter Naming
  • Adding New Functions
  • pExpDecay()
  • pGauss()
  • pLinear()
• Simulator Module
  • Key Features
  • Detector Types
  • Workflow
  • Simulator
• Plot Configuration
  • Usage Patterns
  • API Reference
• Fitting Module
  • Key Functions
  • compute_fit_metrics()
  • fit_wrapper()
  • jacobian_fun()
  • jacobian_fun_project()
  • plt_fit_res_1d()
  • plt_fit_res_2d()
  • plt_fit_res_pars()
  • residual_fun()
  • results_to_df()
  • results_to_fit_2d()
  • sigma_dict()
  • sigma_start_stop_percent()
  • time_display()
• Spectra Module
  • Key Concepts
  • Architecture
  • fit_model_compare()
  • fit_model_gir()
  • fit_model_jax()
  • fit_model_mcp()
  • fit_project_jax()
  • fit_project_mcp()
  • pack_project_theta()
• GraphIR and Scheduler
  • ConvKernelKind
  • DomainKind
  • DynFuncKind
  • EdgeKind
  • ExprNodeKind
  • GraphEdge
  • GraphIR
  • GraphNode
  • NodeKind
  • OP_DISPATCH
  • OpKind
  • ParamSourceKind
  • ProfileFuncKind
  • ScheduledPlan1D
  • ScheduledPlan2D
  • SymbolicRPN
  • build_graph()
  • can_lower_1d()
  • can_lower_2d()
  • can_lower_jax_2d()
  • compile_expr_symbolic()
  • schedule_1d()
  • schedule_2d()
• 1D Evaluator
  • evaluate_1d()
• 2D Evaluator
  • eval_expr_program()
  • evaluate_2d()
  • resolve_param_traces()
• JAX Evaluator (experimental)
  • make_evaluator_2d_jax()
  • make_jacobian_2d_jax()
  • make_project_evaluator_2d_jax()
  • make_project_jacobian_2d_jax()