Skip to content

Commit d381b7d

Browse files
committed
Add section about usage
1 parent d8d80f4 commit d381b7d

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

splashsurf_lib/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ For now, check the [GitHub repository](https://github.com/w1th0utnam3/splashsurf
88

99
## Usage
1010

11-
*TODO: Describe main "entry points" of the library, parameters, inputs/outputs etc.*
11+
A reconstruction from particle positions is performed using the top-level `reconstruct_surface` function:
12+
```rust
13+
pub fn reconstruct_surface<I: Index, R: Real>(
14+
particle_positions: &[Vector3<R>],
15+
parameters: &Parameters<R>,
16+
) -> Result<SurfaceReconstruction<I, R>, ReconstructionError<I, R>>
17+
```
18+
See the [documentation of the crate](https://docs.rs/splashsurf_lib/latest/splashsurf_lib/) on docs.rs for more information on the usage.
1219

1320
The library re-exports `nalgebra` to avoid version conflicts for users of the library.
1421

splashsurf_lib/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ use nalgebra::Vector3;
5555
use thiserror::Error as ThisError;
5656

5757
// TODO: Add documentation of feature flags
58+
// TODO: Add documentation of the parameter struct
5859

5960
// TODO: Remove anyhow/thiserror from lib?
6061
// TODO: Write more unit tests (e.g. AABB, UniformGrid, neighborhood search)

0 commit comments

Comments
 (0)