Refactor python package: unify f32/f64 implementations & zero copy views where possible (#229)

* Remove local lockfile

* Py: Fix local build on macOS

* Py: WIP: Combine f32 & f64 pipeline and mesh types

* Py: Fix cast of usize for Numpy arrays on 32 bit architectures

* Py: WIP: Further mesh refactoring

* Py: Simplify code

* Automatically set global neighborhood lists in pipeline

* Py: Fixes in pipeline

* Make zero constructor of UniformGrid public for Python API

* Py: Implement generic reconstruct surf., remove old pipeline functions

* Py: Implement check_mesh_consistency, remove old code

* Py: Clean up

* Py: Refactor

* Rename argument

* Py: Re-Implement tris_to_quads

* Py: Update decimation

* Py: Reimplement smoothing functions

* Use slices for normal smoothing

* Py: Refactor

* WIP: Signed Index type

* Py: Use views for mesh vertices & triangles

* Implement normals

* Py: Refactor MeshWithData wrapper

* Py: Get triangle and quad cells from mixed mesh

* Py: Refactor, fix MeshWithData constructor

* Py: WIP: Mesh attributes

* Py: Getter for data of mesh attributes

* Py: Add basic AABB, update neighborhood search

* Py: Remove old code

* Py: Access methods for neighborhood lists

* Add method to interpolator

* Py: Update SphInterpolator

* Make fields of SurfaceReconstruction public, refactor pipeline return

* Py: Refactoring

* Py: Fix re-shaping in interpolator

* Py: Reimplement reconstruction wrapper without copies

* Py: Update pyo3 crates, bump minimum Python version to 3.10

* Py: Update AABB

* Py: Update write_to_file and attribute getters (return dicts)

* Py: Add annotations import to stub file

* Py: Update doc strings

* Py: Update sphinx templates and doc strings

* Py: Update documentation

* Py: Move mesh writing to rust code

* Py: Add attributes to MeshWithData

* Py: Mesh copy and Mesh to MeshWithData constructor

* Py: Fix tests, fix bugs

* Py: Fix CI stub gen

* Py: Fix splashsurf path in CI

* CI: Only publish on main

* Py: Fix build.rs on CI

* Py: Documentation fixes

* Update changelog

* Py: Documentation fixes

* Update changelog

* Py: Refactor

* Py: Refactor tests

* Py: Methods for UniformGrid, add tests for many functions

* Add missing test data

* Py: Add plain marching cubes functionality

* Support borrowed data for DensityMap

* Update comment

* Update changelog

Author: w1th0utnam3

.github/workflows/build.yml

@@ -86,7 +86,7 @@ jobs:
   publish:
     name: Publish to crates.io
     runs-on: ubuntu-latest
-    if: ${{ startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' }}
+    if: ${{ (startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main' }}
     needs: [check_format, build_workspace, build_lib_all_features, build_lib_no_default_features]
     steps:
       - uses: actions/checkout@v4

.github/workflows/pysplashsurf_CI.yml

@@ -29,7 +29,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: moonrepo/setup-rust@v1
       - run: |
-          cargo run --bin stub_gen
+          cargo run --bin stub_gen --no-default-features
         working-directory: pysplashsurf
       - name: Upload stub as artifact
         uses: actions/upload-artifact@v4
@@ -316,7 +316,7 @@ jobs:
   publish:
     name: Publish to PyPI
     runs-on: ubuntu-latest
-    if: ${{ startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' }}
+    if: ${{ (startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main' }}
     needs: [linux_wheels, macos_wheels, windows_wheels, sdist, tests, docs]
     steps:
       - uses: actions/download-artifact@v4
@@ -426,7 +426,7 @@ jobs:
         path: dist/
     - run: pip install dist/${{ needs.build_wheel_dev.outputs.filename }}
     - name: Install splashsurf CLI
-      run: cargo install splashsurf
+      run: cargo install splashsurf --path ./splashsurf
     - name: Run pytest
       uses: pavelzw/pytest-action@v2
       with:

CHANGELOG.md

@@ -2,7 +2,18 @@
 
 The following changes are present in the `main` branch of the repository and are not yet part of a release:
 
- - N/A
+ - Py: Major refactor of the Python bindings, interface is simplified and more "pythonic"
+   - Merged distinct F64/F32 classes and functions and infer data type automatically
+   - Nearly all inputs and outputs are now zero-copy (e.g. mesh vertices and faces can be accessed as attributes without copies)
+ - Py: Add a function for a plain marching cubes reconstruction without any SPH interpolation
+ - Lib: Add support for "dense" density maps (borrowed & owned) as input for the marching cubes triangulation, useful for the Python bindings
+ - Lib: Enforce that `Index` types are signed integers implementing the `num_traits::Signed` trait. Currently, the reconstruction does not work (correctly) with unsigned integers.
+ - Lib: Make most fields of `SurfaceReconstruction` public
+ - CLI: Add some tests for the `reconstruction_pipeline` function
+ - CLI: Fix post-processing when particle AABB filtering is enabled
+ - Lib: Support subdomain "ghost particle" margins to be up to the size of the subdomain itself (previously limited to half the size)
+ - CLI/Lib: Option to automatically disable subdomain decomposition for very small grids
+ - Lib: Support for non-owned data in `MeshAttribute`, avoids copies in CLI and Python package
 
 ## Version 0.12.0