Skip to content

Commit acd0cfa

Browse files
committed
Fix readme files
1 parent 78ebf33 commit acd0cfa

2 files changed

Lines changed: 180 additions & 56 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Surface reconstruction library and CLI for particle data from SPH simulations, w
1818
- [VTK](#vtk)
1919
- [PLY](#ply)
2020
- [XYZ](#xyz)
21+
- [Output file formats](#output-file-formats)
2122
- [License](#license)
2223

2324
# The `splashsurf` CLI
@@ -158,15 +159,19 @@ With these parameters, a scene with 13353401 particles is reconstructed in nearl
158159

159160
### VTK
160161

161-
Files with the "`.vtk`" are loaded using [`vtkio`](https://crates.io/crates/vtkio). The VTK file is loaded as a big endian binary file and has to contain an "Unstructured Grid" with either `f32` or `f64` vertex coordinates. Any other data or attributes are ignored. Only the first "Unstructured Grid" is loaded, other entities are ignored.
162+
Files with the "`.vtk`" extension are loaded using [`vtkio`](https://crates.io/crates/vtkio). The VTK file is loaded as a big endian binary file and has to contain an "Unstructured Grid" with either `f32` or `f64` vertex coordinates. Any other data or attributes are ignored. Only the first "Unstructured Grid" is loaded, other entities are ignored.
162163

163164
### PLY
164165

165166
Files with the "`.ply`" extension are loaded using [`ply-rs`](https://crates.io/crates/ply-rs). The PLY file has to contain an element called "`vertex`" with the properties `x`, `y` and `z` of type `f32`/["`Property::Float`"](https://docs.rs/ply-rs/0.1.3/ply_rs/ply/enum.Property.html#variant.Float). Any other properties or elements are ignored.
166167

167168
### XYZ
168169

169-
Files with the "`.xyz`" extension are interpreted as raw bytes of `f32` values in native endianness of the system. Three consecutive `f32`s represent a (x,y,z) coordinate triplet of a fluid particle.
170+
Files with the "`.xyz`" extension are interpreted as raw bytes of `f32` values in native endianness of the system. Three consecutive `f32`s represent a (x,y,z) coordinate triplet of a fluid particle.
171+
172+
## Output file formats
173+
174+
Currently, only VTK files are supported for output.
170175

171176
# License
172177

0 commit comments

Comments
 (0)