Merge pull request #109 from xsuite/release/v0.5.5

freddieknets · web-flow · commit 09d7e0afefad · 2024-10-10T11:36:22.000+02:00
Release 0.5.5
diff --git a/examples/everest_collimator.py b/examples/everest_collimator.py
@@ -47,7 +47,7 @@
 
 
 # Assign the optics to deduce the gap settings
-xc.assign_optics_to_collimators(line=line)
+line.collimators.assign_optics()
 
 
 # --------------------------------------------------------
@@ -71,9 +71,9 @@
 
 # Track
 print("Tracking first test.. ")
-xc.enable_scattering(line)
+line.scattering.enable()
 line.track(part, num_turns=1)
-xc.disable_scattering(line)
+line.scattering.disable()
 
 # Sort the particles by their ID
 part.sort(interleave_lost_particles=True)
@@ -100,7 +100,7 @@
 # oscillations would make the cut profile symmetric anyway.
 
 line['tcp.c6l7.b1'].angle = 15
-xc.open_collimators(line)
+line.collimators.open()
 line['tcp.c6l7.b1'].gap = [4, -7]
 
 # Create initial particles
@@ -111,9 +111,9 @@
 
 # Track
 print("Tracking second test.. ")
-xc.enable_scattering(line)
+line.scattering.enable()
 line.track(part, num_turns=1)
-xc.disable_scattering(line)
+line.scattering.disable()
 
 # Sort the particles by their ID
 part.sort(interleave_lost_particles=True)
diff --git a/examples/impact_table.py b/examples/impact_table.py
diff --git a/examples/impacts.py b/examples/impacts.py
@@ -12,10 +12,10 @@
 # ============================================
 
 # Get line and collimators
-line = xt.Line.from_json(xc._pkg_root / '..' / 'examples' / 'machines' / 'lhc_run3_b1.json')
+line = xt.Line.from_json(xc._pkg_root.parent / 'examples' / 'machines' / 'lhc_run3_b1.json')
 
-coll_manager = xc.CollimatorDatabase.from_yaml(xc._pkg_root / '..' / 'examples' / 'colldb' / 'lhc_run3.yaml', beam=1)
-coll_manager.install_everest_collimators(verbose=True, line=line)
+colldb = xc.CollimatorDatabase.from_yaml(xc._pkg_root.parent / 'examples' / 'colldb' / 'lhc_run3.yaml', beam=1)
+colldb.install_everest_collimators(verbose=True, line=line)
 df_with_coll = line.check_aperture()
 assert not np.any(df_with_coll.has_aperture_problem)
 
@@ -24,22 +24,22 @@
 
 # Build tracker, assign optics and generate particles 
 line.build_tracker()
-xc.assign_optics_to_collimators(line=line)
+line.collimators.assign_optics()
 part = xc.generate_pencil_on_collimator(line, 'tcp.d6l7.b1', 50000)
 
 # This is not needed, but is done here so that we can track with 12 treads.
 line.discard_tracker()
 line.build_tracker(_context=xo.ContextCpu(omp_num_threads=12))
 
 # Track
-xc.enable_scattering(line)
+line.scattering.enable()
 line.track(part, num_turns=20, time=True, with_progress=1)
-xc.disable_scattering(line)
+line.scattering.disable()
 line.discard_tracker()
 impacts.stop()
 
 df = impacts.to_pandas()
-df.to_csv('impacts.csv', index=False)
+df.to_csv('impacts_line.csv', index=False)
 
 # ============================================
 # With collimator 
@@ -59,7 +59,7 @@
 part.sort(interleave_lost_particles=True)
 
 df = impacts_coll.to_pandas()
-df[df.interaction_type == 'Enter Jaw L'].to_csv('Enter_Jaw_L.csv', index=False)
+df[df.interaction_type == 'Enter Jaw L'].to_csv('impacts_coll_enter_jaw_L.csv', index=False)
 
 # ============================================
 # With crystal
@@ -80,4 +80,4 @@
 
 impacts_crystal.to_pandas()
 df_crystal = impacts_crystal.interactions_per_collimator()
-df_crystal.to_csv('interactions_per_crystal.csv', index=False)
+df_crystal.to_csv('impacts_crystal_interactions.csv', index=False)
diff --git a/examples/lhc_run3_lossmap.py b/examples/lhc_run3_lossmap.py
@@ -51,7 +51,7 @@
 
 
 # Assign the optics to deduce the gap settings
-xc.assign_optics_to_collimators(line=line)
+line.collimators.assign_optics()
 
 
 # Optimise the line
@@ -70,9 +70,9 @@
 
 
 # Track!
-xc.enable_scattering(line)
+line.scattering.enable()
 line.track(part, num_turns=num_turns, time=True, with_progress=1)
-xc.disable_scattering(line)
+line.scattering.disable()
 print(f"Done tracking in {line.time_last_track:.1f}s.")
 
 
diff --git a/examples/lhc_run3_lossmap_with_blowup.py b/examples/lhc_run3_lossmap_with_blowup.py
@@ -67,7 +67,7 @@
 
 # Assign the optics to deduce the gap settings, and calibrate the ADT
 tw = line.twiss()
-xc.assign_optics_to_collimators(line=line, twiss=tw)
+line.collimators.assign_optics(twiss=tw)
 if plane == 'H':
     adt.calibrate_by_emittance(nemitt=nemitt_x, twiss=tw)
 else:
@@ -90,11 +90,11 @@
 
 
 # Track!
-xc.enable_scattering(line)
+line.scattering.enable()
 adt.activate()
 line.track(part, num_turns=num_turns, time=True, with_progress=1)
 adt.deactivate()
-xc.disable_scattering(line)
+line.scattering.disable()
 print(f"Done tracking in {line.time_last_track:.1f}s.")
 
 
diff --git a/examples/lhc_run3_lossmap_with_crystals.py b/examples/lhc_run3_lossmap_with_crystals.py
@@ -58,7 +58,7 @@
 
 
 # Assign the optics to deduce the gap settings
-xc.assign_optics_to_collimators(line=line)
+line.collimators.assign_optics()
 
 # Apply settings
 line[tcpc].bending_angle = 40.e-6
@@ -91,9 +91,9 @@
 
 
 # Track!
-xc.enable_scattering(line)
+line.scattering.enable()
 line.track(part, num_turns=num_turns, time=True, with_progress=1)
-xc.disable_scattering(line)
+line.scattering.disable()
 print(f"Done tracking in {line.time_last_track:.1f}s.")
 
 
diff --git a/examples/lhc_run3_offmomentum_lossmap.py b/examples/lhc_run3_offmomentum_lossmap.py
@@ -56,7 +56,7 @@
 
 
 # Assign the optics to deduce the gap settings
-xc.assign_optics_to_collimators(line=line)
+line.collimators.assign_optics()
 
 
 # Optimise the line
@@ -81,9 +81,9 @@
 
 
 # Track during RF sweep:
-xc.enable_scattering(line)
+line.scattering.enable()
 rf_sweep.track(sweep=sweep, particles=part, num_turns=num_turns, time=True, with_progress=5)
-xc.disable_scattering(line)
+line.scattering.disable()
 print(f"Done sweeping RF in {line.time_last_track:.1f}s.")
 
 
diff --git a/examples/transfer_line_with_air.py b/examples/transfer_line_with_air.py
@@ -64,7 +64,7 @@
 line.build_tracker()
 
 # Scattering need to be disabled to be able to twiss
-xc.disable_scattering(line)
+line.scattering.disable()
 
 # Matched initial parameters
 betx0 = 154.0835045206266
@@ -90,7 +90,7 @@
 
 # Track!
 # ======
-xc.enable_scattering(line)
+line.scattering.enable()
 line.track(part)
 print("Done Tracking!")
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xcoll"
-version = "0.5.4"
+version = "0.5.5"
 description = "Xsuite collimation package"
 homepage = "https://github.com/xsuite/xcoll"
 repository = "https://github.com/xsuite/xcoll"
diff --git a/tests/data/all_tests.list b/tests/data/all_tests.list
diff --git a/tests/test__list_tests.py b/tests/test__list_tests.py
@@ -1,7 +1,9 @@
 import pytest
 import contextlib
 import os
+from pathlib import Path
 
+path = Path(__file__).parent / 'data'
 
 def _collect_tests():
     # Create a list to store the collected test names
@@ -24,7 +26,7 @@ def pytest_collection_modifyitems(self, session, config, items):
 
 def test_listing():
     current_tests = _collect_tests()
-    with open('all_tests.list', 'r') as fid:
+    with open(path / 'all_tests.list', 'r') as fid:
         expected_tests = set([line.replace('\n', '') for line in fid.readlines()])
     only_current = current_tests.difference(expected_tests)
     only_expected = expected_tests.difference(current_tests)
diff --git a/tests/test__regenerate_kernels.py b/tests/test__regenerate_kernels.py
@@ -3,9 +3,6 @@
 # Copyright (c) CERN, 2024.                 #
 # ######################################### #
 
-import warnings
-
-from xsuite.kernel_definitions import kernel_definitions
 from xsuite.prebuild_kernels import regenerate_kernels
 
 
diff --git a/tests/test_elements.py b/tests/test_elements.py
@@ -224,7 +224,7 @@
     {'field': 'lattice', 'val': 111,            'expected': {'_orient': 2}}
 ]
 everest_crystal_user_fields = base_crystal_user_fields
-everest_crystal_user_fields_read_only = base_crystal_user_fields_read_only
+everest_crystal_user_fields_read_only = [*base_crystal_user_fields_read_only, 'critical_radius', 'critical_angle']
 
 
 
diff --git a/tests/test_impacts.py b/tests/test_impacts.py
@@ -36,14 +36,14 @@ def test_impacts_from_line(beam, plane, test_context):
     impacts = xc.InteractionRecord.start(line=line, record_impacts=True, record_exits=True)
     line.build_tracker(_context=test_context)
 
-    xc.assign_optics_to_collimators(line=line)
+    line.collimators.assign_optics()
     tcp  = f"tcp.{'c' if plane=='H' else 'd'}6{'l' if beam==1 else 'r'}7.b{beam}"
     tw = line.twiss()
     part = xc.generate_pencil_on_collimator(line, tcp, num_particles=num_part, twiss=tw)
 
-    xc.enable_scattering(line)
+    line.scattering.enable()
     line.track(part, num_turns=num_turns, time=True, with_progress=1)
-    xc.disable_scattering(line)
+    line.scattering.disable()
 
     df = impacts.to_pandas()
     types = np.unique(df.interaction_type)
diff --git a/tests/test_initial_distribution.py b/tests/test_initial_distribution.py
@@ -38,7 +38,7 @@ def test_create_initial_distribution(beam, npart,impact_parameter, pencil_spread
 
     colldb.install_everest_collimators(line=line)
     line.build_tracker()
-    xc.assign_optics_to_collimators(line=line)
+    line.collimators.assign_optics()
 
     tw = line.twiss()
     tcp_conv = f"tcp.c6{'l' if beam == 1 else 'r'}7.b{beam}"
diff --git a/tests/test_lossmap.py b/tests/test_lossmap.py
@@ -37,14 +37,14 @@ def test_run_lossmap(beam, plane, npart, interpolation, ignore_crystals, test_co
     assert not np.any(df_with_coll.has_aperture_problem)
 
     line.build_tracker(_context=test_context)
-    xc.assign_optics_to_collimators(line=line)
+    line.collimators.assign_optics()
 
     tcp  = f"tcp.{'c' if plane=='H' else 'd'}6{'l' if beam==1 else 'r'}7.b{beam}"
     part = xc.generate_pencil_on_collimator(line, tcp, num_particles=npart)
 
-    xc.enable_scattering(line)
+    line.scattering.enable()
     line.track(part, num_turns=2)
-    xc.disable_scattering(line)
+    line.scattering.disable()
 
     line_is_reversed = True if beam == 2 else False
     with flaky_assertions():
diff --git a/tests/test_transfer_line.py b/tests/test_transfer_line.py
@@ -27,9 +27,9 @@ def test_transfer_line(test_context):
     assert xt.line._dicts_equal(line["Air 2"].material.to_dict(), air.to_dict())
     _add_monitors(line)
     line.build_tracker(_context=test_context)
-    xc.disable_scattering(line)  # Scattering need to be disabled to be able to twiss
+    line.scattering.disable()  # Scattering need to be disabled to be able to twiss
     part = _generate_matched_particles(line)
-    xc.enable_scattering(line)   # Re-enable scattering
+    line.scattering.enable()   # Re-enable scattering
     line.track(part)
     nemitt_x = np.array([el.nemitt_x for el in line.get_elements_of_type(xc.EmittanceMonitor)[0]])
     nemitt_y = np.array([el.nemitt_y for el in line.get_elements_of_type(xc.EmittanceMonitor)[0]])
diff --git a/tests/test_version.py b/tests/test_version.py
@@ -6,4 +6,4 @@
 from xcoll import __version__
 
 def test_version():
-    assert __version__ == '0.5.4'
+    assert __version__ == '0.5.5'
diff --git a/xcoll/general.py b/xcoll/general.py
@@ -12,5 +12,5 @@
 # ======================
 # Do not change
 # ======================
-__version__ = '0.5.4'
+__version__ = '0.5.5'
 # ======================
diff --git a/xcoll/line_tools.py b/xcoll/line_tools.py
