xcoll 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

xcoll/scattering_routines/geant4/collimasim/tests/resources/CollDB_old_example.dat

@@ -0,0 +1,68 @@
+# Database for cleaning insertion collimators. Prepared:  23 Jun 2021
+6
+
+#
+TCP.A.B1
+tcp.a.b1
+    10
+C
+0.6
+0
+0.0000000000000000
+  647.6350305671534
+  53.02571504616053
+
+#
+TCP.B.B1
+tcp.b.b1
+    80
+C
+0.6
+1.5707963267948966
+0.0000000000000000
+  603.3821034080673
+  58.54786181209406
+
+#
+TCS.B1.B1
+tcs.b1.b1
+    89.5
+C
+1.0
+1.5707963267948966
+0.0000000000000000
+  290.63093200994945
+  154.51051797015745
+
+#
+TCS.A1.B1
+tcs.a1.b1
+    11.5
+C
+1.0
+0
+0.0000000000000000
+  73.34173975049991
+  390.8874328919145
+
+#
+TCS.A2.B1
+tcs.a2.b1
+    11.5
+C
+1.0
+0
+0.0000000000000000
+  465.66698081057984
+  488.78492630379634
+
+#
+TCS.B2.B1
+tcs.b2.b1
+    89.5
+C
+1.0
+1.5707963267948966
+0.0000000000000000
+  1783.19687950021
+  362.409353541563

xcoll/scattering_routines/geant4/collimasim/tests/resources/CollDB_testing.dat

@@ -0,0 +1,15 @@
+# Automatically converted collimator DB from old format file 'CollDB_HL.data'
+# Families
+NSIG_FAM dummy                 5.000000 PRIMARY
+#
+# Collimators
+# name                                                opening/fam mat.     length[m]    angle[deg]     offset[m]    
+coll_open                                                  90      W       10.00000      0.000000      0.000000
+coll_skew                                                 dummy    W       0.60000       45.000000      0.000000
+coll_skew_tilted                                          dummy    W       0.60000       45.000000      0.000000
+#
+
+#ONESIDED dummy1 1
+TILTED coll_skew_tilted 4 -9
+# Additional Collimator Settings
+SETTINGS

xcoll/scattering_routines/geant4/collimasim/tests/resources/CollDB_yaml_example.yaml

@@ -0,0 +1,110 @@
+%YAML 1.2
+---
+# Each collimator is a dictionary, with the following set of keys:
+#   required keys:
+#       gap [sigma], length [m], angle [deg], material [BE/AL/CU/W/PB/C/C2/Si/Ge/MoGR/CuCD/Mo/Glid/Iner/VA/BL], stage
+#       (a gap equal to 'null' disables the collimator from tracking)
+#   optional keys:
+#       offset [m], onesided [left/right], tilt [deg] (or tilt_left and tilt_right if different for each jaw)
+#   special keys:
+#       active [bool] : Whether or not a collimator is still active in operation. If false, the gap is set to null.
+#                       The difference with just manually setting the gap to 'null' is mainly semantic: these are collimators that are in principle no longer used but still present in the machine.
+#       crystal [strip/quasi-mosaic] : Use when the collimator is a crystal of the specified type.
+#                       It allows for some extra keys: bend [m], xdim [m], ydim [m], miscut [deg], thick [m] (the thickness of the amorphous layer)
+# 
+# For ease of use, the collimators can be collected in families using standard YAML syntax.
+# Each family contains the keys for which all members have the same value (though keys can be overwritten again in the individual collimators).
+#
+# YAML syntax refresher:
+#   - indentation matters (spaces, no tabs)
+#   - comments are preceded with #
+#   - lists are represented by one item per line preceded with a dash, or in inline format as [ , ... ]
+#   - dictoraries are represented by one "key : value" per line, or in inline format as { key : value , ... }
+#   - the & represents a unique name tag
+#   - the * dereferences the named element
+#   - the merge operator << merges the subsequent element with the surrounding container (giving higher priority to the other elements in the container than those in the merged element, as to allow overwriting)
+Families:
+  # Momentum cleaning
+  - &TCP3    { gap: 15,    stage: primary,    material: C,     length: 0.6                }
+  - &TCSG3   { gap: 18,    stage: secondary,  material: C,     length: 1                  }
+  - &TCLA3   { gap: 20,    stage: tertiary,   material: Iner,  length: 1                  }
+  # Betatron cleaning
+  - &TCP7    { gap: 5,     stage: primary,    material: C,     length: 0.6                }
+  - &TCSG7   { gap: 6.5,   stage: secondary,  material: C,     length: 1                  }
+  - &TCLA7   { gap: 10,    stage: tertiary,   material: Iner,  length: 1                  }
+  - &CRY7    { gap: null,  stage: special,    material: Si,    length: 0.004,             onesided: left,  crystal: strip }
+  # Injection protection
+  - &TCLI    { gap: null,  stage: tertiary,   material: C,     length: 1,      angle: 90  }
+  - &TDI     { gap: null,  stage: tertiary,   material: CU,    length: 1.565,  angle: 90  }
+  # Dump protection
+  - &TCDQ    { gap: 7.3,   stage: tertiary,   material: C,     length: 3,      angle: 0,  onesided: left }
+  - &TCSP    { gap: 7.3,   stage: secondary,  material: C,     length: 1,      angle: 0   }
+  # Physics background minimalisation
+  - &TCT15   { gap: 8.5,   stage: tertiary,   material: Iner,  length: 1                  }
+  - &TCT2    { gap: 37,    stage: tertiary,   material: Iner,  length: 1                  }
+  - &TCT8    { gap: 15,    stage: tertiary,   material: Iner,  length: 1                  }
+  # Physics debris
+  - &TCL4    { gap: 17,    stage: tertiary,   material: CU,    length: 1,      angle: 0   }
+  - &TCL5    { gap: 42,    stage: tertiary,   material: CU,    length: 1,      angle: 0   }
+  - &TCL6    { gap: 20,    stage: tertiary,   material: Iner,  length: 1,      angle: 0   }
+  # Physics debris in ALICE (only for ions)
+  - &TCLD    { gap: null,  stage: tertiary,   material: Iner,  length: 0.6,    angle: 0   }
+
+Collimators:
+  tcl.4r1.b1:         { <<: *TCL4                   }
+  tcl.5r1.b1:         { <<: *TCL5                   }
+  tcl.6r1.b1:         { <<: *TCL6                   }
+  tctph.4l2.b1:       { <<: *TCT2,   angle:   0     }
+  tctpv.4l2.b1:       { <<: *TCT2,   angle:  90     }
+  tdisa.a4l2.b1:      { <<: *TDI                    }
+  tdisb.a4l2.b1:      { <<: *TDI                    }
+  tdisc.a4l2.b1:      { <<: *TDI                    }
+  tclia.4r2:          { <<: *TCLI                   }
+  tclib.6r2.b1:       { <<: *TCLI                   }
+  tcld.a11r2.b1:      { <<: *TCLD                   }
+  tcp.6l3.b1:         { <<: *TCP3,   angle:   0     }
+  tcsg.5l3.b1:        { <<: *TCSG3,  angle:   0     }
+  tcsg.4r3.b1:        { <<: *TCSG3,  angle:   0     }
+  tcsg.a5r3.b1:       { <<: *TCSG3,  angle: 170.7   }
+  tcsg.b5r3.b1:       { <<: *TCSG3,  angle:  10.8   }
+  tcla.a5r3.b1:       { <<: *TCLA3,  angle:  90     }
+  tcla.b5r3.b1:       { <<: *TCLA3,  angle:   0     }
+  tcla.6r3.b1:        { <<: *TCLA3,  angle:   0     }
+  tcla.7r3.b1:        { <<: *TCLA3,  angle:   0     }
+  tctph.4l5.b1:       { <<: *TCT15,  angle:   0     }
+  tctpv.4l5.b1:       { <<: *TCT15,  angle:  90     }
+  tcl.4r5.b1:         { <<: *TCL4,                  }
+  tcl.5r5.b1:         { <<: *TCL5,                  }
+  tcl.6r5.b1:         { <<: *TCL6,                  }
+  tcdqa.a4r6.b1:      { <<: *TCDQ                   }
+  tcdqa.c4r6.b1:      { <<: *TCDQ                   }
+  tcdqa.b4r6.b1:      { <<: *TCDQ                   }
+  tcsp.a4r6.b1:       { <<: *TCSP                   }
+  tcp.d6l7.b1:        { <<: *TCP7,   angle:  90,    material: MoGR  }
+  tcp.c6l7.b1:        { <<: *TCP7,   angle:   0,    material: MoGR  }
+  tcp.b6l7.b1:        { <<: *TCP7,   angle: 127.5   }
+  tcsg.a6l7.b1:       { <<: *TCSG7,  angle: 141.1   }
+  tcpcv.a6l7.b1:      { <<: *CRY7,   angle:  90,    bend: 85.10,  xdim: 5.0e-3,  ydim: 30.0e-3  }
+  tcsg.b5l7.b1:       { <<: *TCSG7,  angle: 143.5   }
+  tcsg.a5l7.b1:       { <<: *TCSG7,  angle:  40.7   }
+  tcsg.d4l7.b1:       { <<: *TCSG7,  angle:  90,    material: MoGR  }
+  tcpch.a4l7.b1:      { <<: *CRY7,   angle:   0,    bend: 61.54,  xdim: 2.0e-3,  ydim: 50.0e-3  }
+  tcsg.b4l7.b1:       { <<: *TCSG7,  angle:   0,    active: false   }
+  tcspm.b4l7.b1:      { <<: *TCSG7,  angle:   0,    material: MoGR  }
+  tcsg.a4l7.b1:       { <<: *TCSG7,  angle: 134.6   }
+  tcsg.a4r7.b1:       { <<: *TCSG7,  angle:  46.3   }
+  tcsg.b5r7.b1:       { <<: *TCSG7,  angle: 141.5   }
+  tcsg.d5r7.b1:       { <<: *TCSG7,  angle:  51.4   }
+  tcsg.e5r7.b1:       { <<: *TCSG7,  angle: 130.5,  active: false   }
+  tcspm.e5r7.b1:      { <<: *TCSG7,  angle: 130.5,  material: MoGR  }
+  tcsg.6r7.b1:        { <<: *TCSG7,  angle:   0.5,  active: false   }
+  tcspm.6r7.b1:       { <<: *TCSG7,  angle:   0.5,  material: MoGR  }
+  tcla.a6r7.b1:       { <<: *TCLA7,  angle:  90     }
+  tcla.b6r7.b1:       { <<: *TCLA7,  angle:   0     }
+  tcla.c6r7.b1:       { <<: *TCLA7,  angle:  90     }
+  tcla.d6r7.b1:       { <<: *TCLA7,  angle:   0     }
+  tcla.a7r7.b1:       { <<: *TCLA7,  angle:   0     }
+  tctph.4l8.b1:       { <<: *TCT8,   angle:   0     }
+  tctpv.4l8.b1:       { <<: *TCT8,   angle:  90     }
+  tctph.4l1.b1:       { <<: *TCT15,  angle:   0     }
+  tctpv.4l1.b1:       { <<: *TCT15,  angle:  90     }

xcoll/scattering_routines/geant4/collimasim/tests/resources/collgaps.dat

@@ -0,0 +1,7 @@
+ # ID name  angle[rad]  betax[m]  betay[m] halfgap[m]  Material  Length[m]  sigx[m]  sigy[m] tilt1[rad] tilt2[rad] nsig
+         1 TCP.A.B1        0.0000000000E+00   6.5281394752E+02   4.9010585945E+01   9.7627267068E-03 C    6.00000E-01   9.76273E-04   2.67499E-04   0.00000E+00   0.00000E+00   1.00000E+01
+         2 TCP.B.B1        1.5707963268E+00   6.0822524919E+02   5.4577427992E+01   1.0064576620E-03 C    6.00000E-01   9.42342E-04   2.82282E-04   0.00000E+00   0.00000E+00   8.00000E+01
+         3 TCS.B1.B1       1.5707963268E+00   2.9420397502E+02   1.5419706861E+02   1.8926054435E-03 C    1.00000E+00   6.55391E-04   4.74476E-04   0.00000E+00   0.00000E+00   8.95000E+01
+         4 TCS.A1.B1       0.0000000000E+00   7.4276568013E+01   4.0505123230E+02   3.7870424602E-03 C    1.00000E+00   3.29308E-04   7.69009E-04   0.00000E+00   0.00000E+00   1.15000E+01
+         5 TCS.A2.B1       0.0000000000E+00   4.6957457165E+02   4.6632571321E+02   9.5219642278E-03 C    1.00000E+00   8.27997E-04   8.25128E-04   0.00000E+00   0.00000E+00   1.15000E+01
+         6 TCS.B2.B1       1.5707963268E+00   1.7829042624E+03   3.3656446316E+02   2.7961222487E-03 C    1.00000E+00   1.61339E-03   7.00988E-04   0.00000E+00   0.00000E+00   8.95000E+01

xcoll/scattering_routines/geant4/collimasim/tests/resources/collgaps_pyat_test.dat

@@ -0,0 +1,3 @@
+ # ID name  angle[rad]  betax[m]  betay[m] halfgap[m]  Material  Length[m]  sigx[m]  sigy[m] tilt1[rad] tilt2[rad] nsig
+         1 DUMMY1        0.0000000000E+00   0.0000E+00   0.0000E+00   0.5 C    10   0.0000E_00   0.0000E00   0.00000E+00   0.00000E+00   0.00000E+00
+         2 DUMMY2        0.0000000000E+00   0.0000E+00   0.0000E+00   0.5 C    10   0.0000E_00   0.0000E00   0.00000E+00   0.00000E+00   0.00000E+00

xcoll/scattering_routines/geant4/collimasim/tests/resources/collonly_twiss_file_example.tfs

@@ -0,0 +1,54 @@
+@ NAME             %05s "TWISS"
+@ TYPE             %05s "TWISS"
+@ SEQUENCE         %04s "RING"
+@ PARTICLE         %08s "POSITRON"
+@ MASS             %le    0.000510998950000
+@ CHARGE           %le    1.000000000000000
+@ ENERGY           %le  182.500000000715403
+@ PC               %le  182.500000000000000
+@ GAMMA            %le  357143.591000950953458
+@ KBUNCH           %le  16640.000000000000000
+@ BCURRENT         %le    0.000083528805847
+@ SIGE             %le    0.001000000000000
+@ SIGT             %le    1.000000000000000
+@ NPART            %le  170000000000.000030517578125
+@ EX               %le    0.000000001460000
+@ EY               %le    0.000000000002900
+@ ET               %le    0.001000000000000
+@ BV_FLAG          %le    1.000000000000000
+@ LENGTH           %le  97756.072632636380149
+@ ALFA             %le    0.000007256715763
+@ ORBIT5           %le   -0.000000000000000
+@ GAMMATR          %le  371.218783908525609
+@ Q1               %le  389.088569617840676
+@ Q2               %le  390.213002389969859
+@ DQ1              %le   -1.845008895784288
+@ DQ2              %le    1.533678430906169
+@ DXMAX            %le    0.544565677826365
+@ DYMAX            %le   -0.000000000000000
+@ XCOMAX           %le    0.000000000000000
+@ YCOMAX           %le    0.000000000000000
+@ BETXMAX          %le  2039.398467490436815
+@ BETYMAX          %le  6519.403287053469285
+@ XCORMS           %le    0.000000000000000
+@ YCORMS           %le    0.000000000000000
+@ DXRMS            %le    0.123614301552443
+@ DYRMS            %le    0.000000000000000
+@ DELTAP           %le    0.000000000000000
+@ SYNCH_1          %le    0.000000000000000
+@ SYNCH_2          %le    0.000000000000000
+@ SYNCH_3          %le    0.000000000000000
+@ SYNCH_4          %le    0.000000000000000
+@ SYNCH_5          %le    0.000000000000000
+@ TITLE            %08s "no-title"
+@ ORIGIN           %16s "5.07.00 Linux 64"
+@ DATE             %08s "23/06/21"
+@ TIME             %08s "16.08.47"
+* NAME               KEYWORD                              S                   L                  KS                 KSL                 K0L                 K1L                 K2L                 K3L                 K4L                 K1S                 K2S                 K3S                 K4S               HKICK               VKICK                BETX                BETY                ALFX                ALFY                 MUX                 MUY                  DX                  DY                 DPX                 DPY                 R11                 R12                 R22                 R21                   X                  PX                   Y                  PY                   T                  PT              DELTAP                VOLT                 LAG              HARMON                FREQ                  E1                  E2 APERTYPE                        APER_1              APER_2              APER_3              APER_4                TILT               ANGLE ASSEMBLY_ID            MECH_SEP 
+$ %s                 %s                                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le %s                                 %le                 %le                 %le                 %le                 %le                 %le         %d                 %le 
+ "TCP.A.B1"          "COLLIMATOR"        42541.376398806176439   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 652.813947518136274  49.010585945401552   4.541691920251642  -0.493263766065989 173.086386348444279 173.850167284495114   0.023338170729623   0.000000000000000   0.000666633297901   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000
+ "TCP.B.B1"          "COLLIMATOR"        42546.376398806176439   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 608.225249188530825  54.577427992180525   4.376047745669433  -0.620104643289806 173.087649244941503 173.865577811466409   0.026671337219128   0.000000000000000   0.000666633297901   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000
+ "TCS.B1.B1"         "COLLIMATOR"        42589.196398806168872   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 294.203975019690972 154.197068613860750   2.957471034547644  -1.706369915834384 173.103787433333309 173.942868849018424   0.055216575035242   0.000000000000000   0.000666633297901   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000
+ "TCS.A1.B1"         "COLLIMATOR"        42641.986398806169746   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000  74.276568013352502 405.051232303137340   1.208600064424512  -3.045555897563467 173.161906278398959 173.976742541729180   0.060001365420669   0.000000000000000  -0.000000035887419   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000
+ "TCS.A2.B1"         "COLLIMATOR"        42981.816398806171492   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 469.574571650545693 466.325713210186848   0.164867047878529  -1.845236100523997 173.504790441722747 174.220951873264738   0.069017034496271   0.000000000000000  -0.000506292509020   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000
+ "TCS.B2.B1"         "COLLIMATOR"        43287.656398806175275   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 1782.904262438686828 336.564463162150616  -6.796028267745501   2.699560767425571 173.588052793438322 174.285524754832295  -0.103874114678722   0.000000000000000  -0.000647935219349   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000

xcoll/scattering_routines/geant4/collimasim/tests/resources/settings.gmad

@@ -0,0 +1,3 @@
+beam, particle="e+", momentum=182.5*GeV;
+!option, physicsList = "em";
+option, physicsList = "g4FTFP_BERT";

xcoll/scattering_routines/geant4/collimasim/tests/resources/settings_black_absorber.gmad

@@ -0,0 +1,3 @@
+beam, particle="e+", momentum=182.5*GeV;
+option, physicsList = "em";
+option, collimatorsAreInfiniteAbsorbers=1;

xcoll/scattering_routines/geant4/collimasim/tests/resources/settings_ions.gmad

@@ -0,0 +1,5 @@
+! Dummy example - Pb208 at 450 Z GeV
+beam, particle="ion 208 82", momentum=36900*GeV;
+option, physicsList = "em decay muon hadronic_elastic ftfp_bert ion ion_elastic ion_em_dissociation";
+option, minimumKineticEnergy=40*GeV;
+option, physicsEnergyLimitHigh=600000;

xcoll/scattering_routines/geant4/collimasim/tests/resources/twiss_file_testing.tfs

@@ -0,0 +1,51 @@
+@ NAME             %05s "TWISS"
+@ TYPE             %05s "TWISS"
+@ SEQUENCE         %04s "RING"
+@ PARTICLE         %08s "POSITRON"
+@ MASS             %le    0.000510998950000
+@ CHARGE           %le    1.000000000000000
+@ ENERGY           %le  182.500000000715403
+@ PC               %le  182.500000000000000
+@ GAMMA            %le  357143.591000950953458
+@ KBUNCH           %le  16640.000000000000000
+@ BCURRENT         %le    0.000083528805847
+@ SIGE             %le    0.001000000000000
+@ SIGT             %le    1.000000000000000
+@ NPART            %le  170000000000.000030517578125
+@ EX               %le    0.000000001460000
+@ EY               %le    0.000000000002900
+@ ET               %le    0.001000000000000
+@ BV_FLAG          %le    1.000000000000000
+@ LENGTH           %le  97756.072632636380149
+@ ALFA             %le    0.000007256715763
+@ ORBIT5           %le   -0.000000000000000
+@ GAMMATR          %le  371.218783908525609
+@ Q1               %le  389.088569617840676
+@ Q2               %le  390.213002389969859
+@ DQ1              %le   -1.845008895784288
+@ DQ2              %le    1.533678430906169
+@ DXMAX            %le    0.544565677826365
+@ DYMAX            %le   -0.000000000000000
+@ XCOMAX           %le    0.000000000000000
+@ YCOMAX           %le    0.000000000000000
+@ BETXMAX          %le  2039.398467490436815
+@ BETYMAX          %le  6519.403287053469285
+@ XCORMS           %le    0.000000000000000
+@ YCORMS           %le    0.000000000000000
+@ DXRMS            %le    0.123614301552443
+@ DYRMS            %le    0.000000000000000
+@ DELTAP           %le    0.000000000000000
+@ SYNCH_1          %le    0.000000000000000
+@ SYNCH_2          %le    0.000000000000000
+@ SYNCH_3          %le    0.000000000000000
+@ SYNCH_4          %le    0.000000000000000
+@ SYNCH_5          %le    0.000000000000000
+@ TITLE            %08s "no-title"
+@ ORIGIN           %16s "5.07.00 Linux 64"
+@ DATE             %08s "23/06/21"
+@ TIME             %08s "16.08.47"
+* NAME               KEYWORD                              S                   L                  KS                 KSL                 K0L                 K1L                 K2L                 K3L                 K4L                 K1S                 K2S                 K3S                 K4S               HKICK               VKICK                BETX                BETY                ALFX                ALFY                 MUX                 MUY                  DX                  DY                 DPX                 DPY                 R11                 R12                 R22                 R21                   X                  PX                   Y                  PY                   T                  PT              DELTAP                VOLT                 LAG              HARMON                FREQ                  E1                  E2 APERTYPE                        APER_1              APER_2              APER_3              APER_4                TILT               ANGLE ASSEMBLY_ID            MECH_SEP 
+$ %s                 %s                                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le                 %le %s                                 %le                 %le                 %le                 %le                 %le                 %le         %d                 %le 
+"COLL_OPEN"          "COLLIMATOR"        42531.376398806176439   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000           1000000              1000000   4.541691920251642  -0.493263766065989 173.086386348444279 173.850167284495114   0.023338170729623   0.000000000000000   0.000666633297901   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000           0   0.000000000000000
+"COLL_SKEW"          "COLLIMATOR"        42541.376398806176439   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000           1000000              1000000   4.541691920251642  -0.493263766065989 173.086386348444279 173.850167284495114   0.023338170729623   0.000000000000000   0.000666633297901   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.2000000000000   0.000000000000000   0.30000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000
+"COLL_SKEW_TILTED"   "COLLIMATOR"        42551.376398806176439   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000           1000000              1000000   4.541691920251642  -0.493263766065989 173.086386348444279 173.850167284495114   0.023338170729623   0.000000000000000   0.000666633297901   0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000  -0.000000000000000   0.2000000000000   0.000000000000000   0.30000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000 "CIRCLE"              0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000   0.000000000000000          0   0.000000000000000

xcoll/scattering_routines/geant4/collimasim/tests/test_pyat.py

@@ -0,0 +1,65 @@
+import numpy as np
+
+import collimasim
+
+
+def test_pyat_object():
+    # Initialise a code interface - in this case the interface to pyAT
+    g4link = collimasim.PyATInterface(bdsimConfigFile="resources/settings.gmad", referencePdgId=-11, referenceEk=182.4994890018054,
+                                    relativeEnergyCut=0.001, seed=1993)
+
+    # Add collimators to the Geant4 model
+    # Collimators are made of block jaws and are prepared individually in cells, surrounded by a perfect absorber
+    # When a collimator is selected, the beam particles start at the beginning of the cell and are extracted at the end
+    g4link.addCollimator(name="TESTCOLL1", material="C", length=0.6, aperture=0.1, rotation=0, xOffset=0, yOffset=0, jawTiltLeft=0, jawTiltRight=0, side=0)
+    g4link.addCollimator("TESTCOLL2", "C", 0.6, 0.1, np.pi/2, 0, 0, 0, 0, 0)
+
+
+    # Define some test particles
+    #r = np.array([0.1, 0.001, 0.1, 0.001, 0, 0])
+    r = np.array([0.0, 0., 0.0, 0., 0., 0.])
+    r2 = np.array([0.051, 0., 0.051, 0., 0., 0.])
+    r3 = np.array([0.0, 0., 0., 0., 0., 0.])
+
+    # Add the particles to the model
+    g4link.addParticle(r)
+    g4link.addParticle(r2)
+    g4link.addParticle(r3)
+
+    # Select a collimator
+    g4link.selectCollimator("TESTCOLL1")
+
+    # Perform the Geant4 simulation
+    g4link.collimate()
+
+    # Collect the surviving particles - an n x 6 array where n is the number of surviving particles
+    arr_out = g4link.collimateReturn()
+
+    # For lost particles, all coordinates are NaN
+    # print(arr_out) # Debug
+    print(f"Pass {1}, Output size: {int(len(arr_out)/6)}, Active particles: {int(np.count_nonzero(~np.isnan(arr_out))/6)}")
+
+    # Repeat the collimator pass a few times
+    for k in range(10):
+        g4link.clearData()
+
+        # Add the particles to the model
+        for i in range(0, len(arr_out), 6):
+            g4link.addParticle(arr_out[i:i+6])
+
+        # Select a collimator
+        g4link.selectCollimator("TESTCOLL1")
+
+        # Perform the Geant4 simulation
+        g4link.collimate()
+
+        # Collect the surviving particles - an n x 6 array where n is the number of surviving particles
+        arr_out = g4link.collimateReturn()
+
+        # print(arr_out) # Debug
+        print(f"Pass {k+2}, Output size: {int(len(arr_out)/6)}, Active particles: {int(np.count_nonzero(~np.isnan(arr_out))/6)}")
+
+    assert int(np.count_nonzero(~np.isnan(arr_out))/6) == 1
+
+if __name__ == "__main__":
+    test_pyat_object()

xcoll/scattering_routines/geant4/collimasim/tests/test_pyat_passmethod.py

@@ -0,0 +1,59 @@
+from at import elements, lattice_pass
+from at import atpass, elements
+from at.lattice import Lattice
+from at import Element, lattice_pass
+from at import set_shift, set_tilt
+
+# It is assumed that the pyCollimatorPass module is in pyAT
+from at.integrators import pyCollimatorPass
+
+import numpy
+
+
+def test_multiple_particles_collimator_pass():
+    # Initialise the Geant4 interface
+    pyCollimatorPass.initialise(bdsim_config_file="resources/settings.gmad",
+                                collimator_info="resources/collgaps.dat",
+                                reference_pdg_id=-11,
+                                reference_Ek=182.4994890018054,
+                                relative_energy_cut=0.3,
+                                seed=1991)
+
+
+    # Prepare the collimators in the lattice. The pass method must be specified as
+    # pyCollimatorPass and the name must match a collimator defined in BDSIM
+    lattice = [
+               elements.Drift('drift_upstream', 0.6, PassMethod='pyDriftPass'),
+               elements.Element('TCP.A.B1', Length=0.6, PassMethod='pyCollimatorPass'),
+               elements.Element('TCP.B.B1', Length=0.6, PassMethod='pyCollimatorPass'),
+               elements.Drift('drift_downstream', 0.6)
+    ]
+
+    # Track 5 test particles
+    rin = numpy.zeros((6, 5))
+
+    rin[0, 0] = 9.762728e-3  # particle one offset in x
+    rin[2, 1] = 10e-3  # particle two offset in y
+    rin[2, 2] = 2e-3
+    rin[2, 3] = 0.5e-3
+    # The 5th particle is on the reference orbit
+
+    r_original = numpy.copy(rin)
+    r_out = lattice_pass(lattice, rin, nturns=1, refpts=range(len(lattice)))
+
+    columns=["x", "px", "y", "py", "delta", "ct"]
+    final_values = {}
+    for i, var in enumerate(columns):
+        final_values[var] = r_out[i, :, -1, -1]
+
+    print("final values:\n")
+    per_particle = list(zip(final_values['x'], final_values['y'], final_values['px'], final_values['py'], final_values['delta'], final_values['ct']))
+    for pp in per_particle:
+        print(pp)
+
+    assert(sum(numpy.isnan(r_out[0, :, -1, -1])) == 2) # Number of lost partciles
+
+
+if __name__ == "__main__":
+    test_multiple_particles_collimator_pass()
+

xcoll/scattering_routines/geant4/collimasim/tests/test_pyat_tracking.py

@@ -0,0 +1,102 @@
+import copy
+from at import elements, lattice_pass
+from at import atpass, elements
+from at.lattice import Lattice
+from at import Element, lattice_pass
+from at import set_shift, set_tilt
+
+# It is assumed that the pyCollimatorPass module is in pyAT
+from at.integrators import pyCollimatorPass
+
+import numpy
+
+def make_particles():
+    numpy.random.seed(seed=1994)
+    n_part = 1000
+    rin = numpy.array([numpy.random.uniform(-1e-3, 1e-3, n_part), 
+                       numpy.random.uniform(-1e-5, 1e-5, n_part),
+                       numpy.random.uniform(-1e-3, 1e-3, n_part),
+                       numpy.random.uniform(-1e-5, 1e-5, n_part),
+                       numpy.random.uniform(-1e-2, 1e-2, n_part),
+                       #numpy.zeros(n_part),
+                       numpy.random.uniform(-1e-4, 1e-4, n_part),
+                       #numpy.zeros(n_part),
+                       ])
+
+    return rin
+
+
+def run_particles_g4(rin):
+    numpy.random.seed(seed=1994)
+
+    # Initialise the Geant4 interface
+    pyCollimatorPass.initialise(bdsim_config_file="resources/settings_black_absorber.gmad",
+                                collimator_info="resources/collgaps_pyat_test.dat",
+                                reference_pdg_id=-11,
+                                reference_Ek=182.4994890018054,
+                                relative_energy_cut=0.3,
+                                seed=1991)
+
+
+    # Prepare the collimators in the lattice. The pass method must be specified as
+    # pyCollimatorPass and the name must match a collimator defined in BDSIM
+    lattice = [
+               elements.Element('DUMMY1', Length=10, PassMethod='pyCollimatorPass'),
+    ]
+
+    r_original = numpy.copy(rin)
+    r_out = lattice_pass(lattice, rin, nturns=1, refpts=range(len(lattice)))
+
+    columns=["x", "px", "y", "py", "delta", "ct"]
+    final_values = {}
+    for i, var in enumerate(columns):
+        #final_values[var] = r_out[i, :, -1, -1]
+        final_values[var] = rin[i]
+
+    return final_values
+
+def run_particles_drift(rin):
+    lattice = [
+               elements.Drift('DRIFT1', 10),
+    ]
+
+    r_original = numpy.copy(rin)
+    r_out = lattice_pass(lattice, rin, nturns=1, refpts=range(len(lattice)))
+
+    #r_out_dr = lattice_pass(lattice2, r_original, nturns=1, refpts=range(len(lattice2)))
+
+    columns=["x", "px", "y", "py", "delta", "ct"]
+    final_values = {}
+    for i, var in enumerate(columns):
+        #final_values[var] = r_out[i, :, -1, -1]
+        final_values[var] = rin[i]
+
+    return final_values
+
+def test_pyat_tracking():
+    rin = make_particles()
+    rin1 = copy.deepcopy(rin)
+    rin2 = copy.deepcopy(rin)
+
+    final_values_g4 = run_particles_g4(rin1)
+    final_values_dr = run_particles_drift(rin2)
+
+    # BDSIM tracks trough some geometry padding now, which is not corrected for now
+    # so use a bad tolerance of 1e-6 for all coordinates over 10 m of drift
+    # TODO: investigate
+
+    all_close = True
+    columns=["x", "px", "y", "py", "delta", "ct"]
+    for var in columns:
+        atol = 1e-6
+        rtol = 1e-5
+        var_close = numpy.all(numpy.isclose(final_values_dr[var], final_values_g4[var], atol=atol, rtol=rtol))
+        all_close &= var_close
+
+        print("Var {}: {}".format(var, var_close))
+
+    assert all_close
+
+
+if __name__ == "__main__":
+    test_pyat_tracking()

xcoll/scattering_routines/geant4/collimasim/tests/test_xtrack.py

@@ -0,0 +1,75 @@
+import numpy as np
+import xtrack as xt
+import xpart as xp
+
+import collimasim as cs
+
+
+def test_object_creation():
+    N_part = 10
+    N_max_expected_products = 10
+
+    tot_num_part = N_part
+
+    particles = xp.Particles(
+		p0c = 185.e6,
+        x = np.zeros(tot_num_part),
+		y = np.zeros(tot_num_part),
+		zeta = np.zeros(tot_num_part),
+		px = np.zeros(tot_num_part),
+		py = np.zeros(tot_num_part),
+		delta = np.zeros(tot_num_part))
+
+    particles.num_particles = N_part
+
+    particles.x[1] = 0.3
+    particles.y[2] = 0.3
+
+    g4man = cs.Geant4CollimationManager(collimator_file="resources/CollDB_old_example.dat",
+                                        bdsim_config_file="resources/settings.gmad",
+                                        tfs_file="resources/collonly_twiss_file_example.tfs",
+                                        reference_pdg_id=-11,
+                                        reference_kinetic_energy=182.4994890018054e9,
+                                        emittance_norm=(0.000521429683675842, 1.0357164949725628e-06),
+                                        relative_energy_cut=0.001,
+                                        seed=1993,
+                                        batchMode=True)
+
+    coll1 = cs.Geant4Collimator(name="tcp.a.b1", g4manager=g4man)
+    coll2 = cs.Geant4Collimator(name="tcp.b.b1", g4manager=g4man)
+
+
+    print("Particle coordinates (x) before first collimator")
+    print (particles.delta)
+
+    prods = coll1.interact(particles)
+
+    print("Particle coordinates (x) after first collimator")
+    print (particles.x)
+
+    print("="*30)
+    print("Products:")
+    for crd in prods:
+        print(crd, ":", prods[crd])
+    print("="*30)
+
+    prods = coll2.interact(particles)
+
+    print("Particle coordinates (x) after second collimator")
+    print (particles.x)
+
+    print("="*30)
+    print("Products:")
+    for crd in prods:
+        print(crd, ":", prods[crd])
+    print("="*30)
+
+    assert len(prods['x']) == 10
+
+
+def main():
+    test_object_creation()
+
+
+if __name__ == '__main__':
+    main()