Skip to content

mad_collider

This class is used to build a Xsuite collider from a madx sequence and optics.

MadCollider

MadCollider class is responsible for setting up and managing the collider environment using MAD-X and xsuite.

Attributes:

Name Type Description
sanity_checks bool

Flag to enable or disable sanity checks.
links str

Path to the links configuration.
beam_config dict

Configuration for the beam.
optics str

Path to the optics file.
enable_imperfections bool

Flag to enable or disable imperfections.
enable_knob_synthesis bool

Flag to enable or disable knob synthesis.
rename_coupling_knobs bool

Flag to enable or disable renaming of coupling knobs.
pars_for_imperfections dict

Parameters for imperfections.
ver_lhc_run float | None

Version of LHC run.
ver_hllhc_optics float | None

Version of HL-LHC optics.
ions bool

Flag to indicate if ions are used.
phasing dict

Phasing configuration.
path_collider_file_for_configuration_as_output str

Path to save the collider.
compress bool

Flag to enable or disable compression of collider file.

Methods:

Name Description
ost

Property to get the appropriate optics specific tools.
prepare_mad_collider

Prepares the MAD-X collider environment.
build_collider

Madx, mad_b4: Madx) -> xt.Multiline: Builds the xsuite collider.
activate_RF_and_twiss

xt.Multiline) -> None: Activates RF and performs twiss analysis.
check_xsuite_lattices

xt.Line) -> None: Checks the xsuite lattices.
write_collider_to_disk

xt.Multiline) -> None: Writes the collider to disk and optionally compresses it.
clean_temporary_files

Cleans up temporary files created during the process.
Source code in study_da/generate/master_classes/mad_collider.py 
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
class MadCollider:
    """
    MadCollider class is responsible for setting up and managing the collider environment using
    MAD-X and xsuite.

    Attributes:
        sanity_checks (bool): Flag to enable or disable sanity checks.
        links (str): Path to the links configuration.
        beam_config (dict): Configuration for the beam.
        optics (str): Path to the optics file.
        enable_imperfections (bool): Flag to enable or disable imperfections.
        enable_knob_synthesis (bool): Flag to enable or disable knob synthesis.
        rename_coupling_knobs (bool): Flag to enable or disable renaming of coupling knobs.
        pars_for_imperfections (dict): Parameters for imperfections.
        ver_lhc_run (float | None): Version of LHC run.
        ver_hllhc_optics (float | None): Version of HL-LHC optics.
        ions (bool): Flag to indicate if ions are used.
        phasing (dict): Phasing configuration.
        path_collider_file_for_configuration_as_output (str): Path to save the collider.
        compress (bool): Flag to enable or disable compression of collider file.

    Methods:
        ost: Property to get the appropriate optics specific tools.
        prepare_mad_collider() -> tuple[Madx, Madx]: Prepares the MAD-X collider environment.
        build_collider(mad_b1b2: Madx, mad_b4: Madx) -> xt.Multiline: Builds the xsuite collider.
        activate_RF_and_twiss(collider: xt.Multiline) -> None: Activates RF and performs twiss analysis.
        check_xsuite_lattices(line: xt.Line) -> None: Checks the xsuite lattices.
        write_collider_to_disk(collider: xt.Multiline) -> None: Writes the collider to disk and
            optionally compresses it.
        clean_temporary_files() -> None: Cleans up temporary files created during the process.
    """

    def __init__(self, configuration: dict):
        """
        Initializes the MadCollider class with the given configuration.

        Args:
            configuration (dict): A dictionary containing the following keys:
                - sanity_checks (bool): Flag to enable or disable sanity checks.
                - links (str): Path to the links configuration.
                - beam_config (dict): Configuration for the beam.
                - optics_file (str): Path to the optics file.
                - enable_imperfections (bool): Flag to enable or disable imperfections.
                - enable_knob_synthesis (bool): Flag to enable or disable knob synthesis.
                - rename_coupling_knobs (bool): Flag to enable or disable renaming of coupling
                    knobs.
                - pars_for_imperfections (dict): Parameters for imperfections.
                - ver_lhc_run (float | None): Version of the LHC run, if applicable.
                - ver_hllhc_optics (float | None): Version of the HL-LHC optics, if applicable.
                - ions (bool): Flag to indicate if ions are used.
                - phasing (dict): Configuration for phasing.
                - path_collider_file_for_configuration_as_output (str): Path to the collider.
                - compress (bool): Flag to enable or disable compression.
        """
        # Configuration variables
        self.sanity_checks: bool = configuration["sanity_checks"]
        self.links: str = configuration["links"]
        self.beam_config: dict = configuration["beam_config"]
        self.optics: str = configuration["optics_file"]
        self.enable_imperfections: bool = configuration["enable_imperfections"]
        self.enable_knob_synthesis: bool = configuration["enable_knob_synthesis"]
        self.rename_coupling_knobs: bool = configuration["rename_coupling_knobs"]
        self.pars_for_imperfections: dict = configuration["pars_for_imperfections"]
        self.ver_lhc_run: float | None = configuration["ver_lhc_run"]
        self.ver_hllhc_optics: float | None = configuration["ver_hllhc_optics"]
        self.ions: bool = configuration["ions"]
        self.phasing: dict = configuration["phasing"]

        # Optics specific tools
        self._ost = None

        # Path to disk and compression
        self.path_collider_file_for_configuration_as_output = configuration[
            "path_collider_file_for_configuration_as_output"
        ]
        self.compress = configuration["compress"]

    @property
    def ost(self) -> Any:
        """
        Determines and returns the appropriate optics-specific tools (OST) based on the
        version of HLLHC optics or LHC run configuration.

        Raises:
            ValueError: If both `ver_hllhc_optics` and `ver_lhc_run` are defined.
            ValueError: If no optics-specific tools are available for the given configuration.

        Returns:
            Any: The appropriate OST module based on the configuration.
        """
        if self._ost is None:
            # Check that version is well defined
            if self.ver_hllhc_optics is not None and self.ver_lhc_run is not None:
                raise ValueError("Only one of ver_hllhc_optics and ver_lhc_run can be defined")

            # Get the appropriate optics_specific_tools
            if self.ver_hllhc_optics is not None:
                match self.ver_hllhc_optics:
                    case 1.6:
                        self._ost = ost_hllhc16
                    case 1.3:
                        self._ost = ost_hllhc13
                    case _:
                        raise ValueError("No optics specific tools for this configuration")
            elif self.ver_lhc_run == 3.0:
                self._ost = ost_runIII_ions if self.ions else ost_runIII
            else:
                raise ValueError("No optics specific tools for the provided configuration")

        return self._ost

    def prepare_mad_collider(self) -> tuple[Madx, Madx]:
        # sourcery skip: extract-duplicate-method
        """
        Prepares the MAD-X collider environment and sequences for beam 1/2 and beam 4.

        This method performs the following steps:
        1. Creates the MAD-X environment using the provided links.
        2. Initializes MAD-X instances for beam 1/2 and beam 4 with respective command logs.
        3. Builds the sequences for both beams using the provided beam configuration.
        4. Applies the specified optics to the beam 1/2 sequence.
        5. Optionally performs sanity checks on the beam 1/2 sequence by running TWISS and checking
            the MAD-X lattices.
        6. Applies the specified optics to the beam 4 sequence.
        7. Optionally performs sanity checks on the beam 4 sequence by running TWISS and checking
            the MAD-X lattices.

        Returns:
            tuple[Madx, Madx]: A tuple containing the MAD-X instances for beam 1/2 and beam 4.
        """
        # Make mad environment
        xm.make_mad_environment(links=self.links)

        # Start mad
        mad_b1b2 = Madx(command_log="mad_collider.log")
        mad_b4 = Madx(command_log="mad_b4.log")

        # Build sequences
        self.ost.build_sequence(mad_b1b2, mylhcbeam=1, beam_config=self.beam_config)
        self.ost.build_sequence(mad_b4, mylhcbeam=4, beam_config=self.beam_config)

        # Apply optics (only for b1b2, b4 will be generated from b1b2)
        self.ost.apply_optics(mad_b1b2, optics_file=self.optics)

        if self.sanity_checks:
            mad_b1b2.use(sequence="lhcb1")
            mad_b1b2.twiss()
            self.ost.check_madx_lattices(mad_b1b2)
            mad_b1b2.use(sequence="lhcb2")
            mad_b1b2.twiss()
            self.ost.check_madx_lattices(mad_b1b2)

        # Apply optics (only for b4, just for check)
        self.ost.apply_optics(mad_b4, optics_file=self.optics)
        if self.sanity_checks:
            mad_b4.use(sequence="lhcb2")
            mad_b4.twiss()
            # ! Investigate why this is failing for run III
            try:
                self.ost.check_madx_lattices(mad_b4)
            except AssertionError:
                logging.warning("Some sanity checks have failed during the madx lattice check")

        return mad_b1b2, mad_b4

    def build_collider(self, mad_b1b2: Madx, mad_b4: Madx) -> xt.Multiline:
        """
        Build an xsuite collider using provided MAD-X sequences and configuration.

        Parameters:
        mad_b1b2 (Madx): MAD-X instance containing sequences for beam 1 and beam 2.
        mad_b4 (Madx): MAD-X instance containing sequence for beam 4.

        Returns:
        xt.Multiline: Constructed xsuite collider.

        Notes:
        - Converts `ver_lhc_run` and `ver_hllhc_optics` to float if they are not None.
        - Builds the xsuite collider with the specified sequences and configuration.
        - Optionally performs sanity checks by computing Twiss parameters for beam 1 and beam 2.
        """
        # Ensure proper types to avoid assert errors
        if self.ver_lhc_run is not None:
            self.ver_lhc_run = float(self.ver_lhc_run)
        if self.ver_hllhc_optics is not None:
            self.ver_hllhc_optics = float(self.ver_hllhc_optics)

        # Build xsuite collider
        collider = xlhc.build_xsuite_collider(
            sequence_b1=mad_b1b2.sequence.lhcb1,
            sequence_b2=mad_b1b2.sequence.lhcb2,
            sequence_b4=mad_b4.sequence.lhcb2,
            beam_config=self.beam_config,
            enable_imperfections=self.enable_imperfections,
            enable_knob_synthesis=self.enable_knob_synthesis,
            rename_coupling_knobs=self.rename_coupling_knobs,
            pars_for_imperfections=self.pars_for_imperfections,
            ver_lhc_run=self.ver_lhc_run,
            ver_hllhc_optics=self.ver_hllhc_optics,
        )
        collider.build_trackers()

        if self.sanity_checks:
            collider["lhcb1"].twiss(method="4d")
            collider["lhcb2"].twiss(method="4d")

        return collider

    def activate_RF_and_twiss(self, collider: xt.Multiline) -> None:
        """
        Activates RF and Twiss parameters for the given collider.

        This method sets the RF knobs for the collider using the values specified
        in the `phasing` attribute. It also performs sanity checks on the collider
        lattices if the `sanity_checks` attribute is set to True.

        Args:
            collider (xt.Multiline): The collider object to configure.

        Returns:
            None
        """
        # Define a RF knobs
        collider.vars["vrf400"] = self.phasing["vrf400"]
        collider.vars["lagrf400.b1"] = self.phasing["lagrf400.b1"]
        collider.vars["lagrf400.b2"] = self.phasing["lagrf400.b2"]

        if self.sanity_checks:
            for my_line in ["lhcb1", "lhcb2"]:
                self.check_xsuite_lattices(collider[my_line])

    def check_xsuite_lattices(self, line: xt.Line) -> None:
        """
        Check the Twiss parameters and tune values for a given xsuite Line object.

        This method computes the Twiss parameters for the provided `line` using the
        6-dimensional method with a specified matrix stability tolerance. It then
        prints the Twiss results at all interaction points (IPs) and the horizontal
        (Qx) and vertical (Qy) tune values.

        Args:
            line (xt.Line): The xsuite Line object for which to compute and display
                            the Twiss parameters and tune values.

        Returns:
            None
        """
        tw = line.twiss(method="6d", matrix_stability_tol=100)
        print(f"--- Now displaying Twiss result at all IPS for line {line}---")
        print(tw.rows["ip.*"])
        # print qx and qy
        print(f"--- Now displaying Qx and Qy for line {line}---")
        print(tw.qx, tw.qy)

    def write_collider_to_disk(self, collider: xt.Multiline) -> None:
        """
        Writes the collider object to disk in JSON format and optionally compresses it into a ZIP
        file.

        Args:
            collider (xt.Multiline): The collider object to be saved.

        Returns:
            None

        Raises:
            OSError: If there is an issue creating the directory or writing the file.

        Notes:
            - The method ensures that the directory specified in
                `self.path_collider_file_for_configuration_as_output` exists.
            - If `self.compress` is True, the JSON file is compressed into a ZIP file to reduce
                storage usage.
        """
        # Save collider to json, creating the folder if it does not exist
        if "/" in self.path_collider_file_for_configuration_as_output:
            os.makedirs(self.path_collider_file_for_configuration_as_output, exist_ok=True)
        collider.to_json(self.path_collider_file_for_configuration_as_output)

        # Compress the collider file to zip to ease the load on afs
        if self.compress:
            compress_and_write(self.path_collider_file_for_configuration_as_output)

    @staticmethod
    def clean_temporary_files() -> None:
        """
        Remove all the temporary files created in the process of building the collider.

        This function deletes the following files and directories:
        - "mad_collider.log"
        - "mad_b4.log"
        - "temp" directory
        - "errors"
        - "acc-models-lhc"
        """
        # Remove all the temporaty files created in the process of building collider
        os.remove("mad_collider.log")
        os.remove("mad_b4.log")
        shutil.rmtree("temp")
        os.unlink("errors")
        os.unlink("acc-models-lhc")

ost: Any property

Determines and returns the appropriate optics-specific tools (OST) based on the version of HLLHC optics or LHC run configuration.

Raises:

Type Description
ValueError

If both ver_hllhc_optics and ver_lhc_run are defined.
ValueError

If no optics-specific tools are available for the given configuration.

Returns:

Name Type Description
Any Any

The appropriate OST module based on the configuration.

__init__(configuration)

Initializes the MadCollider class with the given configuration.

Parameters:

Name Type Description Default
configuration dict

A dictionary containing the following keys: - sanity_checks (bool): Flag to enable or disable sanity checks. - links (str): Path to the links configuration. - beam_config (dict): Configuration for the beam. - optics_file (str): Path to the optics file. - enable_imperfections (bool): Flag to enable or disable imperfections. - enable_knob_synthesis (bool): Flag to enable or disable knob synthesis. - rename_coupling_knobs (bool): Flag to enable or disable renaming of coupling knobs. - pars_for_imperfections (dict): Parameters for imperfections. - ver_lhc_run (float | None): Version of the LHC run, if applicable. - ver_hllhc_optics (float | None): Version of the HL-LHC optics, if applicable. - ions (bool): Flag to indicate if ions are used. - phasing (dict): Configuration for phasing. - path_collider_file_for_configuration_as_output (str): Path to the collider. - compress (bool): Flag to enable or disable compression.

 required
Source code in study_da/generate/master_classes/mad_collider.py 
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def __init__(self, configuration: dict):
    """
    Initializes the MadCollider class with the given configuration.

    Args:
        configuration (dict): A dictionary containing the following keys:
            - sanity_checks (bool): Flag to enable or disable sanity checks.
            - links (str): Path to the links configuration.
            - beam_config (dict): Configuration for the beam.
            - optics_file (str): Path to the optics file.
            - enable_imperfections (bool): Flag to enable or disable imperfections.
            - enable_knob_synthesis (bool): Flag to enable or disable knob synthesis.
            - rename_coupling_knobs (bool): Flag to enable or disable renaming of coupling
                knobs.
            - pars_for_imperfections (dict): Parameters for imperfections.
            - ver_lhc_run (float | None): Version of the LHC run, if applicable.
            - ver_hllhc_optics (float | None): Version of the HL-LHC optics, if applicable.
            - ions (bool): Flag to indicate if ions are used.
            - phasing (dict): Configuration for phasing.
            - path_collider_file_for_configuration_as_output (str): Path to the collider.
            - compress (bool): Flag to enable or disable compression.
    """
    # Configuration variables
    self.sanity_checks: bool = configuration["sanity_checks"]
    self.links: str = configuration["links"]
    self.beam_config: dict = configuration["beam_config"]
    self.optics: str = configuration["optics_file"]
    self.enable_imperfections: bool = configuration["enable_imperfections"]
    self.enable_knob_synthesis: bool = configuration["enable_knob_synthesis"]
    self.rename_coupling_knobs: bool = configuration["rename_coupling_knobs"]
    self.pars_for_imperfections: dict = configuration["pars_for_imperfections"]
    self.ver_lhc_run: float | None = configuration["ver_lhc_run"]
    self.ver_hllhc_optics: float | None = configuration["ver_hllhc_optics"]
    self.ions: bool = configuration["ions"]
    self.phasing: dict = configuration["phasing"]

    # Optics specific tools
    self._ost = None

    # Path to disk and compression
    self.path_collider_file_for_configuration_as_output = configuration[
        "path_collider_file_for_configuration_as_output"
    ]
    self.compress = configuration["compress"]

activate_RF_and_twiss(collider)

Activates RF and Twiss parameters for the given collider.

This method sets the RF knobs for the collider using the values specified in the phasing attribute. It also performs sanity checks on the collider lattices if the sanity_checks attribute is set to True.

Parameters:

Name Type Description Default
collider Multiline

The collider object to configure.

 required

Returns:

Type Description
None

None
Source code in study_da/generate/master_classes/mad_collider.py 
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def activate_RF_and_twiss(self, collider: xt.Multiline) -> None:
    """
    Activates RF and Twiss parameters for the given collider.

    This method sets the RF knobs for the collider using the values specified
    in the `phasing` attribute. It also performs sanity checks on the collider
    lattices if the `sanity_checks` attribute is set to True.

    Args:
        collider (xt.Multiline): The collider object to configure.

    Returns:
        None
    """
    # Define a RF knobs
    collider.vars["vrf400"] = self.phasing["vrf400"]
    collider.vars["lagrf400.b1"] = self.phasing["lagrf400.b1"]
    collider.vars["lagrf400.b2"] = self.phasing["lagrf400.b2"]

    if self.sanity_checks:
        for my_line in ["lhcb1", "lhcb2"]:
            self.check_xsuite_lattices(collider[my_line])

build_collider(mad_b1b2, mad_b4)

Build an xsuite collider using provided MAD-X sequences and configuration.

Parameters: mad_b1b2 (Madx): MAD-X instance containing sequences for beam 1 and beam 2. mad_b4 (Madx): MAD-X instance containing sequence for beam 4.

Returns: xt.Multiline: Constructed xsuite collider.

Notes: - Converts ver_lhc_run and ver_hllhc_optics to float if they are not None. - Builds the xsuite collider with the specified sequences and configuration. - Optionally performs sanity checks by computing Twiss parameters for beam 1 and beam 2.

Source code in study_da/generate/master_classes/mad_collider.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def build_collider(self, mad_b1b2: Madx, mad_b4: Madx) -> xt.Multiline:
    """
    Build an xsuite collider using provided MAD-X sequences and configuration.

    Parameters:
    mad_b1b2 (Madx): MAD-X instance containing sequences for beam 1 and beam 2.
    mad_b4 (Madx): MAD-X instance containing sequence for beam 4.

    Returns:
    xt.Multiline: Constructed xsuite collider.

    Notes:
    - Converts `ver_lhc_run` and `ver_hllhc_optics` to float if they are not None.
    - Builds the xsuite collider with the specified sequences and configuration.
    - Optionally performs sanity checks by computing Twiss parameters for beam 1 and beam 2.
    """
    # Ensure proper types to avoid assert errors
    if self.ver_lhc_run is not None:
        self.ver_lhc_run = float(self.ver_lhc_run)
    if self.ver_hllhc_optics is not None:
        self.ver_hllhc_optics = float(self.ver_hllhc_optics)

    # Build xsuite collider
    collider = xlhc.build_xsuite_collider(
        sequence_b1=mad_b1b2.sequence.lhcb1,
        sequence_b2=mad_b1b2.sequence.lhcb2,
        sequence_b4=mad_b4.sequence.lhcb2,
        beam_config=self.beam_config,
        enable_imperfections=self.enable_imperfections,
        enable_knob_synthesis=self.enable_knob_synthesis,
        rename_coupling_knobs=self.rename_coupling_knobs,
        pars_for_imperfections=self.pars_for_imperfections,
        ver_lhc_run=self.ver_lhc_run,
        ver_hllhc_optics=self.ver_hllhc_optics,
    )
    collider.build_trackers()

    if self.sanity_checks:
        collider["lhcb1"].twiss(method="4d")
        collider["lhcb2"].twiss(method="4d")

    return collider

check_xsuite_lattices(line)

Check the Twiss parameters and tune values for a given xsuite Line object.

This method computes the Twiss parameters for the provided line using the 6-dimensional method with a specified matrix stability tolerance. It then prints the Twiss results at all interaction points (IPs) and the horizontal (Qx) and vertical (Qy) tune values.

Parameters:

Name Type Description Default
line Line

The xsuite Line object for which to compute and display the Twiss parameters and tune values.

 required

Returns:

Type Description
None

None
Source code in study_da/generate/master_classes/mad_collider.py 
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
def check_xsuite_lattices(self, line: xt.Line) -> None:
    """
    Check the Twiss parameters and tune values for a given xsuite Line object.

    This method computes the Twiss parameters for the provided `line` using the
    6-dimensional method with a specified matrix stability tolerance. It then
    prints the Twiss results at all interaction points (IPs) and the horizontal
    (Qx) and vertical (Qy) tune values.

    Args:
        line (xt.Line): The xsuite Line object for which to compute and display
                        the Twiss parameters and tune values.

    Returns:
        None
    """
    tw = line.twiss(method="6d", matrix_stability_tol=100)
    print(f"--- Now displaying Twiss result at all IPS for line {line}---")
    print(tw.rows["ip.*"])
    # print qx and qy
    print(f"--- Now displaying Qx and Qy for line {line}---")
    print(tw.qx, tw.qy)

clean_temporary_files() staticmethod

Remove all the temporary files created in the process of building the collider.

This function deletes the following files and directories: - "mad_collider.log" - "mad_b4.log" - "temp" directory - "errors" - "acc-models-lhc"

Source code in study_da/generate/master_classes/mad_collider.py 
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
@staticmethod
def clean_temporary_files() -> None:
    """
    Remove all the temporary files created in the process of building the collider.

    This function deletes the following files and directories:
    - "mad_collider.log"
    - "mad_b4.log"
    - "temp" directory
    - "errors"
    - "acc-models-lhc"
    """
    # Remove all the temporaty files created in the process of building collider
    os.remove("mad_collider.log")
    os.remove("mad_b4.log")
    shutil.rmtree("temp")
    os.unlink("errors")
    os.unlink("acc-models-lhc")

prepare_mad_collider()

Prepares the MAD-X collider environment and sequences for beam 1/2 and beam 4.

This method performs the following steps: 1. Creates the MAD-X environment using the provided links. 2. Initializes MAD-X instances for beam 1/2 and beam 4 with respective command logs. 3. Builds the sequences for both beams using the provided beam configuration. 4. Applies the specified optics to the beam 1/2 sequence. 5. Optionally performs sanity checks on the beam 1/2 sequence by running TWISS and checking the MAD-X lattices. 6. Applies the specified optics to the beam 4 sequence. 7. Optionally performs sanity checks on the beam 4 sequence by running TWISS and checking the MAD-X lattices.

Returns:

Type Description
tuple[Madx, Madx]

tuple[Madx, Madx]: A tuple containing the MAD-X instances for beam 1/2 and beam 4.
Source code in study_da/generate/master_classes/mad_collider.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
def prepare_mad_collider(self) -> tuple[Madx, Madx]:
    # sourcery skip: extract-duplicate-method
    """
    Prepares the MAD-X collider environment and sequences for beam 1/2 and beam 4.

    This method performs the following steps:
    1. Creates the MAD-X environment using the provided links.
    2. Initializes MAD-X instances for beam 1/2 and beam 4 with respective command logs.
    3. Builds the sequences for both beams using the provided beam configuration.
    4. Applies the specified optics to the beam 1/2 sequence.
    5. Optionally performs sanity checks on the beam 1/2 sequence by running TWISS and checking
        the MAD-X lattices.
    6. Applies the specified optics to the beam 4 sequence.
    7. Optionally performs sanity checks on the beam 4 sequence by running TWISS and checking
        the MAD-X lattices.

    Returns:
        tuple[Madx, Madx]: A tuple containing the MAD-X instances for beam 1/2 and beam 4.
    """
    # Make mad environment
    xm.make_mad_environment(links=self.links)

    # Start mad
    mad_b1b2 = Madx(command_log="mad_collider.log")
    mad_b4 = Madx(command_log="mad_b4.log")

    # Build sequences
    self.ost.build_sequence(mad_b1b2, mylhcbeam=1, beam_config=self.beam_config)
    self.ost.build_sequence(mad_b4, mylhcbeam=4, beam_config=self.beam_config)

    # Apply optics (only for b1b2, b4 will be generated from b1b2)
    self.ost.apply_optics(mad_b1b2, optics_file=self.optics)

    if self.sanity_checks:
        mad_b1b2.use(sequence="lhcb1")
        mad_b1b2.twiss()
        self.ost.check_madx_lattices(mad_b1b2)
        mad_b1b2.use(sequence="lhcb2")
        mad_b1b2.twiss()
        self.ost.check_madx_lattices(mad_b1b2)

    # Apply optics (only for b4, just for check)
    self.ost.apply_optics(mad_b4, optics_file=self.optics)
    if self.sanity_checks:
        mad_b4.use(sequence="lhcb2")
        mad_b4.twiss()
        # ! Investigate why this is failing for run III
        try:
            self.ost.check_madx_lattices(mad_b4)
        except AssertionError:
            logging.warning("Some sanity checks have failed during the madx lattice check")

    return mad_b1b2, mad_b4

write_collider_to_disk(collider)

Writes the collider object to disk in JSON format and optionally compresses it into a ZIP file.

Parameters:

Name Type Description Default
collider Multiline

The collider object to be saved.

 required

Returns:

Type Description
None

None

Raises:

Type Description
OSError

If there is an issue creating the directory or writing the file.
Notes
  • The method ensures that the directory specified in self.path_collider_file_for_configuration_as_output exists.
  • If self.compress is True, the JSON file is compressed into a ZIP file to reduce storage usage.
Source code in study_da/generate/master_classes/mad_collider.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
def write_collider_to_disk(self, collider: xt.Multiline) -> None:
    """
    Writes the collider object to disk in JSON format and optionally compresses it into a ZIP
    file.

    Args:
        collider (xt.Multiline): The collider object to be saved.

    Returns:
        None

    Raises:
        OSError: If there is an issue creating the directory or writing the file.

    Notes:
        - The method ensures that the directory specified in
            `self.path_collider_file_for_configuration_as_output` exists.
        - If `self.compress` is True, the JSON file is compressed into a ZIP file to reduce
            storage usage.
    """
    # Save collider to json, creating the folder if it does not exist
    if "/" in self.path_collider_file_for_configuration_as_output:
        os.makedirs(self.path_collider_file_for_configuration_as_output, exist_ok=True)
    collider.to_json(self.path_collider_file_for_configuration_as_output)

    # Compress the collider file to zip to ease the load on afs
    if self.compress:
        compress_and_write(self.path_collider_file_for_configuration_as_output)