impactx.madx_to_impactx Namespace Reference

Functions
def	lattice (parsed_beamline, nslice=1)
def	read_lattice (madx_file, nslice=1)
def	beam (particle, charge=None, mass=None, energy=None)
def	read_beam (RefPart ref, madx_file)

Function Documentation

beam()

def impactx.madx_to_impactx.beam	(		particle,
			charge = None,
			mass = None,
			energy = None
	)

Function that converts a list of beam parameter dictionaries in the MADXParser format into ImpactX format

Rules following https://mad.web.cern.ch/mad/releases/5.02.08/madxuguide.pdf pages 55f.

:param str particle: reference particle name
:param float charge: particle charge (proton charge units)
:param float mass: particle mass (electron masses)
:param float energy: particle energy (GeV)
    - MAD-X default: 1 GeV
:return dict: dictionary containing particle and beam attributes in ImpactX units

lattice()

def impactx.madx_to_impactx.lattice	(		parsed_beamline,
			nslice = 1
	)

Function that converts a list of elements in the MADXParser format into ImpactX format
:param parsed_beamline: list of dictionaries
:param nslice: number of ds slices per element
:return: list of translated dictionaries

read_beam()

def impactx.madx_to_impactx.read_beam	(	RefPart	ref,
			madx_file
	)

Function that reads elements from a MAD-X file into a list of ImpactX.KnownElements
:param RefPart ref: ImpactX reference particle (passed by reference)
:param madx_file: file name to MAD-X file with beamline elements
:return: list of ImpactX.KnownElements

read_lattice()

def impactx.madx_to_impactx.read_lattice	(		madx_file,
			nslice = 1
	)

Function that reads elements from a MAD-X file into a list of ImpactX.KnownElements
:param madx_file: file name to MAD-X file with beamline elements
:param nslice: number of ds slices per element
:return: list of ImpactX.KnownElements