xcoll 0.5.8__tar.gz → 0.7.1__tar.gz

{xcoll-0.5.8 → xcoll-0.7.1}/PKG-INFO

@@ -1,29 +1,33 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: xcoll
-Version: 0.5.8
+Version: 0.7.1
 Summary: Xsuite collimation package
-Home-page: https://github.com/xsuite/xcoll
-License: Apache 2.0
+License: Apache-2.0
 Author: Frederik F. Van der Veken
 Author-email: frederik@cern.ch
-Requires-Python: >=3.8
-Classifier: License :: Other/Proprietary License
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: tests
 Requires-Dist: numpy (>=1.0)
 Requires-Dist: pandas (>=1.4)
-Requires-Dist: ruamel-yaml (>=0.17.31,<0.18.0) ; extra == "tests"
-Requires-Dist: xdeps (>=0.1.1)
-Requires-Dist: xfields (>=0.12.1)
-Requires-Dist: xobjects (>=0.2.6)
-Requires-Dist: xpart (>=0.15.0)
-Requires-Dist: xtrack (>=0.36.5)
+Requires-Dist: pytest ; extra == "tests"
+Requires-Dist: pytest-html ; extra == "tests"
+Requires-Dist: pytest-xdist ; extra == "tests"
+Requires-Dist: ruamel-yaml (>=0.17.31,<0.18.15)
+Requires-Dist: xdeps (>=0.10.8)
+Requires-Dist: xobjects (>=0.5.6)
+Requires-Dist: xpart (>=0.23.2)
+Requires-Dist: xtrack (>=0.95.0)
+Project-URL: Bug Tracker, https://github.com/xsuite/xsuite/issues
+Project-URL: Documentation, https://xsuite.readthedocs.io/
+Project-URL: Homepage, https://github.com/xsuite/xcoll
 Project-URL: Repository, https://github.com/xsuite/xcoll
+Project-URL: download, https://pypi.python.org/pypi/xcoll
 Description-Content-Type: text/markdown
 
 # xcoll
@@ -52,6 +56,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

{xcoll-0.5.8 → xcoll-0.7.1}/README.md

@@ -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

xcoll-0.7.1/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "xcoll"
+version = "0.7.1"
+description = "Xsuite collimation package"
+authors = [
+    {name="Frederik F. Van der Veken", email="frederik@cern.ch"},
+    {name="Simone O. Solstrand",       email="simone.otelie.solstrand@cern.ch"},
+    {name="Björn Lindstrom",           email="bjorn.lindstrom@cern.ch"},
+    {name="Giacomo Broggi",            email="giacomo.broggi@cern.ch"},
+    {name="André Donadon Servelle",    email="andre.donadon.servelle@cern.ch"},
+    {name="Dora E. Veres",             email="dora.erzsebet.veres@cern.ch"},
+    {name="Despina Demetriadou",       email="despina.demetriadou@cern.ch"},
+    {name="Andrey Abramov",            email="andrey.abramov@cern.ch"},
+    {name="Giovanni Iadarola",         email="giovanni.iadarola@cern.ch"}
+]
+readme = "README.md"
+license = {text="Apache-2.0"}
+
+requires-python = ">=3.10"
+
+dependencies = [
+    "ruamel-yaml (>=0.17.31,<0.18.15)",
+    "numpy>=1.0",
+    "pandas>=1.4",
+    "xobjects>=0.5.6",
+    "xdeps>=0.10.8",
+    "xpart>=0.23.2",
+    "xtrack>=0.95.0",
+]
+
+[project.optional-dependencies]
+tests = ["pytest", "pytest-html", "pytest-xdist"]
+
+[project.urls]
+homepage = "https://github.com/xsuite/xcoll"
+repository = "https://github.com/xsuite/xcoll"
+documentation = "https://xsuite.readthedocs.io/"
+"Bug Tracker" = "https://github.com/xsuite/xsuite/issues"
+download = "https://pypi.python.org/pypi/xcoll"
+
+[project.entry-points.xobjects]
+include = "xcoll"
+
+[tool.poetry]
+exclude = ["xcoll/lib", "xcoll/config"]
+
+[poetry.group.dev.dependencies]
+pytest = ">=7.3"
+xaux = ">=0.3.10"
+
+[build-system]
+# Needed for pip install -e (BTW: need pip version 22)
+requires = ["poetry-core>=2.0"]
+build-backend = "poetry.core.masonry.api"
+
+# pyproject.toml
+#[tool.pytest.ini_options]
+#addopts = "-ra --durations=10 --durations-min=1"
+#python_functions = ["test_"]
+#testpaths = [
+#    "tests",
+#]
+

xcoll-0.7.1/xcoll/__init__.py

@@ -0,0 +1,26 @@
+# copyright ############################### #
+# This file is part of the Xcoll package.   #
+# Copyright (c) CERN, 2025.                 #
+# ######################################### #
+
+from .general import _pkg_root, __version__, citation
+
+from .beam_elements import BlackAbsorber, BlackCrystal, TransparentCollimator, TransparentCrystal, \
+                           EverestBlock, EverestCollimator, EverestCrystal, Geant4Collimator, Geant4Crystal, \
+                           BlowUp, EmittanceMonitor, collimator_classes, crystal_classes, element_classes
+from .materials import Material, CrystalMaterial, RefMaterial
+from .scattering_routines.geant4 import Geant4Engine
+from .colldb import CollimatorDatabase
+from .interaction_record import InteractionRecord
+from .rf_sweep import RFSweep, prepare_rf_sweep
+from .lossmap import LossMap, MultiLossMap
+from .particles_tree import ParticlesTree
+
+from .constants import particle_states, particle_state_names, interactions, interaction_names
+
+# Initialise Geant4 environment
+from .scattering_routines.geant4.wrapper import Geant4Wrapper as _Geant4Wrapper
+geant4 = _Geant4Wrapper()
+
+# print("If you use Xcoll in your simulations, please cite us :-)")
+# print(citation)

{xcoll-0.5.8 → xcoll-0.7.1}/xcoll/beam_elements/__init__.py

@@ -5,7 +5,9 @@
 
 from .base import BaseBlock, BaseCollimator, BaseCrystal
 from .absorber import BlackAbsorber, BlackCrystal
+from .transparent import TransparentCollimator, TransparentCrystal
 from .everest import EverestBlock, EverestCollimator, EverestCrystal
+from .geant4 import Geant4Collimator, Geant4Crystal
 from .blowup import BlowUp
 from .monitor import EmittanceMonitor
 

{xcoll-0.5.8 → xcoll-0.7.1}/xcoll/beam_elements/absorber.py

@@ -16,11 +16,16 @@ class BlackAbsorber(BaseCollimator):
     }
 
     isthick = True
+    needs_rng = False
     allow_track = True
+    allow_double_sided = True
     behaves_like_drift = True
+    allow_rot_and_shift = False
+    allow_loss_refinement = True
     skip_in_loss_location_refinement = True
 
-    _depends_on = [BaseCollimator, XcollGeometry]
+    _noexpr_fields = BaseCollimator._noexpr_fields
+    _depends_on    = [BaseCollimator, XcollGeometry]
 
     _extra_c_sources = [
         _pkg_root.joinpath('beam_elements','elements_src','black_absorber.h')
@@ -47,11 +52,16 @@ class BlackCrystal(BaseCrystal):
     }
 
     isthick = True
+    needs_rng = False
     allow_track = True
+    allow_double_sided = False
     behaves_like_drift = True
+    allow_rot_and_shift = False
+    allow_loss_refinement = True
     skip_in_loss_location_refinement = True
 
-    _depends_on = [BaseCrystal, XcollGeometry]
+    _noexpr_fields = BaseCrystal._noexpr_fields
+    _depends_on    = [BaseCrystal, XcollGeometry]
 
     _extra_c_sources = [
         _pkg_root.joinpath('beam_elements','elements_src','black_crystal.h')