differt-core 0.0.16__tar.gz → 0.0.18__tar.gz

{differt_core-0.0.16 → differt_core-0.0.18}/Cargo.lock

@@ -238,9 +238,10 @@ checksum = "7a81dae078cea95a014a339291cec439d2f232ebe854a9d672b796c6afafa9b7"
 
 [[package]]
 name = "differt-core"
-version = "0.0.16"
+version = "0.0.18"
 dependencies = [
  "criterion",
+ "indexmap",
  "log",
  "nalgebra",
  "ndarray",
@@ -260,6 +261,12 @@ version = "1.11.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a47c1c47d2f5964e29c61246e81db715514cd532db6b5116a25ea3c03d6780a2"
 
+[[package]]
+name = "equivalent"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5"
+
 [[package]]
 name = "errno"
 version = "0.3.8"
@@ -396,6 +403,12 @@ dependencies = [
  "crunchy",
 ]
 
+[[package]]
+name = "hashbrown"
+version = "0.14.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
+
 [[package]]
 name = "heck"
 version = "0.4.1"
@@ -408,6 +421,17 @@ version = "0.3.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d231dfb89cfffdbc30e7fc41579ed6066ad03abda9e567ccafae602b97ec5024"
 
+[[package]]
+name = "indexmap"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68b900aa2f7301e21c36462b170ee99994de34dff39a4a6a528e80e7376d07e5"
+dependencies = [
+ "equivalent",
+ "hashbrown",
+ "serde",
+]
+
 [[package]]
 name = "indoc"
 version = "2.0.5"
@@ -765,6 +789,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a5e00b96a521718e08e03b1a622f01c8a8deb50719335de3f60b3b3950f069d8"
 dependencies = [
  "cfg-if",
+ "indexmap",
  "indoc",
  "libc",
  "memoffset",

{differt_core-0.0.16 → differt_core-0.0.18}/Cargo.toml

@@ -2,6 +2,11 @@
 debug = true
 strip = false
 
+[profile.profiling]
+debug = true
+inherits = "release"
+strip = false
+
 [profile.release]
 codegen-units = 1
 lto = "fat"

{differt_core-0.0.16 → differt_core-0.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: differt-core
-Version: 0.0.16
+Version: 0.0.18
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -12,7 +12,7 @@ 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
+Requires-Dist: numpy >=1.20, <2
 License-File: LICENSE.md
 Summary: Core backend of DifffeRT implemented in Rust
 Keywords: ray tracing,differentiable,propagation,radio,jax

{differt_core-0.0.16 → differt_core-0.0.18}/differt-core/Cargo.toml

@@ -3,13 +3,14 @@ harness = false
 name = "bench_main"
 
 [dependencies]
+indexmap = {version = "2.5.0", features = ["serde"]}
 log = "0.4.21"
 nalgebra = "0.32.3"
 ndarray = {version = "0.15", features = ["rayon"]}
 numpy = "0.21"
 obj-rs = "0.7.1"
 ply-rs = "0.1.3"
-pyo3 = "0.21"
+pyo3 = {version = "0.21", features = ["indexmap"]}
 pyo3-log = "0.10"
 quick-xml = {version = "0.31.0", features = ["serialize"]}
 serde = {version = "1.0.197", features = ["derive"]}
@@ -28,8 +29,11 @@ crate-type = ["cdylib", "rlib"]
 doctest = false
 name = "differt_core"
 
+[lints.rust]
+unexpected_cfgs = {level = "warn", check-cfg = ['cfg(tarpaulin_include)']}
+
 [package]
 edition = "2021"
 name = "differt-core"
 rust-version = "1.75.0"
-version = "0.0.16"
+version = "0.0.18"

differt_core-0.0.18/differt-core/README.md

@@ -0,0 +1,33 @@
+<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 performances.
+
+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.0.16 → differt_core-0.0.18}/differt-core/benches/benchmarks/graph_iterators.rs

@@ -1,4 +1,4 @@
-use criterion::{black_box, criterion_group, Criterion, Throughput};
+use criterion::{Criterion, Throughput, black_box, criterion_group};
 use differt_core::rt::graph::{complete::CompleteGraph, directed::DiGraph};
 
 const NUM_NODES: usize = 1000;

differt_core-0.0.18/differt-core/python/differt_core/__init__.py

@@ -0,0 +1,18 @@
+"""
+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!
+"""
+
+__all__ = ("__version__",)
+
+from differt_core._lowlevel import __version__

differt_core-0.0.18/differt-core/python/differt_core/_lowlevel/geometry/triangle_mesh.pyi

@@ -0,0 +1,16 @@
+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-0.0.16 → differt_core-0.0.18/differt-core}/python/differt_core/_lowlevel/rt/graph.pyi

@@ -6,10 +6,20 @@ from jaxtyping import Bool, UInt
 class CompleteGraph:
     def __init__(self, num_nodes: int) -> None: ...
     def all_paths(
-        self, from_: int, to: int, depth: int, *, include_from_and_to: bool = True
+        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
+        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,
@@ -24,18 +34,32 @@ class CompleteGraph:
 class DiGraph:
     @classmethod
     def from_adjacency_matrix(
-        cls, adjacency_matrix: Bool[np.ndarray, "num_nodes num_nodes"]
+        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
+        self,
+        *,
+        direct_path: bool = True,
     ) -> tuple[int, int]: ...
+    def disconnect_nodes(self, *nodes: int, fast_mode: bool = True) -> None: ...
     def all_paths(
-        self, from_: int, to: int, depth: int, *, include_from_and_to: bool = True
+        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
+        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,

{differt_core-0.0.16 → differt_core-0.0.18/differt-core}/python/differt_core/_lowlevel/scene/sionna.pyi

@@ -5,5 +5,12 @@ class SionnaScene:
     @classmethod
     def load_xml(cls, file: str) -> SionnaScene: ...
 
-class Material: ...
-class Shape: ...
+class Material:
+    id: str
+    rgb: tuple[float, float, float]
+
+class Shape:
+    type: str
+    id: str
+    file: str
+    material_id: str

differt_core-0.0.18/differt-core/python/differt_core/_lowlevel/scene/triangle_scene.pyi

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

differt_core-0.0.18/differt-core/python/differt_core/geometry/__init__.py

@@ -0,0 +1 @@
+"""Geometry utilities used by :mod:`differt.geometry`."""

differt_core-0.0.18/differt-core/python/differt_core/geometry/triangle_mesh.py

@@ -0,0 +1,7 @@
+"""Triangle mesh utilities used by :mod:`differt.geometry.triangle_mesh`."""
+
+__all__ = ("TriangleMesh",)
+
+from differt_core import _lowlevel
+
+TriangleMesh = _lowlevel.geometry.triangle_mesh.TriangleMesh

differt_core-0.0.18/differt-core/python/differt_core/rt/__init__.py

@@ -0,0 +1 @@
+"""Ray Tracing utilities used by :mod:`differt.rt`."""

{differt_core-0.0.16 → differt_core-0.0.18/differt-core}/python/differt_core/rt/graph.py

@@ -1,15 +1,15 @@
-"""TODO."""
+"""Graph utilities to generate path candidates, as used by exhaustive Ray Tracing methods, e.g., the Image Method."""
 
 __all__ = (
-    "CompleteGraph",
-    "DiGraph",
-    "AllPathsFromCompleteGraphIter",
     "AllPathsFromCompleteGraphChunksIter",
-    "AllPathsFromDiGraphIter",
+    "AllPathsFromCompleteGraphIter",
     "AllPathsFromDiGraphChunksIter",
+    "AllPathsFromDiGraphIter",
+    "CompleteGraph",
+    "DiGraph",
 )
 
-from .. import _lowlevel
+from differt_core import _lowlevel
 
 AllPathsFromCompleteGraphChunksIter = (
     _lowlevel.rt.graph.AllPathsFromCompleteGraphChunksIter

differt_core-0.0.18/differt-core/python/differt_core/scene/__init__.py

@@ -0,0 +1 @@
+"""Scene utilities used by :mod:`differt.scene`."""

differt_core-0.0.18/differt-core/python/differt_core/scene/sionna.py

@@ -0,0 +1,20 @@
+"""Fast and low-memory functions to read Sionna scenes.
+
+Fast because written in Rust and uses the extremely performant
+`quick_xml <https://github.com/tafia/quick-xml>`_ library.
+
+Low-memory because it only stores the minimal amount of information
+to reproduce Sionna scenes, and skips the rest (e.g., display information).
+
+As filepaths to shapes are relative to the initial XML config file,
+it is preferred to directly use ``load_xml`` from another scene
+class, like :meth:`TriangleScene<differt_core.scene.triangle_scene.TriangleScene>`.
+"""
+
+__all__ = ("Material", "Shape", "SionnaScene")
+
+from differt_core import _lowlevel
+
+Material = _lowlevel.scene.sionna.Material
+Shape = _lowlevel.scene.sionna.Shape
+SionnaScene = _lowlevel.scene.sionna.SionnaScene

differt_core-0.0.18/differt-core/python/differt_core/scene/triangle_scene.py

@@ -0,0 +1,7 @@
+"""Triangle scene utilities used by :mod:`differt.scene.triangle_scene`."""
+
+__all__ = ("TriangleScene",)
+
+from differt_core import _lowlevel
+
+TriangleScene = _lowlevel.scene.triangle_scene.TriangleScene

{differt_core-0.0.16 → differt_core-0.0.18}/differt-core/src/geometry/mod.rs

@@ -2,6 +2,7 @@ use pyo3::{prelude::*, wrap_pymodule};
 
 pub mod triangle_mesh;
 
+#[cfg(not(tarpaulin_include))]
 #[pymodule]
 pub(crate) fn geometry(m: Bound<'_, PyModule>) -> PyResult<()> {
     m.add_wrapped(wrap_pymodule!(triangle_mesh::triangle_mesh))?;