atip 0.1.1__py3-none-any.whl

atip/__init__.py

@@ -0,0 +1,13 @@
+"""ATIP: Accelerator Toolbox Interface for Pytac.
+See README.rst & INSTALL.rst for more information.
+
+.. data:: __version__
+    :type: str
+
+    Version number as calculated by https://github.com/pypa/setuptools_scm
+"""
+
+from . import load_sim, sim_data_sources, simulator, utils
+from ._version import __version__
+
+__all__ = ["__version__", "load_sim", "sim_data_sources", "simulator", "utils"]

atip/__main__.py

@@ -0,0 +1,24 @@
+"""Interface for ``python -m atip``."""
+
+from argparse import ArgumentParser
+from collections.abc import Sequence
+
+from . import __version__
+
+__all__ = ["main"]
+
+
+def main(args: Sequence[str] | None = None) -> None:
+    """Argument parser for the CLI."""
+    parser = ArgumentParser()
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=__version__,
+    )
+    parser.parse_args(args)
+
+
+if __name__ == "__main__":
+    main()

atip/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.1'
+__version_tuple__ = version_tuple = (0, 1, 1)

atip/load_sim.py

@@ -0,0 +1,79 @@
+"""Module responsible for handling the loading of simulator data sources."""
+
+import at
+import pytac
+from pytac.exceptions import FieldException
+from pytac.units import NullUnitConv
+
+from atip.sim_data_sources import ATElementDataSource, ATLatticeDataSource
+from atip.simulator import ATSimulator
+
+# List of all the element fields that can be currently simulated.
+SIMULATED_FIELDS = {"a1", "b0", "b1", "b2", "x", "y", "f", "x_kick", "y_kick"}
+
+
+def load_from_filepath(
+    pytac_lattice, at_lattice_filepath, callback=None, disable_emittance=False
+):
+    """Load simulator data sources onto the lattice and its elements.
+
+    Args:
+        pytac_lattice (pytac.lattice.Lattice): An instance of a Pytac lattice.
+        at_lattice_filepath (str): The path to a .mat file from which the
+                                    Accelerator Toolbox lattice can be loaded.
+        callback (typing.Callable): To be called after completion of each round of
+                              physics calculations.
+        disable_emittance (bool): Whether the emittance should be calculated.
+
+    Returns:
+        pytac.lattice.Lattice: The same Pytac lattice object, but now with a
+        simulator data source fully loaded onto it.
+    """
+    at_lattice = at.load.load_mat(
+        at_lattice_filepath,
+        name=pytac_lattice.name,
+        energy=pytac_lattice.get_value("energy"),
+    )
+    return load(pytac_lattice, at_lattice, callback, disable_emittance)
+
+
+def load(pytac_lattice, at_lattice, callback=None, disable_emittance=False):
+    """Load simulator data sources onto the lattice and its elements.
+
+    Args:
+        pytac_lattice (pytac.lattice.Lattice): An instance of a Pytac lattice.
+        at_lattice (at.lattice_object.Lattice): An instance of an Accelerator
+                                              Toolbox lattice object.
+        callback (typing.Callable): To be called after completion of each round of
+                              physics calculations.
+        disable_emittance (bool): Whether the emittance should be calculated.
+
+    Returns:
+        pytac.lattice.Lattice: The same Pytac lattice object, but now with a
+        simulator data source fully loaded onto it.
+    """
+    if len(at_lattice) != len(pytac_lattice):
+        raise ValueError(
+            "Incompatible AT and Pytac lattices, length mismatch "
+            f"(AT:{len(at_lattice)} Pytac:{len(pytac_lattice)})."
+        )
+    # Initialise an instance of the ATSimulator Object.
+    atsim = ATSimulator(at_lattice, callback, disable_emittance)
+    # Set the simulator data source on the Pytac lattice.
+    pytac_lattice.set_data_source(ATLatticeDataSource(atsim), pytac.SIM)
+    # Load the sim onto each element.
+    for e in pytac_lattice:
+        # Determine which fields each simulated element should have.
+        sim_fields = list(set(e.get_fields()[pytac.LIVE]) & SIMULATED_FIELDS)
+        # Set the simulator data source on each element.
+        e.set_data_source(
+            ATElementDataSource(at_lattice[e.index - 1], e.index, atsim, sim_fields),
+            pytac.SIM,
+        )
+    # Give any lattice fields not on the live machine a unit conversion object.
+    for field in pytac_lattice.get_fields()[pytac.SIM]:
+        try:
+            pytac_lattice.get_unitconv(field)
+        except FieldException:
+            pytac_lattice.set_unitconv(field, NullUnitConv())
+    return pytac_lattice

atip/rings/DIAMOND2SP.lat

@@ -0,0 +1,230 @@
+{c:\users\bs36\desktop\jb-04-30-05\m-h6ba-17e-79pm-01-01-02_sym_oct.opa}
+
+{opa to tracy-2 export}
+
+define lattice;
+energy = 3.500000;
+dp = 1.0d-10;  codeps = 1.0d-6;  dk = 1.0d-6;
+meth = 4; nbend = 10; nquad = 10;
+f = 499501358.3498094;
+sp_f = 2.997008150098844e9;
+
+{----- variables ----------------------------------------------------}
+
+nsext  = 2;
+aban1  = 0.24303148;
+aban3  = -0*0.33772927;
+aban4  = 0.31853103;
+rk1    = 5.26028347;
+rk2    = -3.62182625;
+rk3    = 6.12183082;
+rk4    = 6.22723242;
+
+{----- table of elements ----------------------------------------------------}
+
+cav: Cavity, L = 0.0, Frequency = 2.997008150098844e9, Voltage = 2.2e6,
+    harnum=934, phi = 0.0;
+
+dmult    : drift, l = 0.045000;
+dmult1   : drift, l = 0.000000;
+dcor     : drift, l = 0.000000;
+dcor1    : drift, l = 0.040000;
+dr_01    : drift, l = 2.521350;
+dr_02    : drift, l = 0.075000;
+dr_03    : drift, l = 0.075000;
+dr_04    : drift, l = 0.150000;
+dr_05    : drift, l = 0.075000;
+dr_06    : drift, l = 0.075000;
+dr_07    : drift, l = 0.075000;
+dr_08    : drift, l = 0.075000;
+dr_09    : drift, l = 0.330500;
+dr_091   : drift, l = 0.120000;
+dr_092   : drift, l = 0.210500;
+dr_10    : drift, l = 0.075000;
+dr_11    : drift, l = 0.075000;
+dr_12    : drift, l = 0.075000;
+dr_13    : drift, l = 0.165500;
+dr_14    : drift, l = 0.075000;
+dr_15    : drift, l = 0.075000;
+dr_16    : drift, l = 0.075000;
+dr_17    : drift, l = 0.100000;
+dr_18    : drift, l = 0.080000;
+dr_19    : drift, l = 0.197000;
+dr_20    : drift, l = 0.090000;
+dr_21    : drift, l = 0.090000;
+dr_22    : drift, l = 0.075000;
+dr_23    : drift, l = 0.075000;
+dr_24    : drift, l = 1.384200;
+dl_27    : drift, l = 3.696350;
+dl_26    : drift, l = 0.075000;
+dl_25    : drift, l = 0.035000;
+dl_24    : drift, l = 0.035000;
+dl_23    : drift, l = 0.075000;
+dl_22    : drift, l = 0.075000;
+dl_21    : drift, l = 0.075000;
+dl_20    : drift, l = 0.075000;
+dl_19    : drift, l = 0.075000;
+dl_18    : drift, l = 0.075000;
+dl_17    : drift, l = 0.075000;
+dl_161   : drift, l = 0.120000;
+dl_162   : drift, l = 0.210500;
+dl_15    : drift, l = 0.075000;
+dl_14    : drift, l = 0.075000;
+dl_13    : drift, l = 0.075000;
+dl_12    : drift, l = 0.165500;
+dl_11    : drift, l = 0.075000;
+dl_10    : drift, l = 0.075000;
+dl_09    : drift, l = 0.075000;
+dl_08    : drift, l = 0.100000;
+dl_07    : drift, l = 0.080000;
+dl_06    : drift, l = 0.197000;
+dl_05    : drift, l = 0.090000;
+dl_04    : drift, l = 0.090000;
+dl_03    : drift, l = 0.075000;
+dl_02    : drift, l = 0.075000;
+dl_01    : drift, l = 1.384200;
+
+b_t      : marker;
+ms       : marker;
+ss       : marker;
+ls       : marker;
+
+dl1a_1:   bending, l =  0.20000000,
+    t =  0.32969999, t1 =  0.00000000, t2 =  0.32969999, k = -0.12411107,
+    n = nbend, method = 4;
+dl1a_2:   bending, l =  0.20000000,
+    t =  0.37951415, t1 = -0.32969999, t2 =  0.70921414, k = -0.12411107,
+    n = nbend, method = 4;
+dl1a_3:   bending, l =  0.20000000,
+    t =  0.44430484, t1 = -0.37951415, t2 =  1.15351899, k = -0.12411107,
+    n = nbend, method = 4;
+dl1a_4:   bending, l =  0.20000000,
+    t =  0.54929318, t1 = -0.44430484, t2 =  1.70281217, k = -0.12411107,
+    n = nbend, method = 4;
+dl1a_5:   bending, l =  0.20000000,
+    t =  0.83989144, t1 = -0.54929318, t2 =  2.54270361, k = -0.12411107,
+    n = nbend, method = 4;
+dl2a_1:   bending, l =  0.16667000,
+    t =  0.37529392, t1 =  0.00000000, t2 =  0.37529392, k = -0.57541761,
+    n = nbend, method = 4;
+dl2a_2:   bending, l =  0.16667000,
+    t =  0.43199684, t1 = -0.37529392, t2 =  0.80729076, k = -0.57541761,
+    n = nbend, method = 4;
+dl2a_3:   bending, l =  0.33334000,
+    t =  0.50574738, t1 = -0.43199684, t2 =  1.31303814, k = -0.57541761,
+    n = nbend, method = 4;
+dl2a_4:   bending, l =  0.16667000,
+    t =  0.62525447, t1 = -0.50574738, t2 =  1.93829261, k = -0.57541761,
+    n = nbend, method = 4;
+dl2a_5:   bending, l =  0.16667000,
+    t =  0.95603931, t1 = -0.62525447, t2 =  2.89433192, k = -0.57541761,
+    n = nbend, method = 4;
+
+qf4:      bending, l =  0.15000000,
+    t = -0.28922341, t1 = -0.14461171, t2 = -0.14461171, k =  4.58473041,
+    n = nbend, method = 4;
+qf8:      bending, l =  0.25000000,
+    t = -0.20559380, t1 = -0.10279690, t2 = -0.10279690, k =  6.65707774,
+    n = nbend, method = 4;
+dq1:      bending, l =  0.87000000,
+    t =  2.84700510, t1 =  1.42350255, t2 =  1.42350255, k = -2.80820067,
+    n = nbend, method = 4;
+
+qf1:      quadrupole, l =  0.15000000, k = 10.24316352, n = nquad, method = 4;
+qd2:      quadrupole, l =  0.15000000, k = -6.81087771, n = nquad, method = 4;
+qd3:      quadrupole, l =  0.15000000, k = -2.33804938, n = nquad, method = 4;
+qd5:      quadrupole, l =  0.10500000, k = -3.17820036, n = nquad, method = 4;
+qf6:      quadrupole, l =  0.36000000, k =  7.44415301, n = nquad, method = 4;
+qd3_c1:   quadrupole, l =  0.15000000, k = -2.35079416, n = nquad, method = 4;
+qf1_c1:   quadrupole, l =  0.18500000, k = -4.54825797, n = nquad, method = 4;
+qd2_c1:   quadrupole, l =  0.10500000, k = -1.65796511, n = nquad, method = 4;
+quad_add: quadrupole, l =  0.18500000, k =  7.03286724, n = nquad, method = 4;
+
+{ [+,-,-,-] }
+sf1     : sextupole, l = 0.14000, k =  1.74437e+02, n = nsext, Method = Meth;
+sd1     : sextupole, l = 0.14000, k = -2.18565e+02, n = nsext, Method = Meth;
+sd2     : sextupole, l = 0.14000, k = -1.42631e+02, n = nsext, Method = Meth;
+s       : sextupole, l = 0.10000, k = 0.000000, n = 1, method=meth;
+sh2     : sextupole, l = 0.10000, k = 0.000000, n = 1, method=meth;
+
+sh1a    : sextupole, l = 0.10000, k = 0.000000, n = 1, method=meth;
+sh1b    : sextupole, l = 0.10000, k = 0.000000, n = 1, method=meth;
+
+of1      : multipole, l = 0.0;{, hom = (4, 0.0, 0);}
+
+bpm_01   : beam position monitor;
+bpm_02   : beam position monitor;
+bpm_03   : beam position monitor;
+bpm_04   : beam position monitor;
+bpm_05   : beam position monitor;
+bpm_06   : beam position monitor;
+bpm_07   : beam position monitor;
+bpm_08   : beam position monitor;
+bpm_09   : beam position monitor;
+bpm_10   : beam position monitor;
+bpm_11   : beam position monitor;
+
+ch_01    : corrector, horizontal;
+ch_02    : corrector, horizontal;
+ch_03    : corrector, horizontal;
+ch_04    : corrector, horizontal;
+ch_05    : corrector, horizontal;
+ch_06    : corrector, horizontal;
+ch_07    : corrector, horizontal;
+ch_08    : corrector, horizontal;
+ch_09    : corrector, horizontal;
+ch_10    : corrector, horizontal;
+ch_11    : corrector, horizontal;
+
+cv_01    : corrector, vertical;
+cv_02    : corrector, vertical;
+cv_03    : corrector, vertical;
+cv_04    : corrector, vertical;
+cv_05    : corrector, vertical;
+cv_06    : corrector, vertical;
+cv_07    : corrector, vertical;
+cv_08    : corrector, vertical;
+cv_09    : corrector, vertical;
+cv_10    : corrector, vertical;
+cv_11    : corrector, vertical;
+
+{----- table of segments ----------------------------------------------------}
+
+dl1a     : dl1a_5, dl1a_4, dl1a_3, dl1a_2, dl1a_1;
+dl2a     : dl2a_5, dl2a_4, dl2a_3, dl2a_2, dl2a_1;
+of1s     : dmult, of1, dmult;
+arca_c2r : dr_24, bpm_05, dr_23, ch_05, cv_05, sh2, dr_22, qf8,
+           dr_21, dq1, dr_20, qf6, dr_19, bpm_04, dr_18, dcor, s, ch_04, cv_04,
+           dcor, dr_17, dl2a, dr_16, qd5, dr_15, sd2, ch_03, cv_03, dr_14,
+           bpm_03, dr_13, of1s, dr_12, qf4, dr_11, sf1, dr_10, qf4, dr_091,
+           of1, dr_092, bpm_02, dr_08, ch_02, cv_02, sd1, dr_07, qd3, dr_06,
+           inv(dl1a), dr_05, qd2, dr_04, ch_01, cv_01, sh1b, dr_03, qf1, dr_02,
+           bpm_01, dr_01;
+arca_c1r : dl_01, bpm_06, dl_02, ch_06, cv_06, sh2, dl_03, qf8,
+           dl_04, dq1, dl_05, qf6, dl_06, bpm_07, dl_07, dcor, s, ch_07, cv_07,
+           dcor, dl_08, dl2a, dl_09, qd5, dl_10, sd2, ch_08, cv_08, dl_11,
+           bpm_08, dl_12, of1s, dl_13, qf4, dl_14, sf1, dl_15, qf4, dl_161,
+           of1, dl_162, bpm_09, dl_17, ch_09, cv_09, sd1, dl_18, qd3_c1, dl_19,
+           inv(dl1a), dl_20, qd2_c1, dl_21, bpm_10, dl_22, ch_10, cv_10, sh1a,
+           dl_23, qf1_c1, dl_24, dcor1, ch_11, cv_11, dcor1, dl_25, quad_add,
+           dl_26, bpm_11, dl_27;
+arca_c2  : ms, arca_c2r, ss, b_t, inv(arca_c2r);
+arca_c1  : arca_c2r, ms, inv(arca_c1r);
+sp_short : ls, inv(arca_c1r), 2*arca_c2, arca_c1r, ls;
+sp       : ls, b_t, inv(arca_c1r), 3*arca_c2, arca_c1r, b_t, ls;
+
+{line:  ss, inv(arca_c2r), ms, arca_c2r, ss;}
+{line: ms, arca_c1r, ls;}
+{line: ms, arca_c1r, ls, inv(arca_c1r), ms;}
+{line: ss, inv(arca_c1), arca_c1, ss;}
+{line: sp_short;}
+line: sp;
+{line: 6*sp;}
+
+ring: 1*line, cav;
+
+cell: ring, symmetry=1;
+
+end;
+
+{c:\users\bs36\desktop\jb-04-30-05\m-h6ba-17e-79pm-01-01-02_sym_oct.opa}

atip/rings/create_lattice_matfile.m

@@ -0,0 +1,70 @@
+function create_lattice_matfile(filename)
+% Creates a .mat file AT lattice compatible with ATIP.
+% If a filename is given that file will be updated to ATIP standard. Otherwise
+% the ring is taken from either of the 'RING' or 'THERING' global variables,
+% with 'RING' taking priority. If a filename is not passed the updated lattice
+% will be stored in 'lattice.mat'.
+    if ~(nargin == 0)
+        load(filename, 'RING');
+    end
+    if ~exist('RING', 'var')
+        global RING;
+        if isempty(RING)
+            global THERING;
+            RING = THERING;
+        end
+    end
+    if isempty(RING)
+        disp('Unable to load a ring from file or global variables.');
+        return;
+    end
+    % Correct dimension order if necessary.
+    if size(RING, 1) == 1
+        RING = permute(RING, [2 1]);
+    end
+    % Correct classes and pass methods.
+    for x = 1:length(RING)
+        if strcmp(RING{x, 1}.FamName, 'BPM10')
+            % Wouldn't be correctly classed by class guessing otherwise.
+            RING{x, 1}.Class = 'Monitor';
+        elseif (strcmp(RING{x, 1}.FamName, 'HSTR') || strcmp(RING{x, 1}.FamName, 'VSTR'))
+            RING{x, 1}.Class = 'Corrector';
+        elseif (strcmp(RING{x, 1}.FamName, 'HTRIM') || strcmp(RING{x, 1}.FamName, 'VTRIM'))
+            RING{x, 1}.Class = 'Corrector';
+        end
+        if isfield(RING{x, 1}, 'Class')
+            if strcmp(RING{x, 1}.Class, 'SEXT')
+                RING{x, 1}.Class = 'Sextupole';
+            end
+        end
+        if strcmp(RING{x, 1}.PassMethod, 'ThinCorrectorPass')
+            % ThinCorrectorPass no longer exists in AT.
+            RING{x, 1}.PassMethod = 'CorrectorPass';
+        elseif strcmp(RING{x, 1}.PassMethod, 'GWigSymplecticPass')
+            RING{x, 1}.Class = 'Wiggler';
+        end
+    end
+
+    % Remove elements. Done this way because the size of RING changes during
+    % the loop.
+    y = 1;  
+    while y < length(RING)
+        % I should probably transfer the attributes of the deleted corrector
+        % elements to the sextupole but cba.
+        if (strcmp(RING{y, 1}.FamName, 'HSTR') && strcmp(RING{y-1, 1}.Class, 'Sextupole'))
+            RING(y, :) = [];  % Delete hstrs that are preceded by a sextupole.
+        elseif (strcmp(RING{y, 1}.FamName, 'VSTR') && strcmp(RING{y-1, 1}.Class, 'Sextupole'))
+            RING(y, :) = [];  % Delete vstrs that are preceded by a sextupole.
+        else
+            y = y + 1;
+        end
+    end
+    if isfield(RING{1, 1}, 'TwissData')
+        RING{1, 1} = rmfield(RING{1, 1}, 'TwissData');
+    end
+    if nargin == 0
+        save('lattice.mat', 'RING');
+    else
+        save(filename, 'RING');
+    end
+end