🔎 Overview

Welcome to IDDEFIX documentation

IDDEFIX: Impedance Determination through Differential Evolution FItting and eXtrapolation

IDDEFIX is a package for fitting resonators by a Differential Evolution algorithm to Impedance data developed by Sébastian Joly. It computes the shunt impedance, Q-factor and resonant frequecny of the resonators present in the impedance data for both partially and fully decayed wakes. Extrapolation to a desired wakelength is then possible to quickly reconstruct the fully decayed wake.

🚀 IDDEFIX features:

• Resonators formulas

  • Longitudinal and transverse impedance (Fully/ partially decayed)

  • Longitudinal and transverse wake

  • Longitudinal and transverse wake potentials

• Differential Evolution algorihm for fitting resonsators to impedance

  • SciPy

  • pyfde ClassicDE

  • pyfde JADE

The source code is available in the IDDEFIX GitHub repository.

📚 For information on IDDEFIX’s differential evolution theory and code implementation, see:

IDDEFIX

• Theory
  • Resonator formalism
  • Fitting Resonators with Differential Evolution
• iddefix package
  • Submodules
  • iddefix.framework module
  • iddefix.objectiveFunctions module
  • iddefix.resonatorFormulas module
  • iddefix.smartBoundDetermination module
  • iddefix.solvers module
  • Module contents

📁 For examples on how to use, check out notebook examples. They have been embedded in the documentation using myst_nb:

Examples

• Example 001: Analytical Resonator fitting
  • Modelling a three resonator impedance spectrum by three arbitrary resonators
  • Fitting resonators with IDDEFIX on the absolute magnitude of the 3 resonator impdance spectrum
  • Assesing the fitting visually
  • Retrieve the wake function and wake potential
• Example 002: Extrapolation of simulation data
  • Simulation data example
  • Fitting on fully decayed wakefield
  • Fitting on partially decayed wakefield
• Example 002: Fitting SPS-BWS simulation data
  • Simulation data example
  • Fitting on fully decayed wakefield
• Example 004: Transverse wake extrapolation of SPS Transitions
  • Import data & visualize the data
  • Using the wake function for fitting
  • Using the wake potential for fitting
• Example 004: Transverse wake extrapolation of SPS Transitions
  • Import data & visualization
  • The problem of the broadband baseline
  • Running IDDEFIX DE
  • Original vs. extrapolated wake function
  • Impedance extrapolated
  • Using analytical wake and impedance from DE parameters