|
10 | 10 |
|
11 | 11 | Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust. |
12 | 12 |
|
13 | | -This repository consists of the following crates: |
| 13 | +This repository contains of the following components: |
14 | 14 | - 🛠️ `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`. |
15 | | - - 🧰 `splashsurf_lib`: Library that implements the reconstruction pipeline 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. |
| 15 | + - 🧰 `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. |
16 | 16 | - 🐍 `pysplashsurf`: Bindings to the CLI and library for Python. Install with `pip install splashsurf` and see the [`README`](pysplashsurf/README.md) for more details. |
| 17 | + - 🎬 `splashsurf_studio`: Blender add-on built on top of the Python bindings for on-the-fly surface reconstruction. Available from the [official Blender extension repository](https://extensions.blender.org/add-ons/splashsurf-studio/). |
17 | 18 |
|
18 | 19 | This page provides an overview of the CLI's features and high-level notes on implementation of the reconstruction method. |
19 | 20 |
|
20 | 21 | <p align="center"> |
21 | 22 | <img src="example_particles.png" alt="Image of the original particle data" width="32%"> <img src="example_coarse.png" alt="Image of a coarse reconstructed surface mesh" width="32%"> <img src="example_fine.png" alt="Image of a fine reconstructed surface mesh" width="32%"> |
22 | 23 | </p> |
23 | 24 |
|
24 | | -`splashsurf` is a tool to reconstruct surfaces meshes from SPH particle data. |
25 | | -The first image shows the visualization of a set of particles from an SPH fluid simulation from [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH). |
26 | | -The particle radius is `0.025`. As the rendering of a fluid should not look like a ball pit, a surface mesh has to be |
27 | | -reconstructed from this particle data. The next image shows a reconstructed surface mesh of the fluid produced by `splashsurf` |
28 | | -with a "smoothing length" of `2.2` times the particles radius and a cell size of `1.1` times the particle radius. The |
29 | | -third image shows a finer reconstruction with a cell size of `0.45` times the particle radius. These surface meshes can |
30 | | -then be fed into 3D rendering software such as [Blender](https://www.blender.org/) to generate beautiful water animations. |
31 | | -The result might look something like this: |
| 25 | +`splashsurf` is a tool designed to reconstruct surface meshes from SPH particle data. |
| 26 | +The first image illustrates the visualization of a set of particles from an SPH fluid simulation made using [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH). |
| 27 | +The particle radius is `0.025`. |
| 28 | +To ensure that the rendering of a fluid does not resemble a ball pit, a surface mesh must be reconstructed from this particle data. |
| 29 | +The second image displays a reconstructed surface mesh of the fluid produced by `splashsurf`, utilizing a "smoothing length" of `2.2` times the particle radius and a cell size of `1.1` times the particle radius. |
| 30 | +The third image showcases a finer reconstruction with a cell size of `0.45` times the particle radius. |
| 31 | +These surface meshes can then be imported into 3D rendering software such as [Blender](https://www.blender.org/) to create stunning water animations. |
| 32 | +The result may resemble the following: |
32 | 33 |
|
33 | 34 | <p align="center"> |
34 | 35 | <img src="https://raw.githubusercontent.com/w1th0utnam3/w1th0utnam3.github.io/master/splashsurf.gif" alt="Rendered water animation" width="96%"> |
35 | 36 | </p> |
36 | 37 |
|
37 | | -Note: This animation does not show the recently added smoothing features of the tool, for more recent rendering see [this video](https://youtu.be/2bYvaUXlBQs). |
38 | | - |
39 | 38 | --- |
40 | 39 |
|
41 | 40 | **Contents** |
|
0 commit comments