xobjects 0.5.0__tar.gz → 0.5.2__tar.gz

{xobjects-0.5.0/xobjects.egg-info → xobjects-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xobjects
-Version: 0.5.0
+Version: 0.5.2
 Summary: In-memory serialization and code generator for CPU and GPU
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xobjects

xobjects-0.5.2/xobjects/_version.py

@@ -0,0 +1 @@
+__version__ = "0.5.2"

{xobjects-0.5.0 → xobjects-0.5.2}/xobjects/context.py

@@ -6,9 +6,9 @@
 import logging
 import os
 import weakref
-import xobjects as xo
 from abc import ABC, abstractmethod
 from collections import defaultdict
+from importlib.metadata import entry_points
 from pathlib import Path
 from typing import (
     Dict,
@@ -354,6 +354,26 @@ class XContext(ABC):
     ) -> Dict[Tuple[str, tuple], KernelType]:
         pass
 
+    def get_installed_c_source_paths(self) -> List[str]:
+        """Returns a list of include paths registered in dependent packages.
+
+        In a package that depends on xobjects, you can register C source paths
+        using the entry point `xobjects.c_sources`. A path to the directory
+        containing the specified module will be added to the include path when
+        building kernels. For example, the following will allow to write
+        ``#include <xtrack/path/to/some/header.h>`` in kernel sources:
+
+         .. code-block:: toml
+            [project.entry-points.xobjects]
+            include = "xtrack"
+        """
+        sources = []
+        for ep in entry_points(group="xobjects", name="include"):
+            module = ep.load()
+            path = Path(module.__file__).parents[1]
+            sources.append(str(path))
+        return sources
+
     @abstractmethod
     def nparray_to_context_array(self, arr):
         return arr

{xobjects-0.5.0 → xobjects-0.5.2}/xobjects/context_cpu.py

@@ -422,16 +422,15 @@ class ContextCpu(XContext):
             xtr_link_args.append("-fopenmp")
             xtr_compile_args.append("-DXO_CONTEXT_CPU_OPENMP")
             xtr_link_args.append("-DXO_CONTEXT_CPU_OPENMP")
-
-            # https://mac.r-project.org/openmp/
-            # on macos comment the above and uncomment the below flags to compile OpenMP with Xcode clang:
-            # xtr_compile_args.append("-Xclang")
-            # xtr_compile_args.append("-fopenmp")
-            # xtr_link_args.append("-lomp")
         else:
             xtr_compile_args.append("-DXO_CONTEXT_CPU_SERIAL")
             xtr_link_args.append("-DXO_CONTEXT_CPU_SERIAL")
 
+        extra_include_paths = self.get_installed_c_source_paths()
+        include_flags = [f"-I{path}" for path in extra_include_paths]
+        xtr_compile_args.extend(include_flags)
+        xtr_link_args.extend(include_flags)
+
         if os.name == "nt":  # windows
             # TODO: to be handled properly
             xtr_compile_args = []

{xobjects-0.5.0 → xobjects-0.5.2}/xobjects/context_cupy.py

@@ -455,7 +455,10 @@ class ContextCupy(XContext):
             with open(save_source_as, "w") as fid:
                 fid.write(specialized_source)
 
-        extra_compile_args = (*extra_compile_args, "-DXO_CONTEXT_CUDA")
+        extra_include_paths = self.get_installed_c_source_paths()
+        include_flags = [f"-I{path}" for path in extra_include_paths]
+        extra_compile_args = (*extra_compile_args, *include_flags, "-DXO_CONTEXT_CUDA")
+
         module = cupy.RawModule(
             code=specialized_source, options=extra_compile_args
         )

{xobjects-0.5.0 → xobjects-0.5.2}/xobjects/context_pyopencl.py

@@ -219,8 +219,12 @@ class ContextPyopencl(XContext):
             with open(save_source_as, "w") as fid:
                 fid.write(specialized_source)
 
+        extra_include_paths = self.get_installed_c_source_paths()
+        include_flags = [f"-I{path}" for path in extra_include_paths]
+
         extra_compile_args = (
             *extra_compile_args,
+            *include_flags,
             "-cl-std=CL2.0",
             "-DXO_CONTEXT_CL",
         )

xobjects-0.5.2/xobjects/general.py

@@ -0,0 +1,52 @@
+# copyright ################################# #
+# This file is part of the Xobjects Package.  #
+# Copyright (c) CERN, 2024.                   #
+# ########################################### #
+from numpy.testing import assert_allclose as np_assert_allclose
+import numpy as np
+
+
+class Print:
+    suppress = False
+
+    def __call__(self, *args, **kwargs):
+        if not self.suppress:
+            print(*args, **kwargs)
+
+
+_print = Print()
+
+
+def assert_allclose(a, b, rtol=0, atol=0, max_outliers=0):
+    if hasattr(a, "get"):
+        a = a.get()
+    if hasattr(b, "get"):
+        b = b.get()
+    try:
+        a = np.squeeze(a)
+    except:
+        pass
+    try:
+        b = np.squeeze(b)
+    except:
+        pass
+
+    try:
+        np_assert_allclose(a, b, rtol=rtol, atol=atol)
+    except AssertionError as e:
+        if max_outliers == 0:
+            raise e
+        if not allclose_with_outliers(a, b, rtol, atol, max_outliers):
+            raise AssertionError(
+                "Arrays are not close enough, even with outliers allowed."
+            ) from e
+
+
+def allclose_with_outliers(a, b, rtol=1e-7, atol=0, max_outliers=0):
+    a = np.asanyarray(a)
+    b = np.asanyarray(b)
+    diff = np.abs(a - b)
+    allowed = atol + rtol * np.abs(b)
+    mask = diff > allowed
+    num_outliers = np.count_nonzero(mask)
+    return num_outliers <= max_outliers

{xobjects-0.5.0 → xobjects-0.5.2/xobjects.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xobjects
-Version: 0.5.0
+Version: 0.5.2
 Summary: In-memory serialization and code generator for CPU and GPU
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xobjects

xobjects-0.5.0/xobjects/_version.py

@@ -1 +0,0 @@
-__version__ = "0.5.0"

xobjects-0.5.0/xobjects/general.py

@@ -1,33 +0,0 @@
-# copyright ################################# #
-# This file is part of the Xobjects Package.  #
-# Copyright (c) CERN, 2024.                   #
-# ########################################### #
-from numpy.testing import assert_allclose as np_assert_allclose
-import numpy as np
-
-
-class Print:
-    suppress = False
-
-    def __call__(self, *args, **kwargs):
-        if not self.suppress:
-            print(*args, **kwargs)
-
-
-_print = Print()
-
-
-def assert_allclose(a, b, rtol=1e-7, atol=1e-7):
-    if hasattr(a, "get"):
-        a = a.get()
-    if hasattr(b, "get"):
-        b = b.get()
-    try:
-        a = np.squeeze(a)
-    except:
-        pass
-    try:
-        b = np.squeeze(b)
-    except:
-        pass
-    np_assert_allclose(a, b, rtol=rtol, atol=atol)