Merge pull request #165 from xsuite/release/v0.7.0

Release 0.7.0

Author: freddieknets

.gitignore

@@ -1,6 +1,7 @@
 xcoll/lib
 xcoll/config
-
+tests/assets/
+tests/pytest*results.html
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -19,6 +20,8 @@ downloads/
 eggs/
 .eggs/
 lib/
+!xcoll/scattering_routines/geant4/collimasim/lib/
+!xcoll/scattering_routines/geant4/collimasim/lib/pybind11/
 lib64/
 parts/
 sdist/

.gitmodules

@@ -24,6 +24,8 @@ Collimation in xtrack simulations
     * pandas
     * xsuite (in particular xobjects, xdeps, xtrack, xpart)
 
+* Geant4 and BDSIM: conda install bdsim-g4 -c conda-forge
+
 ### Installing
 `xcoll` is packaged using `poetry`, and can be easily installed with `pip`:
 ```bash

README.md

@@ -5,6 +5,7 @@
 
 import numpy as np
 import matplotlib.pyplot as plt
+from pathlib import Path
 import time
 start_time = time.time()
 
@@ -13,6 +14,9 @@
 import xpart as xp
 import xcoll as xc
 
+path = Path(__file__).parent
+
+
 # This example is a more realistic example of the ADT in the LHC. Each
 # particle in a bunch gets the same kick (this is the default for a BlowUp).
 # Note that this realistic behaviour shakes the beam around at every pass:
@@ -37,7 +41,7 @@
 
 
 # Import a Run 3 LHC lattice without apertures
-line = xt.Line.from_json(xc._pkg_root.parent / 'examples' / 'machines' / f'lhc_run3_b{beam}_no_aper.json')
+line = xt.Line.from_json(path / 'machines' / f'lhc_run3_b{beam}_no_aper.json')
 
 
 # Create the ADT

examples/adt.py

@@ -5,6 +5,7 @@
 
 import numpy as np
 import matplotlib.pyplot as plt
+from pathlib import Path
 import time
 start_time = time.time()
 
@@ -13,6 +14,9 @@
 import xpart as xp
 import xcoll as xc
 
+path = Path(__file__).parent
+
+
 # This example is a simplified example of the ADT in the LHC. Each
 # particle gets a different kick, randomly sampled. This allows for
 # a quicker and more controlled emittance growth (though less realistic).
@@ -27,7 +31,7 @@
 
 
 # Import a Run 3 LHC lattice without apertures
-line = xt.Line.from_json(xc._pkg_root.parent / 'examples' / 'machines' / f'lhc_run3_b{beam}_no_aper.json')
+line = xt.Line.from_json(path / 'machines' / f'lhc_run3_b{beam}_no_aper.json')
 
 
 # Create the ADT

examples/adt_simplified.py

@@ -28,20 +28,20 @@ All:
 
 families:
   # Momentum cleaning
-  - &TCP3    { <<: *ALL,  gap: 15,    stage: primary,    material: C,     length: 0.6    }
-  - &TCSG3   { <<: *ALL,  gap: 18,    stage: secondary,  material: C,     length: 1      }
+  - &TCP3    { <<: *ALL,  gap: 15,    stage: primary,    material: CFC,   length: 0.6    }
+  - &TCSG3   { <<: *ALL,  gap: 18,    stage: secondary,  material: CFC,   length: 1      }
   - &TCLA3   { <<: *ALL,  gap: 20,    stage: tertiary,   material: Iner,  length: 1      }
   # Betatron cleaning
-  - &TCP7    { <<: *ALL,  gap: 5,     stage: primary,    material: C,     length: 0.6    }
-  - &TCSG7   { <<: *ALL,  gap: 6.5,   stage: secondary,  material: C,     length: 1      }
+  - &TCP7    { <<: *ALL,  gap: 5,     stage: primary,    material: CFC,   length: 0.6    }
+  - &TCSG7   { <<: *ALL,  gap: 6.5,   stage: secondary,  material: CFC,   length: 1      }
   - &TCLA7   { <<: *ALL,  gap: 10,    stage: tertiary,   material: Iner,  length: 1      }
   - &CRY7    { <<: *ALL,  gap: null,  stage: special,    material: Si,    length: 0.004, side: left,  crystal: strip, active: false }
   # Injection protection
-  - &TCLI    { <<: *ALL,  gap: null,  stage: tertiary,   material: C,     length: 1,     angle: 90 }
+  - &TCLI    { <<: *ALL,  gap: null,  stage: tertiary,   material: CFC,   length: 1,     angle: 90 }
   - &TDI     { <<: *ALL,  gap: null,  stage: tertiary,   material: CU,    length: 1.565, angle: 90 }
   # Dump protection
-  - &TCDQ    { <<: *ALL,  gap: 7.3,   stage: tertiary,   material: C,     length: 3,     angle: 0,  side: left }
-  - &TCSP    { <<: *ALL,  gap: 7.3,   stage: secondary,  material: C,     length: 1,     angle: 0 }
+  - &TCDQ    { <<: *ALL,  gap: 7.3,   stage: tertiary,   material: CFC,   length: 3,     angle: 0,  side: left }
+  - &TCSP    { <<: *ALL,  gap: 7.3,   stage: secondary,  material: CFC,   length: 1,     angle: 0 }
   # Triplet protection
   - &TCT15   { <<: *ALL,  gap: 8.5,   stage: tertiary,   material: Iner,  length: 1,     parking: 0.020 }
   - &TCT2    { <<: *ALL,  gap: 37,    stage: tertiary,   material: Iner,  length: 1,     }

examples/colldb/lhc_run3.yaml

@@ -28,20 +28,20 @@ All:
 
 families:
   # Momentum cleaning
-  - &TCP3    { <<: *ALL,  gap: 15,    stage: primary,    material: C,     length: 0.6    }
-  - &TCSG3   { <<: *ALL,  gap: 18,    stage: secondary,  material: C,     length: 1      }
+  - &TCP3    { <<: *ALL,  gap: 15,    stage: primary,    material: CFC,   length: 0.6    }
+  - &TCSG3   { <<: *ALL,  gap: 18,    stage: secondary,  material: CFC,   length: 1      }
   - &TCLA3   { <<: *ALL,  gap: 20,    stage: tertiary,   material: Iner,  length: 1      }
   # Betatron cleaning
-  - &TCP7    { <<: *ALL,  gap: 6,     stage: primary,    material: C,     length: 0.6    }
-  - &TCSG7   { <<: *ALL,  gap: 6.5,   stage: secondary,  material: C,     length: 1      }
+  - &TCP7    { <<: *ALL,  gap: 6,     stage: primary,    material: CFC,   length: 0.6    }
+  - &TCSG7   { <<: *ALL,  gap: 6.5,   stage: secondary,  material: CFC,   length: 1      }
   - &TCLA7   { <<: *ALL,  gap: 8,     stage: tertiary,   material: Iner,  length: 1      }
   - &CRY7    { <<: *ALL,  gap: 5,     stage: special,    material: Si,    length: 0.004, side: left,  crystal: strip, active: true}
   # Injection protection
-  - &TCLI    { <<: *ALL,  gap: null,  stage: tertiary,   material: C,     length: 1,     angle: 90 }
+  - &TCLI    { <<: *ALL,  gap: null,  stage: tertiary,   material: CFC,   length: 1,     angle: 90 }
   - &TDI     { <<: *ALL,  gap: null,  stage: tertiary,   material: CU,    length: 1.565, angle: 90 }
   # Dump protection
-  - &TCDQ    { <<: *ALL,  gap: 7.3,   stage: tertiary,   material: C,     length: 3,     angle: 0,  side: left }
-  - &TCSP    { <<: *ALL,  gap: 7.3,   stage: secondary,  material: C,     length: 1,     angle: 0 }
+  - &TCDQ    { <<: *ALL,  gap: 7.3,   stage: tertiary,   material: CFC,   length: 3,     angle: 0,  side: left }
+  - &TCSP    { <<: *ALL,  gap: 7.3,   stage: secondary,  material: CFC,   length: 1,     angle: 0 }
   # Triplet protection
   - &TCT15   { <<: *ALL,  gap: 9.5,   stage: tertiary,   material: Iner,  length: 1,     parking: 0.020 }
   - &TCT2    { <<: *ALL,  gap: 37,    stage: tertiary,   material: Iner,  length: 1,     }

examples/colldb/lhc_run3_crystals.yaml

@@ -1,5 +1,5 @@
 # name       opening/fam mat.  length[m] angle[deg] offset[m]
-tcp.6l3.b1          15.0 C           0.6        0.0        0.
+tcp.6l3.b1          15.0 CFC         0.6        0.0        0.
 tcp.d6l7.b1          5.0 MoGR        0.6       90.0        0.
 tcp.c6l7.b1          5.0 MoGR        0.6        0.0        0.
-tcp.b6l7.b1          5.0 C           0.6      127.5        0.
+tcp.b6l7.b1          5.0 CFC         0.6      127.5        0.

examples/colldb/lhc_tcp_b1.dat

@@ -4,6 +4,7 @@
 # ######################################### #
 
 import numpy as np
+from pathlib import Path
 import matplotlib.pyplot as plt
 
 import xobjects as xo
@@ -22,7 +23,7 @@
 # context = xo.ContextPyopencl()  # For OpenCL GPUs
 
 beam = 1
-path_in  = xc._pkg_root.parent / 'examples'
+path_in = Path(__file__).parent
 
 
 # Load from json

examples/everest_collimator.py

@@ -0,0 +1,57 @@
+import numpy as np
+import xpart as xp
+import xtrack as xt
+import xtrack.particles.pdg as pdg
+import xcoll as xc
+from  xcoll import constants as xcs
+import time
+
+import matplotlib.pyplot as plt
+
+
+if xc.geant4.engine.is_running():
+    xc.geant4.engine.stop()
+
+
+# Make some Geant4 and Everest collimators to preload materials
+g4_colls = []
+ev_colls = []
+for material in ['Air', 'Water', 'Beryllium', 'MoGR', 'Inermet180']:
+    for length in [1.e-3, 2.e-2, 0.1, 0.4, 1]:
+        g4_colls.append(xc.Geant4Collimator(length=length, material=material, jaw=0.001))
+        ev_colls.append(xc.EverestCollimator(length=length, material=material, jaw=0.001))
+
+
+# Start the engine
+xc.geant4.engine.particle_ref = xt.Particles('proton', p0c=6.8e12)
+xc.geant4.engine.start(elements=g4_colls, clean=True, verbose=False)
+
+
+# Create an initial distribution of particles
+num_part   = 5000
+x_init     = np.random.normal(loc=0.05, scale=0.2e-3, size=num_part)
+px_init    = np.random.normal(loc=0.,   scale=5.e-6,  size=num_part)
+y_init     = np.random.normal(loc=0.,   scale=1e-3,   size=num_part)
+py_init    = np.random.normal(loc=0.,   scale=5.e-6,  size=num_part)
+zeta_init  = np.random.normal(loc=0.,   scale=1.e-2,  size=num_part)
+delta_init = np.random.normal(loc=0.,   scale=5.e-4,  size=num_part)
+part_init = xp.build_particles(x=x_init, px=px_init, y=y_init, py=py_init,
+                               zeta=zeta_init, delta=delta_init,
+                               particle_ref=xc.geant4.engine.particle_ref,
+                               _capacity=num_part*2)
+
+for ev_coll, g4_coll in zip(ev_colls, g4_colls):
+    print(f"\nBenchmarking collimator: length={g4_coll.length} m, material={g4_coll.material.name}")
+    # Copy initial particles for each collimator
+    part = part_init.copy()
+    print(f"    Tracking {num_part} protons with Everest...  ", end='', flush=True)
+    start = time.time()
+    ev_coll.track(part)
+    print(f"Done in {(time.time()-start)*1000:.3}ms. Dead: {np.sum((part.state < 1) & (part.state > -999999))}. "
+          f"Alive: {np.sum(part.state == 1)}", flush=True)
+    part = part_init.copy()
+    print(f"    Tracking {num_part} protons with Geant4...   ", end='', flush=True)
+    start = time.time()
+    g4_coll.track(part)
+    print(f"Done in {time.time()-start:.3}s. Dead: {np.sum((part.state < 1) & (part.state > -999999))}. "
+          f"Alive: {np.sum(part.state == 1)}", flush=True)