Skip to content

Commit 4773071

Browse files
committed
Update readme
1 parent aa17372 commit 4773071

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,13 +154,13 @@ That means selecting the same particle radius as in the simulation, a correspond
154154

155155
A full invocation of the tool might look like this:
156156
```
157-
splashsurf reconstruct particles.vtk -r=0.025 -l=2.0 -c=0.5 -t=0.6 --subdomain-grid=on --mesh-cleanup=on --mesh-smoothing-weights=on --mesh-smoothing-iters=25 --normals=on --normals-smoothing-iters=10
157+
splashsurf reconstruct particles.vtk -r=0.025 -l=2.0 -c=0.5 -t=0.6 --mesh-smoothing-weights=on --mesh-smoothing-iters=15 --normals=on --normals-smoothing-iters=10
158158
```
159159

160160
### Benchmark example
161161
For example:
162162
```
163-
splashsurf reconstruct canyon_13353401_particles.xyz -r=0.011 -c=1.5 -l=2.0 -t=0.6 --subdomain-grid=on
163+
splashsurf reconstruct canyon_13353401_particles.xyz -r=0.011 -c=1.5 -l=2.0 -t=0.6
164164
```
165165
With these parameters, a scene with 13353401 particles is reconstructed in less than 3 seconds on a Ryzen 9 5950X. The output is a mesh with 6069576 triangles.
166166
```

pysplashsurf/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,35 @@ pySplashsurf provides Python bindings for `splashsurf`, an open source surface r
66
Detailed information on the surface reconstruction and library itself and its API can be found on the [project website (splashsurf.physics-simulation.org)](https://splashsurf.physics-simulation.org/) or the [main repository](https://github.com/InteractiveComputerGraphics/splashsurf).
77

88
## Installation
9+
Requires Python version 3.7+
910
```
1011
pip install pysplashsurf
1112
```
12-
Requires Python version 3.7+
1313

1414
To install pysplashsurf with meshio support (which adds some additional IO functionality), use
1515
```
1616
pip install pysplashsurf[meshio]
1717
```
1818
This will add support for the `.bgeo` file extension to meshio, so that particle data in the `BGEOV` format can be read using meshio.
1919
Meshio is also required for the `write_to_file` method from the bindings to work.
20-
The rest of the package will still work even if meshio is not installed.
20+
The rest of the package, including the CLI, will still work even if meshio is not installed.
2121

2222
## Usage
23+
pySplashsurf can either be used as a library in Python scripts or as a command line tool that provides the same interface as the original Rust [`splashsurf`](https://github.com/InteractiveComputerGraphics/splashsurf) CLI itself.
24+
25+
### CLI
26+
To use the CLI, you can use the `pysplashsurf` command after installing the package:
27+
```bash
28+
pysplashsurf --help
29+
```
30+
For example, to reconstruct a surface from particle data in a VTK file with some smoothing:
31+
```bash
32+
splashsurf reconstruct particles.vtk -r=0.025 -l=2.0 -c=0.5 -t=0.6 --mesh-smoothing-weights=on --mesh-smoothing-iters=15 --normals=on --normals-smoothing-iters=10
33+
```
34+
35+
For more information on the CLI and its arguments, refer to the [splashsurf documentation](https://github.com/InteractiveComputerGraphics/splashsurf).
36+
37+
### Library
2338
Example to reconstruct the surface from an input file, apply some post-processing methods and write the data back to a file:
2439
```python
2540
import meshio

0 commit comments

Comments
 (0)