differt-core 0.6.2__cp313-cp313t-win_amd64.whl

differt_core/__init__.py

@@ -0,0 +1,24 @@
+"""
+Core package written in Rust and re-exported here.
+
+The present package only provides lower-level utilities with
+a focus on performances.
+
+Currently, Rust uses NumPy's C API to communicate between Python
+and Rust, hence casting NumPy arrays to JAX arrays in the process,
+thus making it impossible to trace variables used in Rust code.
+
+In the future, we plan on providing XLA-compatible functions,
+so that one can use :mod:`differt_core` and still be able to differentiate
+its code. We welcome any contribution on that topic!
+"""
+
+from differt_core._differt_core import __version__ as _version
+from differt_core._differt_core import __version_info__ as _version_info
+
+__all__ = ("__version__", "__version_info__")
+
+__version__ = _version
+"""The current full version of this module."""
+__version_info__ = _version_info
+"""The current short version of this module as a tuple (major, minor, patch)."""

differt_core/_differt_core/__init__.pyi

@@ -0,0 +1,8 @@
+from types import ModuleType
+
+__version__: str
+__version_info__: tuple[int, int, int]
+
+geometry: ModuleType
+rt: ModuleType
+scene: ModuleType

differt_core/_differt_core/geometry/triangle_mesh.pyi

@@ -0,0 +1,17 @@
+# pyright: reportMissingTypeArgument=false
+import numpy as np
+from jaxtyping import Float, Int, UInt
+
+class TriangleMesh:
+    vertices: Float[np.ndarray, "num_vertices 3"]
+    triangles: UInt[np.ndarray, "num_triangles 3"]
+    face_colors: Float[np.ndarray, "num_triangles 3"] | None
+    face_materials: Int[np.ndarray, " num_triangles"] | None
+    material_names: list[str]
+    object_bounds: UInt[np.ndarray, "num_objects 2"] | None
+
+    def append(self, other: TriangleMesh) -> None: ...
+    @classmethod
+    def load_obj(cls, file: str) -> TriangleMesh: ...
+    @classmethod
+    def load_ply(cls, file: str) -> TriangleMesh: ...

differt_core/_differt_core/rt/graph.pyi

@@ -0,0 +1,104 @@
+# pyright: reportMissingTypeArgument=false
+from collections.abc import Iterator, Sized
+
+import numpy as np
+from jaxtyping import Bool, UInt
+
+class CompleteGraph:
+    @property
+    def num_nodes(self) -> int: ...
+    def __init__(self, num_nodes: int) -> None: ...
+    def all_paths(
+        self,
+        from_: int,
+        to: int,
+        depth: int,
+        *,
+        include_from_and_to: bool = True,
+    ) -> AllPathsFromCompleteGraphIter: ...
+    def all_paths_array(
+        self,
+        from_: int,
+        to: int,
+        depth: int,
+        *,
+        include_from_and_to: bool = True,
+    ) -> UInt[np.ndarray, "num_paths path_depth"]: ...
+    def all_paths_array_chunks(
+        self,
+        from_: int,
+        to: int,
+        depth: int,
+        *,
+        include_from_and_to: bool = True,
+        chunk_size: int,
+    ) -> AllPathsFromCompleteGraphChunksIter: ...
+
+class DiGraph:
+    @property
+    def num_nodes(self) -> int: ...
+    @classmethod
+    def from_adjacency_matrix(
+        cls,
+        adjacency_matrix: Bool[np.ndarray, "num_nodes num_nodes"],
+    ) -> DiGraph: ...
+    @classmethod
+    def from_complete_graph(cls, graph: CompleteGraph) -> DiGraph: ...
+    def insert_from_and_to_nodes(
+        self,
+        *,
+        direct_path: bool = True,
+        from_adjacency: Bool[np.ndarray, " num_nodes"],
+        to_adjacency: Bool[np.ndarray, " num_nodes"],
+    ) -> tuple[int, int]: ...
+    def disconnect_nodes(self, *nodes: int, fast_mode: bool = True) -> None: ...
+    def filter_by_mask(
+        self, mask: Bool[np.ndarray, " num_nodes"], fast_mode: bool = True
+    ) -> None: ...
+    def all_paths(
+        self,
+        from_: int,
+        to: int,
+        depth: int,
+        *,
+        include_from_and_to: bool = True,
+    ) -> AllPathsFromDiGraphIter: ...
+    def all_paths_array(
+        self,
+        from_: int,
+        to: int,
+        depth: int,
+        *,
+        include_from_and_to: bool = True,
+    ) -> UInt[np.ndarray, "num_paths path_depth"]: ...
+    def all_paths_array_chunks(
+        self,
+        from_: int,
+        to: int,
+        depth: int,
+        *,
+        include_from_and_to: bool = True,
+        chunk_size: int,
+    ) -> AllPathsFromDiGraphChunksIter: ...
+
+class AllPathsFromCompleteGraphIter(Iterator, Sized):
+    def __iter__(self) -> AllPathsFromCompleteGraphIter: ...
+    def __next__(self) -> UInt[np.ndarray, " path_depth"]: ...
+    def __len__(self) -> int: ...
+    def count(self) -> int: ...
+
+class AllPathsFromCompleteGraphChunksIter(Iterator, Sized):
+    def __iter__(self) -> AllPathsFromCompleteGraphChunksIter: ...
+    def __next__(self) -> UInt[np.ndarray, "chunk_size path_depth"]: ...
+    def __len__(self) -> int: ...
+    def count(self) -> int: ...
+
+class AllPathsFromDiGraphIter(Iterator):
+    def __iter__(self) -> AllPathsFromDiGraphIter: ...
+    def __next__(self) -> UInt[np.ndarray, " path_depth"]: ...
+    def count(self) -> int: ...
+
+class AllPathsFromDiGraphChunksIter(Iterator):
+    def __iter__(self) -> AllPathsFromDiGraphChunksIter: ...
+    def __next__(self) -> UInt[np.ndarray, "chunk_size path_depth"]: ...
+    def count(self) -> int: ...

differt_core/_differt_core/scene/sionna.pyi

@@ -0,0 +1,18 @@
+class SionnaScene:
+    shapes: dict[str, Shape]
+    materials: dict[str, Material]
+
+    @classmethod
+    def load_xml(cls, file: str) -> SionnaScene: ...
+
+class Material:
+    name: str
+    id: str
+    color: tuple[float, float, float]
+    thickness: float | None
+
+class Shape:
+    type: str
+    id: str
+    file: str
+    material_id: str

differt_core/_differt_core/scene/triangle_scene.pyi

@@ -0,0 +1,7 @@
+from differt_core.geometry import TriangleMesh
+
+class TriangleScene:
+    mesh: list[TriangleMesh]
+
+    @classmethod
+    def load_xml(cls, file: str) -> TriangleScene: ...

differt_core/geometry/__init__.py

@@ -0,0 +1,5 @@
+"""Geometry utilities used by :mod:`differt.geometry`."""
+
+__all__ = ("TriangleMesh",)
+
+from ._triangle_mesh import TriangleMesh

differt_core/geometry/_triangle_mesh.py

@@ -0,0 +1,5 @@
+__all__ = ("TriangleMesh",)
+
+from differt_core import _differt_core
+
+TriangleMesh = _differt_core.geometry.triangle_mesh.TriangleMesh

differt_core/rt/__init__.py

@@ -0,0 +1,19 @@
+"""Ray Tracing utilities used by :mod:`differt.rt`."""
+
+__all__ = (
+    "AllPathsFromCompleteGraphChunksIter",
+    "AllPathsFromCompleteGraphIter",
+    "AllPathsFromDiGraphChunksIter",
+    "AllPathsFromDiGraphIter",
+    "CompleteGraph",
+    "DiGraph",
+)
+
+from ._graph import (
+    AllPathsFromCompleteGraphChunksIter,
+    AllPathsFromCompleteGraphIter,
+    AllPathsFromDiGraphChunksIter,
+    AllPathsFromDiGraphIter,
+    CompleteGraph,
+    DiGraph,
+)

differt_core/rt/_graph.py

@@ -0,0 +1,19 @@
+__all__ = (
+    "AllPathsFromCompleteGraphChunksIter",
+    "AllPathsFromCompleteGraphIter",
+    "AllPathsFromDiGraphChunksIter",
+    "AllPathsFromDiGraphIter",
+    "CompleteGraph",
+    "DiGraph",
+)
+
+from differt_core import _differt_core
+
+AllPathsFromCompleteGraphChunksIter = (
+    _differt_core.rt.graph.AllPathsFromCompleteGraphChunksIter
+)
+AllPathsFromCompleteGraphIter = _differt_core.rt.graph.AllPathsFromCompleteGraphIter
+AllPathsFromDiGraphChunksIter = _differt_core.rt.graph.AllPathsFromDiGraphChunksIter
+AllPathsFromDiGraphIter = _differt_core.rt.graph.AllPathsFromDiGraphIter
+CompleteGraph = _differt_core.rt.graph.CompleteGraph
+DiGraph = _differt_core.rt.graph.DiGraph

differt_core/scene/__init__.py

@@ -0,0 +1,6 @@
+"""Scene utilities used by :mod:`differt.scene`."""
+
+__all__ = ("Material", "Shape", "SionnaScene", "TriangleScene")
+
+from ._sionna import Material, Shape, SionnaScene
+from ._triangle_scene import TriangleScene

differt_core/scene/_sionna.py

@@ -0,0 +1,7 @@
+__all__ = ("Material", "Shape", "SionnaScene")
+
+from differt_core import _differt_core
+
+Material = _differt_core.scene.sionna.Material
+Shape = _differt_core.scene.sionna.Shape
+SionnaScene = _differt_core.scene.sionna.SionnaScene

differt_core/scene/_triangle_scene.py

@@ -0,0 +1,5 @@
+__all__ = ("TriangleScene",)
+
+from differt_core import _differt_core
+
+TriangleScene = _differt_core.scene.triangle_scene.TriangleScene

differt_core-0.6.2.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: differt-core
+Version: 0.6.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: numpy>=1.20
+License-File: LICENSE.md
+Summary: Core backend of DiffeRT implemented in Rust
+Keywords: ray tracing,differentiable,propagation,radio,jax
+Author-email: Jérome Eertmans <jeertmans@icloud.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/jeertmans/DiffeRT/main/static/logo_250px.png" alt="DiffeRT logo"></img>
+</div>
+
+<div align="center">
+
+# DiffeRT-core
+
+[![Latest Release][pypi-version-badge]][pypi-version-url]
+[![Python version][pypi-python-version-badge]][pypi-version-url]
+[![Documentation][documentation-badge]][documentation-url]
+
+</div>
+
+This package contains the core backend of
+[DiffeRT](https://pypi.org/project/DiffeRT/),
+implemented in Rust for performance.
+
+As a result, both `differt` and `differt-core` will
+share the same version, and `differt` directly depends on `differt-core`.
+
+However, you can decide to only install `differt-core`
+if you want to use features that are specific to this package.
+
+The installation procedure, contributing guidelines, and documentation,
+are shared with the
+[main DiffeRT package](https://github.com/jeertmans/DiffeRT).
+
+[pypi-version-badge]: https://img.shields.io/pypi/v/DiffeRT-core?label=DiffeRT-core&color=blueviolet
+[pypi-version-url]: https://pypi.org/project/DiffeRT-core/
+[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT-core?color=orange
+[documentation-badge]: https://readthedocs.org/projects/differt/badge/?version=latest
+[documentation-url]: https://differt.readthedocs.io/latest/?badge=latest
+

differt_core-0.6.2.dist-info/RECORD

@@ -0,0 +1,20 @@
+differt_core-0.6.2.dist-info/METADATA,sha256=I2SY08Q1W7-4AIdq5GiegDA-hQns2MUs5zHUHVkkkhE,2301
+differt_core-0.6.2.dist-info/WHEEL,sha256=7SSRyEUTl0G9zfHvzn9DJvB7X-BB1oG59c0jvPwLmgU,97
+differt_core-0.6.2.dist-info/licenses/LICENSE.md,sha256=IYiRvvMH922nW-enFUx36Wp1OaGDVd8B9EV9ickkRG4,1099
+differt_core/__init__.py,sha256=VqWgA_MyNn9Uj6BFbykarD-SSMadbzvV0ZyZ7KoCcbo,927
+differt_core/_differt_core.cp313t-win_amd64.pyd,sha256=rkDLFJCcUwl9Ni769Iz90ultbl_D2mpv74FyNOYTzO4,1079296
+differt_core/_differt_core/__init__.pyi,sha256=zwAH6jyd7mY_BhcqOJX_-4YV4eOxUflN2c9wcUB5AoQ,149
+differt_core/_differt_core/geometry/triangle_mesh.pyi,sha256=gCL1XmfqUuJCbLrcJ3svvqAKP5dvb27JB1zMQzlcIZs,650
+differt_core/_differt_core/rt/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+differt_core/_differt_core/rt/graph.pyi,sha256=X31JmnjbXe9j7WgI9syrxkGCTeciBWtr69o-MSByIJM,3254
+differt_core/_differt_core/scene/sionna.pyi,sha256=1B6T9QX3z_2FAuSlMNdogyLkz1fRflc2QeekVZPqIx4,356
+differt_core/_differt_core/scene/triangle_scene.pyi,sha256=Arp_KWBw2W7YAoccLUHbYOu17I6u3IERz7x7Mr4kTTU,178
+differt_core/geometry/__init__.py,sha256=4wErUp7LhmeLX07bacsjxMCgYsIegRSm-mSKsrfO-6k,134
+differt_core/geometry/_triangle_mesh.py,sha256=Ft204gsMb5xrMFWoMjkA4urrCXIMB_0vTAdXPe696Mc,139
+differt_core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+differt_core/rt/__init__.py,sha256=ZqStqeyQiaNH0V7MEfuq2BOo7CIqtsUNW7NW50DTMbk,470
+differt_core/rt/_graph.py,sha256=0IwKaAbSVYhM2eHKk6W8GQjhxjkC6IeImb6KncWIxNU,700
+differt_core/scene/__init__.py,sha256=Lt9sU9N4bFCTThk2MFl5RnP2hlI4posOp0tH-abDm-Y,217
+differt_core/scene/_sionna.py,sha256=SEJqfcn1Al5aOGE7m0w4LVzQRI22Hio4j3MlXPnntbM,236
+differt_core/scene/_triangle_scene.py,sha256=gUknDq7MgFikzlV5pM0U_ttw6Iqni190dvbk7WzSIUA,140
+differt_core-0.6.2.dist-info/RECORD,,

differt_core-0.6.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.6)
+Root-Is-Purelib: false
+Tag: cp313-cp313t-win_amd64

differt_core-0.6.2.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2024 Jérome Eertmans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.