Skip to content

Fix EqParams classes #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xresende merged 5 commits into from
Apr 9, 2026
Merged

Fix EqParams classes #163

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52f0335
Fix EqParams classes
xresende Mar 25, 2026
88dbf81
Fix __str__ method in _EqParams
xresende Mar 26, 2026
17ff86e
Ruff formatting in eq_params.py
xresende Mar 27, 2026
a593321
Delete unsed imports in eq_params
xresende Mar 27, 2026
ed2369f
Add line back in epqparam_to_string
xresende Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
290 changes: 210 additions & 80 deletions pyaccel/optics/eq_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,63 @@
"""Equilibrium Parameters."""

import math as _math
import copy as _copy

import mathphys as _mp

from .miscellaneous import get_rf_voltage as _get_rf_voltage
import math as _math


class _EqParams:
"""Equilibrium parameters base class."""

PARAMETERS = {
'energy', 'energy_offset',
'espread0', 'bunlen',
'rf_voltage', 'U0', 'overvoltage', 'syncphase', 'synctune',
'alpha', 'etac', 'rf_acceptance',
'sigma_rx', 'sigma_px',
'sigma_ry', 'sigma_py',
'energy',
'energy_offset',
'espread0',
'bunlen',
'rf_voltage',
'U0',
'overvoltage',
'syncphase',
'synctune',
'alpha',
'etac',
'rf_acceptance',
'sigma_rx',
'sigma_px',
'sigma_ry',
'sigma_py',
}

def __init__(self, eqparams=None):
"""."""
# initialize parameters with corresponding eqparam values or with none.
# initialize parameters with corresponding eqparam values or with None.
for param in self.PARAMETERS:
value = getattr(eqparams, param, None)
if isinstance(eqparams, dict):
value = eqparams.get(param, None)
else:
value = getattr(eqparams, param, None)
value = _copy.deepcopy(value)
setattr(self, param, value)

def __str__(cls):
def __str__(self):
"""."""
return cls.eqparam_to_string(cls)
return self.eqparam_to_string(self)


class EqParamsXYModes(_EqParams):
"""Equilibrium parameters for XY modes."""

PARAMETERS = _EqParams.PARAMETERS.union({
'Jx', 'Jy', 'Je',
'alphax', 'alphay', 'alphae',
'taux', 'tauy', 'taue',
'emitx', 'emity', 'emit0',
'Jx',
'Jy',
'Je',
'alphax',
'alphay',
'alphae',
'taux',
'tauy',
'taue',
'emitx',
'emity',
'emit0',
})

@staticmethod
Expand All @@ -50,33 +67,88 @@ def eqparam_to_string(eqparam):
fmti = '{:32s}: '
fmtn = '{:.4g}'
fmte = fmti + fmtn
prechar = ''

if eqparam.energy is not None:
rst += fmte.format(prechar + 'Energy [GeV]', eqparam.energy * 1e-9)
prechar = '\n'
if eqparam.energy_offset is not None:
Comment thread
vellosok75 marked this conversation as resolved.
rst += prechar + fmte.format(
'Energy offset [%]', eqparam.energy_offset * 100
)
prechar = '\n'

if None not in (eqparam.Jx, eqparam.Jy, eqparam.Je):
ints = 'Jx,Jy,Je'.split(',')
rst += prechar + fmti.format(', '.join(ints))
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])
prechar = '\n'

if None not in (eqparam.taux, eqparam.tauy, eqparam.taue):
ints = 'taux,tauy,taue'.split(',')
rst += prechar + fmti.format(', '.join(ints) + ' [ms]')
rst += ', '.join([
fmtn.format(1000 * getattr(eqparam, x)) for x in ints
])
prechar = '\n'

rst += fmte.format('Energy [GeV]', eqparam.energy*1e-9)
rst += '\n' + fmte.format('Energy offset [%]', eqparam.energy_offset*100)

ints = 'Jx,Jy,Je'.split(',')
rst += '\n' + fmti.format(', '.join(ints))
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])

ints = 'taux,tauy,taue'.split(',')
rst += '\n' + fmti.format(', '.join(ints) + ' [ms]')
rst += ', '.join([fmtn.format(1000*getattr(eqparam, x)) for x in ints])

ints = 'alphax,alphay,alphae'.split(',')
rst += '\n' + fmti.format(', '.join(ints) + ' [Hz]')
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])

rst += '\n' + fmte.format('momentum compaction x 1e4', eqparam.alpha*1e4)
rst += '\n' + fmte.format('energy loss [keV]', eqparam.U0/1000)
rst += '\n' + fmte.format('overvoltage', eqparam.overvoltage)
rst += '\n' + fmte.format('sync phase [°]', eqparam.syncphase*180/_math.pi)
rst += '\n' + fmte.format('sync tune', eqparam.synctune)
rst += '\n' + fmte.format('horizontal emittance [nm.rad]', eqparam.emitx*1e9)
rst += '\n' + fmte.format('vertical emittance [pm.rad]', eqparam.emity*1e12)
rst += '\n' + fmte.format('natural emittance [nm.rad]', eqparam.emit0*1e9)
rst += '\n' + fmte.format('natural espread [%]', eqparam.espread0*100)
rst += '\n' + fmte.format('bunch length [mm]', eqparam.bunlen*1000)
rst += '\n' + fmte.format('RF energy accep. [%]', eqparam.rf_acceptance*100)
if None not in (eqparam.alphax, eqparam.alphay, eqparam.alphae):
ints = 'alphax,alphay,alphae'.split(',')
rst += prechar + fmti.format(', '.join(ints) + ' [Hz]')
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])
prechar = '\n'

if eqparam.alpha is not None:
rst += prechar + fmte.format(
'momentum compaction x 1e4', eqparam.alpha * 1e4
)
prechar = '\n'
if eqparam.U0 is not None:
rst += prechar + fmte.format(
'energy loss [keV]', eqparam.U0 / 1000
)
prechar = '\n'
if eqparam.overvoltage is not None:
rst += prechar + fmte.format('overvoltage', eqparam.overvoltage)
prechar = '\n'
if eqparam.syncphase is not None:
rst += prechar + fmte.format(
'sync phase [°]', eqparam.syncphase * 180 / _math.pi
)
prechar = '\n'
if eqparam.synctune is not None:
rst += prechar + fmte.format('sync tune', eqparam.synctune)
prechar = '\n'
if eqparam.emitx is not None:
rst += prechar + fmte.format(
'horizontal emittance [pm.rad]', eqparam.emitx * 1e12
)
prechar = '\n'
if eqparam.emity is not None:
rst += prechar + fmte.format(
'vertical emittance [pm.rad]', eqparam.emity * 1e12
)
prechar = '\n'
if eqparam.emit0 is not None:
rst += prechar + fmte.format(
'natural emittance [pm.rad]', eqparam.emit0 * 1e12
)
prechar = '\n'
if eqparam.espread0 is not None:
rst += prechar + fmte.format(
'natural espread [%]', eqparam.espread0 * 100
)
prechar = '\n'
if eqparam.bunlen is not None:
rst += prechar + fmte.format(
'bunch length [mm]', eqparam.bunlen * 1000
)
prechar = '\n'
if eqparam.rf_acceptance is not None:
rst += prechar + fmte.format(
'RF energy accep. [%]', eqparam.rf_acceptance * 100
)
prechar = '\n'
return rst


Expand All @@ -85,11 +157,20 @@ class EqParamsNormalModes(_EqParams):

CHR_MODE1, CHR_MODE2, CHR_MODE3 = '1', '2', '3'
PARAMETERS = _EqParams.PARAMETERS.union({
'J1', 'J2', 'J3',
'alpha1', 'alpha2', 'alpha3',
'tau1', 'tau2', 'tau3',
'tune1', 'tune2', 'tune3',
'emit1', 'emit2',
'J1',
'J2',
'J3',
'alpha1',
'alpha2',
'alpha3',
'tau1',
'tau2',
'tau3',
'tune1',
'tune2',
'tune3',
'emit1',
'emit2',
'tilt_xyplane',
})

Expand All @@ -99,35 +180,84 @@ def eqparam_to_string(eqparam):
rst = ''
fmti = '{:32s}: '
fmtn = '{:.4g}'

fmte = fmti + fmtn
prechar = ''

if eqparam.energy is not None:
rst += fmte.format(prechar + 'Energy [GeV]', eqparam.energy * 1e-9)
prechar = '\n'
if eqparam.energy_offset is not None:
rst += prechar + fmte.format(
'Energy offset [%]', eqparam.energy_offset * 100
)
prechar = '\n'
if None not in (eqparam.J1, eqparam.J2, eqparam.J3):
ints = 'J1,J2,J3'.split(',')
rst += prechar + fmti.format(', '.join(ints))
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])
prechar = '\n'

if None not in (eqparam.tau1, eqparam.tau2, eqparam.tau3):
ints = 'tau1,tau2,tau3'.split(',')
rst += prechar + fmti.format(', '.join(ints) + ' [ms]')
rst += ', '.join([
fmtn.format(1000 * getattr(eqparam, x)) for x in ints
])
prechar = '\n'

rst += fmte.format('Energy [GeV]', eqparam.energy*1e-9)
rst += '\n' + fmte.format('Energy offset [%]', eqparam.energy_offset*100)

ints = 'J1,J2,J3'.split(',')
rst += '\n' + fmti.format(', '.join(ints))
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])

ints = 'tau1,tau2,tau3'.split(',')
rst += '\n' + fmti.format(', '.join(ints) + ' [ms]')
rst += ', '.join([fmtn.format(1000*getattr(eqparam, x)) for x in ints])

ints = 'alpha1,alpha2,alpha3'.split(',')
rst += '\n' + fmti.format(', '.join(ints) + ' [Hz]')
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])

ints = 'tune1,tune2,tune3'.split(',')
rst += '\n' + fmti.format(', '.join(ints) + ' [Hz]')
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])

rst += '\n' + fmte.format('momentum compaction x 1e4', eqparam.alpha*1e4)
rst += '\n' + fmte.format('energy loss [keV]', eqparam.U0/1000)
rst += '\n' + fmte.format('overvoltage', eqparam.overvoltage)
rst += '\n' + fmte.format('sync phase [°]', eqparam.syncphase*180/_math.pi)
rst += '\n' + fmte.format('mode 1 emittance [nm.rad]', eqparam.emit1*1e9)
rst += '\n' + fmte.format('mode 2 emittance [pm.rad]', eqparam.emit2*1e12)
rst += '\n' + fmte.format('natural espread [%]', eqparam.espread0*100)
rst += '\n' + fmte.format('bunch length [mm]', eqparam.bunlen*1000)
rst += '\n' + fmte.format('RF energy accep. [%]', eqparam.rf_acceptance*100)
return rst
if None not in (eqparam.alpha1, eqparam.alpha2, eqparam.alpha3):
ints = 'alpha1,alpha2,alpha3'.split(',')
rst += prechar + fmti.format(', '.join(ints) + ' [Hz]')
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])
prechar = '\n'

if None not in (eqparam.tune1, eqparam.tune2, eqparam.tune3):
ints = 'tune1,tune2,tune3'.split(',')
rst += prechar + fmti.format(', '.join(ints) + ' [Hz]')
rst += ', '.join([fmtn.format(getattr(eqparam, x)) for x in ints])
prechar = '\n'

if eqparam.alpha is not None:
rst += prechar + fmte.format(
'momentum compaction x 1e4', eqparam.alpha * 1e4
)
prechar = '\n'
if eqparam.U0 is not None:
rst += prechar + fmte.format(
'energy loss [keV]', eqparam.U0 / 1000
)
prechar = '\n'
if eqparam.overvoltage is not None:
rst += prechar + fmte.format('overvoltage', eqparam.overvoltage)
prechar = '\n'
if eqparam.syncphase is not None:
rst += prechar + fmte.format(
'sync phase [°]', eqparam.syncphase * 180 / _math.pi
)
prechar = '\n'
if eqparam.emit1 is not None:
rst += prechar + fmte.format(
'mode 1 emittance [nm.rad]', eqparam.emit1 * 1e9
)
prechar = '\n'
if eqparam.emit2 is not None:
rst += prechar + fmte.format(
'mode 2 emittance [pm.rad]', eqparam.emit2 * 1e12
)
prechar = '\n'
if eqparam.espread0 is not None:
rst += prechar + fmte.format(
'natural espread [%]', eqparam.espread0 * 100
)
prechar = '\n'
if eqparam.bunlen is not None:
rst += prechar + fmte.format(
'bunch length [mm]', eqparam.bunlen * 1000
)
prechar = '\n'
if eqparam.rf_acceptance is not None:
rst += prechar + fmte.format(
'RF energy accep. [%]', eqparam.rf_acceptance * 100
)
prechar = '\n'
return rst