Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
Adds Python bindings and packaging infrastructure for the splashsurf library.
- Introduces Rust-to-Python binding code (
lib.rs,aabb.rs) - Adds build configs (Conda env,
pyproject.toml, CI workflow) and documentation - Integrates
.bgeoreader viameshioand updatesREADME.mdand Sphinx docs
Reviewed Changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pysplashsurf/src/lib.rs | Registers Python module classes and functions |
| pysplashsurf/src/aabb.rs | Implements Aabb3dF32/Aabb3dF64 Python wrappers |
| pysplashsurf/python_environment.yaml | Defines Conda environment for docs/tests |
| pysplashsurf/pysplashsurf/docs/source/methods.rst | Lists bound functions in Sphinx documentation |
| pysplashsurf/pysplashsurf/docs/source/introduction.md | Includes main README.md |
| pysplashsurf/pysplashsurf/docs/source/index.rst | Sphinx index with toctree |
| pysplashsurf/pysplashsurf/docs/source/conf.py | Sphinx project configuration |
| pysplashsurf/pysplashsurf/docs/source/classes.rst | Autogenerates class docs |
| pysplashsurf/pysplashsurf/docs/source/api.rst | Autosummaries for functions and classes |
| pysplashsurf/pysplashsurf/docs/requirements.txt | Requirements for building docs |
| pysplashsurf/pysplashsurf/docs/make.bat | Windows build script for docs |
| pysplashsurf/pysplashsurf/docs/Makefile | Unix build script for docs |
| pysplashsurf/pysplashsurf/bgeo.py | Adds bgeo reader integration with meshio |
| pysplashsurf/pyproject.toml | Python packaging metadata |
| pysplashsurf/README.md | Top-level usage instructions and examples |
| pysplashsurf/MANIFEST.in | Includes Rust and Python sources in sdist |
| pysplashsurf/Cargo.toml | Rust crate configuration |
| pysplashsurf/.gitignore | Excludes build artifacts |
| .github/workflows/pysplashsurf_CI.yml | CI workflow to build, test, and publish wheels |
Comments suppressed due to low confidence (4)
pysplashsurf/pysplashsurf/docs/source/methods.rst:12
- The docs reference
create_aabb_objectandcreate_aabb_object_from_points, but no such functions are bound inlib.rs. Either add those bindings or remove/update these entries.
.. autofunction:: create_aabb_object
pysplashsurf/src/lib.rs:116
- The
write_to_filefunction is documented in the Python API but not registered here. Add am.add_function(wrap_pyfunction!(write_to_file, m)?)call to expose it.
Ok(())
pysplashsurf/Cargo.toml:3
- Version in
Cargo.toml(0.1.0) does not match the Python package version (0.11.0.0rc1inpyproject.toml). Align these versions to avoid confusion.
version = "0.1.0"
pysplashsurf/pysplashsurf/bgeo.py:89
- Typo in comment: change
coordiantetocoordinate.
# the 4th column is homogeneous coordiante, which is all 1, and will be ignored
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds Python bindings to the splashsurf project. The bindings provide a function that can be used like the CLI of splashsurf as well as access to parts of
splashsurf_lib.. The PR also contains infrastructure to build wheels and a workflow to release them to PIP.Thanks @Fek04 for your contribution!