You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: pysplashsurf/README.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,35 @@ pySplashsurf provides Python bindings for `splashsurf`, an open source surface r
6
6
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).
7
7
8
8
## Installation
9
+
Requires Python version 3.7+
9
10
```
10
11
pip install pysplashsurf
11
12
```
12
-
Requires Python version 3.7+
13
13
14
14
To install pysplashsurf with meshio support (which adds some additional IO functionality), use
15
15
```
16
16
pip install pysplashsurf[meshio]
17
17
```
18
18
This will add support for the `.bgeo` file extension to meshio, so that particle data in the `BGEOV` format can be read using meshio.
19
19
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.
21
21
22
22
## 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:
0 commit comments