meshers 0.1.0__tar.gz

meshers-0.1.0/LICENSE

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

meshers-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: meshers
+Version: 0.1.0
+Requires-Dist: numpy>=1.23
+Requires-Dist: h5py>=3.8 ; extra == 'io'
+Requires-Dist: pytest>=8 ; extra == 'test'
+Requires-Dist: h5py>=3.8 ; extra == 'test'
+Requires-Dist: pyvista>=0.46 ; extra == 'test'
+Provides-Extra: io
+Provides-Extra: test
+License-File: LICENSE
+License-File: THIRDPARTY.json
+Summary: Direct CPU tetrahedral meshing of implicit geometries and constrained intersections
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://github.com/kmarchais/meshers/tree/main/docs/site
+Project-URL: Issues, https://github.com/kmarchais/meshers/issues
+Project-URL: Repository, https://github.com/kmarchais/meshers
+
+# Meshers Python 0.1.0
+
+In-process CPU float64 meshing of bounded implicit solids. No subprocess or intermediate mesh file is needed.
+
+## Install and use
+
+Use Python 3.10+. Wheels are available for Linux x86-64, Windows x86-64,
+macOS Apple Silicon and macOS Intel. Users installing a wheel do not need Rust,
+Numba or SymPy.
+
+```sh
+python -m pip install "meshers[io]"
+```
+
+The base installation, `pip install meshers`, requires NumPy. The optional
+`io` extra adds h5py for VTKHDF export; it does not install a viewer.
+
+```python
+import meshers
+
+mesh = meshers.generate("gyroid", cells=24, band=(-0.5, 0.5), periodic=(True, True, True))
+points, tetrahedra = mesh.points, mesh.tetrahedra
+mesh.write_vtkhdf("gyroid.vtkhdf")  # requires h5py
+```
+
+Native fields: `gyroid`, `schwarz_p`, `schwarz_d`; their period is one physical
+coordinate unit. Bounds default to the unit cube and use
+`(xmin, xmax, ymin, ymax, zmin, zmax)`. `cells` accepts an integer or three integers.
+Without `band`, the solid is `field <= 0`. Periodicity defaults to disabled.
+
+## Custom and graded functions
+
+Pass a pointwise NumPy-style callable `field(x, y, z)`. Supported expressions
+compile automatically inside the wheel, with automatic gradients and cached
+machine code. CPU workers evaluate float64 directly, with the GIL released.
+This supports callable grading, thickness and blends without an explicit
+compilation step. See [supported operations and limits](https://github.com/kmarchais/meshers/blob/main/crates/meshers-python/COMPILED.md).
+
+Unsupported expressions fall back to batched NumPy callbacks with a warning.
+Select that path explicitly with `compile=False`; callbacks must return `(N,)`
+float64 arrays, and optional gradients `(N,3)`. Functions must be deterministic
+and independent of batch contents. Callback evaluation runs on the calling
+Python thread.
+
+See the [graded example](https://github.com/kmarchais/meshers/blob/main/crates/meshers-python/examples/graded.py).
+
+## Results and failures
+
+- Owned NumPy arrays: float64 points, int64 tetrahedra and boundary triangles.
+- Boundary tags: 0 implicit, 1/2 x-/x+, 3/4 y-/y+, 5/6 z-/z+.
+- Per-axis periodic node pairs plus geometry and quality diagnostics.
+- VTKHDF volume or `surface=True`, periodic master IDs and physical shift vectors.
+  Volume files include `Volume` and `MMGQuality`, computed using the MMG formula
+  in NumPy, not by calling mmgpy.
+- Invalid options raise `ValueError`; failed meshing raises `MeshingError`.
+  Callback exceptions are preserved. `KeyboardInterrupt` is propagated.
+- Pass `cancel=CancellationToken()` and call `token.cancel()` from another thread
+  for cooperative cancellation. A callback must return before it can be interrupted
+  by that token. Tokens remain cancelled after use.
+
+Output arrays own their storage and are mutable. Mutating them can invalidate
+connectivity, metadata or diagnostics. Surface output is the closed solid boundary,
+not an independent zero-level surface mesher. Small features may be missed at
+insufficient resolution; successful sampling is not geometry certification.
+
+## Validation and limits
+
+The test suite covers automatic derivatives, cache invalidation, cancellation,
+periodicity, bounded callbacks, named intersections, physical coordinate scales
+and VTKHDF round trips. CI tests Python 3.10, 3.12 and 3.14 on Linux, Windows
+and macOS, plus installed platform wheels and an isolated source build.
+See the [release checks](https://github.com/kmarchais/meshers/blob/main/docs/site/release.md)
+and [CI results](https://github.com/kmarchais/meshers/actions). Thin, nonsmooth or
+poorly resolved geometry still needs application-specific convergence checks.
+
+See the [runnable examples](https://github.com/kmarchais/meshers/blob/main/docs/site/examples.md) and [performance regression checks](https://github.com/kmarchais/meshers/blob/main/docs/site/performance.md).
+
+## Maintainer build
+
+Maintainers need a compatible Rust toolchain and Python to build wheels:
+
+```sh
+python -m pip install maturin
+maturin build --release --interpreter python --out dist
+```
+
+End users install the resulting wheels. Source installations require Rust.
+
+## Retained intersections and mapped periodic ends
+
+`meshers.generate_intersection` accepts named negative sublevel constraints,
+an optional coordinate map and explicit rigid periodic transforms. It returns
+the same Mesh type, with named surface access, feature edges and parameter
+coordinates. See the [intersection guide](https://github.com/kmarchais/meshers/blob/main/docs/site/intersections.md)
+and `examples/curved_tpms.py`. Source builds require Rust 1.95 or newer.
+

meshers-0.1.0/README.md

@@ -0,0 +1,95 @@
+# Meshers Python 0.1.0
+
+In-process CPU float64 meshing of bounded implicit solids. No subprocess or intermediate mesh file is needed.
+
+## Install and use
+
+Use Python 3.10+. Wheels are available for Linux x86-64, Windows x86-64,
+macOS Apple Silicon and macOS Intel. Users installing a wheel do not need Rust,
+Numba or SymPy.
+
+```sh
+python -m pip install "meshers[io]"
+```
+
+The base installation, `pip install meshers`, requires NumPy. The optional
+`io` extra adds h5py for VTKHDF export; it does not install a viewer.
+
+```python
+import meshers
+
+mesh = meshers.generate("gyroid", cells=24, band=(-0.5, 0.5), periodic=(True, True, True))
+points, tetrahedra = mesh.points, mesh.tetrahedra
+mesh.write_vtkhdf("gyroid.vtkhdf")  # requires h5py
+```
+
+Native fields: `gyroid`, `schwarz_p`, `schwarz_d`; their period is one physical
+coordinate unit. Bounds default to the unit cube and use
+`(xmin, xmax, ymin, ymax, zmin, zmax)`. `cells` accepts an integer or three integers.
+Without `band`, the solid is `field <= 0`. Periodicity defaults to disabled.
+
+## Custom and graded functions
+
+Pass a pointwise NumPy-style callable `field(x, y, z)`. Supported expressions
+compile automatically inside the wheel, with automatic gradients and cached
+machine code. CPU workers evaluate float64 directly, with the GIL released.
+This supports callable grading, thickness and blends without an explicit
+compilation step. See [supported operations and limits](https://github.com/kmarchais/meshers/blob/main/crates/meshers-python/COMPILED.md).
+
+Unsupported expressions fall back to batched NumPy callbacks with a warning.
+Select that path explicitly with `compile=False`; callbacks must return `(N,)`
+float64 arrays, and optional gradients `(N,3)`. Functions must be deterministic
+and independent of batch contents. Callback evaluation runs on the calling
+Python thread.
+
+See the [graded example](https://github.com/kmarchais/meshers/blob/main/crates/meshers-python/examples/graded.py).
+
+## Results and failures
+
+- Owned NumPy arrays: float64 points, int64 tetrahedra and boundary triangles.
+- Boundary tags: 0 implicit, 1/2 x-/x+, 3/4 y-/y+, 5/6 z-/z+.
+- Per-axis periodic node pairs plus geometry and quality diagnostics.
+- VTKHDF volume or `surface=True`, periodic master IDs and physical shift vectors.
+  Volume files include `Volume` and `MMGQuality`, computed using the MMG formula
+  in NumPy, not by calling mmgpy.
+- Invalid options raise `ValueError`; failed meshing raises `MeshingError`.
+  Callback exceptions are preserved. `KeyboardInterrupt` is propagated.
+- Pass `cancel=CancellationToken()` and call `token.cancel()` from another thread
+  for cooperative cancellation. A callback must return before it can be interrupted
+  by that token. Tokens remain cancelled after use.
+
+Output arrays own their storage and are mutable. Mutating them can invalidate
+connectivity, metadata or diagnostics. Surface output is the closed solid boundary,
+not an independent zero-level surface mesher. Small features may be missed at
+insufficient resolution; successful sampling is not geometry certification.
+
+## Validation and limits
+
+The test suite covers automatic derivatives, cache invalidation, cancellation,
+periodicity, bounded callbacks, named intersections, physical coordinate scales
+and VTKHDF round trips. CI tests Python 3.10, 3.12 and 3.14 on Linux, Windows
+and macOS, plus installed platform wheels and an isolated source build.
+See the [release checks](https://github.com/kmarchais/meshers/blob/main/docs/site/release.md)
+and [CI results](https://github.com/kmarchais/meshers/actions). Thin, nonsmooth or
+poorly resolved geometry still needs application-specific convergence checks.
+
+See the [runnable examples](https://github.com/kmarchais/meshers/blob/main/docs/site/examples.md) and [performance regression checks](https://github.com/kmarchais/meshers/blob/main/docs/site/performance.md).
+
+## Maintainer build
+
+Maintainers need a compatible Rust toolchain and Python to build wheels:
+
+```sh
+python -m pip install maturin
+maturin build --release --interpreter python --out dist
+```
+
+End users install the resulting wheels. Source installations require Rust.
+
+## Retained intersections and mapped periodic ends
+
+`meshers.generate_intersection` accepts named negative sublevel constraints,
+an optional coordinate map and explicit rigid periodic transforms. It returns
+the same Mesh type, with named surface access, feature edges and parameter
+coordinates. See the [intersection guide](https://github.com/kmarchais/meshers/blob/main/docs/site/intersections.md)
+and `examples/curved_tpms.py`. Source builds require Rust 1.95 or newer.