Specialized Tools for Use with elegant

A number of specialized programs are available that work with elegant. Most are SDDS-compliant, so they will also work with any program that reads or writes appropriate SDDS data. The following is a brief description of each program. Full descriptions are available on subsequent pages.

• csrImpedance -- Computes the shielded steady-state CSR impedance for a dipole magnet. The output can be used immediately with elegant's ZLONGIT element. (Program by Y. Wang, H. Shang, and M. Borland.)
• doubleDist6 -- Increases the number of particles in a particle input file by successively doubling the number. Intended to be used to increase the number of particles produced by a photoinjector simulation to improve stability of CSR and LSC simulations. See also smoothDist6.
• elegant2genesis -- This program performs slice analysis of particle output files, which are suitable for use with the SDDS-compliant APS version of GENESIS[14]. This program is part of the SDDS toolkit. See the SDDS toolkit manual for documentation. (Program by R. Soliday and M. Borland.)
• haissinski -- Computes the steady-state longitudinal distribution in an electron storage ring. Requires as input a file containing the Twiss parameters around the ring, such as that provided by the twiss_output command. (Program by L. Emery and M. Borland.)
• ibsEmittance -- Computes local intra-beam scattering rates for both storage ring and linac. Also computes the equlibrium transverse and longitudinal emittances of a beam in an electron storage ring, resulting from the combination of quantum excitation, damping, and intra-beam scattering. Requires as input a file containing the Twiss parameters, such as that provided by the twiss_output command. (Program by L. Emery, M. Borland, and A. Xiao)
• madto -- Translates an elegant-style lattice file (or a MAD file, with some restrictions) into formats accepted by other programs, such as COSY, PARMELA, PATPET, PATRICIA, TRANSPORT, and XORBIT. Will also generate an SDDS file containing lattice data. (Program by M. Borland.)
• sddsanalyzebeam -- Analyzes a beam of macro-particles and produces an SDDS file containing beam moments, emittances, equivalent beta functions, etc. The beam file is of the type written by elegant using the output field of the run_setup command, or the WATCH element. (Program by M. Borland.)
• sddsbrightness -- Uses twiss parameter output or data from sddsanalyzebeam to compute undulator brightness curves. (Program by H. Shang, R. Dejus, M. Borland, X. Jiao.)
• sddsemitproc -- Analyzes quadrupole scan emittance measurement data. Accepts a file containing the transport matrix for each point and measured beam sizes. The file may, for example, be the file produced by the final field of the run_setup command. The quadrupole scan can be executed inside of elegant using vary_elements. (Program by M. Borland.)
• sddsfluxcurve -- Uses twiss parameter output or data from sddsanalyzebeam to compute undulator flux tuning curves. (Program by M. Borland, H. Shang, R. Dejus.)
• sddsmatchtwiss -- Transforms a beam of macro-particles to match to given beta functions and dispersion. The beam file is of the type written by elegant using the output field of the run_setup command, or the WATCH element. (Program by M. Borland.)
• sddsurgent -- Uses algorithms from the programs US (by R. Dejus) and URGENT (by R. Walker) for computation of undulator radiation properties, including power density and intensity distributions. (Program by H. Shang, R. Dejus, M. Borland, X. Jiao.)
• sddsrandmult -- Simulates the effect of random mechanical errors in a quadrupole or sextupole, generating multipole error data that can be used with elegant's KQUAD and KSEXT elements. (Program by M. Borland.)
• sddssampledist -- This program allows creating particle distributions from user-designed distribution functions. It is thus a more flexible alternative to bunched_beam. This program is part of the SDDS toolkit. See the SDDS toolkit manual for documentation. (Program by M. Borland and H. Shang.)
• smoothDist6s -- Increases the number of particles in an input particle distribution. At the same time, smooths the distribution and adds optional energy and density modulation. Intended to be used to increase the number of particles produced by a photoinjector simulation to improve stability of CSR and LSC simulations. Also useful in studying the growth rate for energy and density modulations. See also doubleDist6.
• touschekLifetime -- This program calculates Touschek lifetime using A. Piwinski's formula. Input files are generated from ``twiss_output'' and ``momentum_aperture''. (Program by A. Xiao.)