Frankford

Frankford is a Python library to use the CUDA system to fit multiple datasets simultaneously using the Levenberg-Marquardt algorithm.

Note

This is a beta release that has not been completely tested.

Contents

• Introduction
  • Installation
  • Copyright
  • License
  • Name
  • Contact
• Overview
  • Summary
  • Fitter Class
    • Fitter
      • Fitter.__init__()
      • Fitter.__call__()
      • Fitter.ftol
      • Fitter.xtol
      • Fitter.gtol
      • Fitter.stepfactor
      • Fitter.covtol
      • Fitter.maxiter
      • Fitter.douserscale
      • Fitter.parameters
      • Fitter.models
• Basic Example
  • Import
  • Prepare Data
  • Build Fitter
    • Parameters
    • Define Model
    • Create Fitter
  • Execute Fitter
    • Initialize Parameters
    • Dataset Settings
    • Run the Fitter
  • Fit Data
    • Inspect Results
    • Plot the Data
• Datasets
  • Dataset
    • Dataset.__init__()
• Parameters
  • Free Parameters
    • FreeParameter
      • FreeParameter.__init__()
    • FreeParameterSetting
      • FreeParameterSetting.__init__()
      • FreeParameterSetting.init_values
      • FreeParameterSetting.lower
      • FreeParameterSetting.upper
      • FreeParameterSetting.step
      • FreeParameterSetting.relative_step
      • FreeParameterSetting.side
    • Side
      • Side.AUTO
      • Side.POS
      • Side.NEG
      • Side.BOTH
  • Fixed Parameters
    • FixedParameter
      • FixedParameter.__init__()
    • FixedParameterSetting
      • FixedParameterSetting.__init__()
  • Tied Parameters
    • TiedParameter
      • TiedParameter.__init__()
      • TiedParameter.args
      • TiedParameter.function
• Fit Data
  • Result
    • Result
      • Result.ERR_UNKNOWN
      • Result.ERR_DOF
      • Result.ERR_USER_FUNC
      • Result.OK_CHI_SQ
      • Result.OK_PAR
      • Result.OK_BOTH
      • Result.OK_DIR
      • Result.MAX_ITER
      • Result.FTOL
      • Result.XTOL
      • Result.GTOL
      • Result.__bool__()
  • Final \(\chi^2\)
  • Degrees of Freedom
  • Number of Iterations
  • Original \(\chi^2\)
  • Parameters
  • Uncertainties
  • Covariance Matrix