simgeometry 0.1.0__tar.gz

simgeometry-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Max Lindqvist
+
+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.

simgeometry-0.1.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: simgeometry
+Version: 0.1.0
+Summary: Shapes, grids, and simulation domains for numerical simulations
+Author: Max
+License-Expression: MIT
+Project-URL: Source, https://github.com/max-models/simgeometry
+Keywords: geometry,grids,simulation,mpi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: cunumpy>=0.6.2
+Requires-Dist: maybempi>=0.1
+Requires-Dist: mpiarray>=0.1.0
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyproject-fmt; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: simgeometry[docs,test]; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: griffe; extra == "docs"
+Requires-Dist: simgeometry[clip,plot]; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: matplotlib>=3.10.9; extra == "docs"
+Requires-Dist: nbclient>=0.11; extra == "docs"
+Requires-Dist: nbformat>=5.11.1; extra == "docs"
+Provides-Extra: clip
+Requires-Dist: shapely>=2; extra == "clip"
+Provides-Extra: evaluate
+Requires-Dist: xarray; extra == "evaluate"
+Provides-Extra: mesh
+Requires-Dist: scikit-image>=0.22; extra == "mesh"
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.10; extra == "plot"
+Requires-Dist: simgeometry[evaluate,mesh]; extra == "plot"
+Provides-Extra: interactive
+Requires-Dist: pyvista>=0.44; extra == "interactive"
+Requires-Dist: simgeometry[plot]; extra == "interactive"
+Provides-Extra: mpi
+Requires-Dist: mpi4py; extra == "mpi"
+Provides-Extra: pyccel
+Requires-Dist: pyccel>2.0; extra == "pyccel"
+Provides-Extra: gpu
+Requires-Dist: cupy-cuda12x; extra == "gpu"
+Provides-Extra: metal
+Requires-Dist: mlx; (sys_platform == "darwin" and platform_machine == "arm64") and extra == "metal"
+Provides-Extra: test
+Requires-Dist: mpi4py; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: simgeometry[clip]; extra == "test"
+Dynamic: license-file
+
+# simgeometry
+
+
+Geometry primitives for numerical simulations: bounded domains,
+structured grids, MPI domain decomposition, and 1D, 2D, and 3D shapes.
+Box, ball, and polygon containment have NumPy, Pyccel, CUDA, and Metal
+implementations. Originally developed for
+[Picnic](https://github.com/max-models/picnic).
+
+## Install
+
+``` bash
+pip install simgeometry
+```
+
+For development, install this checkout with `pip install -e '.[test]'`.
+NumPy, cunumpy, maybempi, and mpiarray are runtime dependencies.
+Matplotlib is optional. Install `simgeometry[plot]` for plotting,
+labelled evaluation and surface meshing, or `simgeometry[interactive]`
+for interactive 3D clipping with PyVista. Install `simgeometry[mpi]` for
+MPI, `simgeometry[pyccel]` for compiled CPU containment kernels, or
+`simgeometry[gpu]` for CUDA.
+
+## Example
+
+``` python
+from simgeometry.grid import Grid
+from simgeometry.objects import Circle
+
+boundary = Circle(midpoint=(0.5, 0.5), radius=0.25)
+grid = Grid(ndim=2, lower_bound=(0, 0), upper_bound=(1, 1), num_gridpoints=(32, 32))
+mask = boundary.node_mask(grid)
+```
+
+`SimulationDomain` accepts field and particle boundary objects through
+their `get_bc(dir=..., side=...).bc_type` interface. Applications may
+supply a seeded random function with `BoundingBox.random` and an
+accelerated particle boundary implementation with
+`SimulationDomain.boundary_kernel`.
+
+## Inspect, slice, and compose
+
+``` python
+from simgeometry import Sphere
+
+shell = Sphere((0, 0, 0), 1) - Sphere((0, 0, 0), 0.4)
+shell.show_3d(opacity=0.6)
+shell.slice(z=0.2).show()
+inside = shell.evaluate(x=[0, 0.8], y=0, z=0)
+```
+
+Shapes support named collections, Boolean operations, affine transforms,
+surface queries, point sampling, mesh export, cut-edge geometry and
+approximate cell/face fractions. See the [executed
+tutorials](https://max-models.github.io/simgeometry/tutorials/) and [API
+guide](https://max-models.github.io/simgeometry/getting-started/geometry-api/)
+for examples and the accuracy limits of sampled operations.
+
+## Development
+
+``` bash
+pytest src/simgeometry/tests
+```
+
+Documentation: <https://max-models.github.io/simgeometry/>

simgeometry-0.1.0/README.md

@@ -0,0 +1,65 @@
+# simgeometry
+
+
+Geometry primitives for numerical simulations: bounded domains,
+structured grids, MPI domain decomposition, and 1D, 2D, and 3D shapes.
+Box, ball, and polygon containment have NumPy, Pyccel, CUDA, and Metal
+implementations. Originally developed for
+[Picnic](https://github.com/max-models/picnic).
+
+## Install
+
+``` bash
+pip install simgeometry
+```
+
+For development, install this checkout with `pip install -e '.[test]'`.
+NumPy, cunumpy, maybempi, and mpiarray are runtime dependencies.
+Matplotlib is optional. Install `simgeometry[plot]` for plotting,
+labelled evaluation and surface meshing, or `simgeometry[interactive]`
+for interactive 3D clipping with PyVista. Install `simgeometry[mpi]` for
+MPI, `simgeometry[pyccel]` for compiled CPU containment kernels, or
+`simgeometry[gpu]` for CUDA.
+
+## Example
+
+``` python
+from simgeometry.grid import Grid
+from simgeometry.objects import Circle
+
+boundary = Circle(midpoint=(0.5, 0.5), radius=0.25)
+grid = Grid(ndim=2, lower_bound=(0, 0), upper_bound=(1, 1), num_gridpoints=(32, 32))
+mask = boundary.node_mask(grid)
+```
+
+`SimulationDomain` accepts field and particle boundary objects through
+their `get_bc(dir=..., side=...).bc_type` interface. Applications may
+supply a seeded random function with `BoundingBox.random` and an
+accelerated particle boundary implementation with
+`SimulationDomain.boundary_kernel`.
+
+## Inspect, slice, and compose
+
+``` python
+from simgeometry import Sphere
+
+shell = Sphere((0, 0, 0), 1) - Sphere((0, 0, 0), 0.4)
+shell.show_3d(opacity=0.6)
+shell.slice(z=0.2).show()
+inside = shell.evaluate(x=[0, 0.8], y=0, z=0)
+```
+
+Shapes support named collections, Boolean operations, affine transforms,
+surface queries, point sampling, mesh export, cut-edge geometry and
+approximate cell/face fractions. See the [executed
+tutorials](https://max-models.github.io/simgeometry/tutorials/) and [API
+guide](https://max-models.github.io/simgeometry/getting-started/geometry-api/)
+for examples and the accuracy limits of sampled operations.
+
+## Development
+
+``` bash
+pytest src/simgeometry/tests
+```
+
+Documentation: <https://max-models.github.io/simgeometry/>

simgeometry-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [ "setuptools", "wheel" ]
+
+[project]
+name = "simgeometry"
+version = "0.1.0"
+description = "Shapes, grids, and simulation domains for numerical simulations"
+readme = "README.md"
+keywords = [ "geometry", "grids", "simulation", "mpi" ]
+license = "MIT"
+license-files = [ "LICENSE.txt" ]
+authors = [ { name = "Max" } ]
+requires-python = ">=3.10"
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+  "cunumpy>=0.6.2",
+  "maybempi>=0.1",
+  "mpiarray>=0.1.0",
+  "numpy",
+]
+optional-dependencies.dev = [
+  "jupyterlab",
+  "pre-commit",
+  "pyproject-fmt",
+  "pyright",
+  "ruff",
+  "simgeometry[docs,test]",
+]
+optional-dependencies.docs = [
+  "griffe",
+  "simgeometry[clip,plot]",
+  "ipykernel",
+  "matplotlib>=3.10.9",
+  "nbclient>=0.11",
+  "nbformat>=5.11.1",
+]
+optional-dependencies.clip = [ "shapely>=2" ]
+optional-dependencies.evaluate = [ "xarray" ]
+optional-dependencies.mesh = [ "scikit-image>=0.22" ]
+optional-dependencies.plot = [ "matplotlib>=3.10", "simgeometry[evaluate,mesh]" ]
+optional-dependencies.interactive = [ "pyvista>=0.44", "simgeometry[plot]" ]
+optional-dependencies.mpi = [ "mpi4py" ]
+optional-dependencies.pyccel = [ "pyccel>2.0" ]
+optional-dependencies.gpu = [ "cupy-cuda12x" ]
+optional-dependencies.metal = [ "mlx; sys_platform == 'darwin' and platform_machine == 'arm64'" ]
+optional-dependencies.test = [ "mpi4py", "pytest", "pytest-cov", "simgeometry[clip]" ]
+urls.Source = "https://github.com/max-models/simgeometry"
+
+[tool.setuptools]
+package-data."*" = [ "py.typed" ]
+package-data.simgeometry = [ "kernels/*/*.cu" ]
+packages.find.where = [ "src" ]
+packages.find.exclude = [ "simgeometry.tests*" ]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+extend-include = [ "*.ipynb" ]
+# Keep linting focused while the geometry code retains its existing docstrings.
+lint.select = [ "E", "F", "I", "W" ]
+lint.ignore = [ "E501" ]  # line length is handled by the formatter
+lint.per-file-ignores."**/tests/**" = [ "E402" ]
+lint.pydocstyle.convention = "google"
+
+[tool.pyright]
+include = [ "src" ]
+exclude = [ "**/tests" ]
+pythonVersion = "3.10"
+# The extracted code predates strict typing; keep import resolution checked.
+typeCheckingMode = "off"
+reportMissingImports = "error"
+
+[tool.pytest]
+ini_options.pythonpath = [ "src" ]
+ini_options.testpaths = [ "src" ]
+ini_options.addopts = "-ra"
+
+[tool.coverage]
+run.omit = [ "*/tests/*" ]
+run.source = [ "simgeometry" ]
+report.show_missing = true

simgeometry-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

simgeometry-0.1.0/src/simgeometry/__init__.py

@@ -0,0 +1,38 @@
+"""Shapes, grids, and domains for numerical simulations."""
+
+from simgeometry.collection import GeometryCollection
+from simgeometry.grid import Grid
+from simgeometry.objects import (
+    Aperture2D,
+    Aperture3D,
+    Circle,
+    Cuboid,
+    FunctionObject2D,
+    FunctionObject3D,
+    Line,
+    Polygon,
+    Polyline,
+    Rectangle,
+    Sphere,
+    Triangle,
+)
+from simgeometry.simulation_domain import SimulationDomain
+
+__version__ = "0.1.0"
+__all__ = [
+    "GeometryCollection",
+    "Grid",
+    "SimulationDomain",
+    "Aperture2D",
+    "Aperture3D",
+    "Circle",
+    "Cuboid",
+    "FunctionObject2D",
+    "FunctionObject3D",
+    "Line",
+    "Polygon",
+    "Polyline",
+    "Rectangle",
+    "Sphere",
+    "Triangle",
+]

simgeometry-0.1.0/src/simgeometry/_bounds.py

@@ -0,0 +1,16 @@
+"""Array bounds shared by geometric regions and grids."""
+
+from __future__ import annotations
+
+
+class Bounds:
+    def __init__(self, lower_bound, upper_bound) -> None:
+        assert len(lower_bound) == len(upper_bound)
+        self.lower_bound = lower_bound
+        self.upper_bound = upper_bound
+        self.ndim = len(lower_bound)
+        assert self.ndim in (1, 2, 3)
+        for axis in range(self.ndim):
+            assert upper_bound[axis] >= lower_bound[axis]
+        self.sidelengths = upper_bound - lower_bound
+        self.midpoint = lower_bound + 0.5 * self.sidelengths

simgeometry-0.1.0/src/simgeometry/_normalize.py

@@ -0,0 +1,23 @@
+"""Normalize scalar and sequence geometry arguments."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+
+
+def ensure_dim_tuple(value: object, *, ndim: int | None = None) -> tuple:
+    if isinstance(value, tuple):
+        normalized = value
+    elif isinstance(value, list):
+        normalized = tuple(value)
+    elif isinstance(value, (str, bytes, dict)):
+        raise TypeError(
+            f"value must be a scalar number/bool or sequence, got {type(value)}"
+        )
+    elif isinstance(value, Iterable):
+        normalized = tuple(value)
+    else:
+        normalized = (value,)
+    if ndim is not None and len(normalized) != ndim:
+        raise ValueError(f"value must have length {ndim}, got {len(normalized)}")
+    return normalized

simgeometry-0.1.0/src/simgeometry/_particle_boundaries.py

@@ -0,0 +1,37 @@
+"""Apply particle boundary conditions on the active array backend."""
+
+from __future__ import annotations
+
+import cunumpy as xp
+
+
+def apply_particle_boundaries(
+    positions, velocities, alive, reinject, lower, upper, lower_type, upper_type
+) -> None:
+    """Update component-major particle arrays in place.
+
+    Boundary codes are kill=0, reflect=1, periodic=2, reinject=3.
+    """
+    reinject[:] = False
+    in_domain = alive.copy()
+    for axis in range(positions.shape[0]):
+        active = alive & ~reinject
+        x = positions[axis]
+        low, high = lower[axis], upper[axis]
+        below = active & (x < low)
+        above = active & ((x >= high) if upper_type[axis] == 2 else (x > high))
+        for mask, bound, side_type in (
+            (below, low, lower_type[axis]),
+            (above, high, upper_type[axis]),
+        ):
+            if side_type == 1:
+                x[mask] = 2.0 * bound - x[mask]
+                velocities[axis, mask] *= -1.0
+            elif side_type == 2:
+                wrapped = low + (x[mask] - low) % (high - low)
+                x[mask] = xp.where(wrapped >= high, low, wrapped)
+            elif side_type == 3:
+                reinject |= mask
+        checked = alive & ~reinject
+        in_domain &= ~checked | ((x >= low) & (x < high))
+    alive &= in_domain

simgeometry-0.1.0/src/simgeometry/_types.py

@@ -0,0 +1,22 @@
+"""Types used by geometry without importing simulation utilities."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import TypeAlias
+
+from numpy import ndarray
+
+Array: TypeAlias = ndarray
+Scalar: TypeAlias = str | int | float | bool | None
+ConfigValue: TypeAlias = (
+    Scalar
+    | Array
+    | list["ConfigValue"]
+    | tuple["ConfigValue", ...]
+    | set["ConfigValue"]
+    | dict[str, "ConfigValue"]
+)
+Printable: TypeAlias = str | int | float | bool | None
+BoundsLike: TypeAlias = Sequence[int | float] | ndarray
+Vertices2DLike: TypeAlias = Sequence[BoundsLike] | ndarray