Skip to content

Commit

Permalink
Fix the docs and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoledoux committed Mar 11, 2024
1 parent a2324b1 commit 52e6474
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,14 @@ A library for modelling and processing 2.5D terrains using a (2D) Delaunay trian
The triangulation is computed in 2D, but the *z*-elevation of the vertices are kept.

The underlying code is written in [Rust](https://www.rust-lang.org/) (so it's rather fast) and [robust arithmetic](https://crates.io/crates/robust) is used (so it shouldn't crash).

startinpy uses the [startin Rust library](https://github.com/hugoledoux/startin) and adds several utilities and functions, for instance [NumPy](https://numpy.org/) support for input/output, exporting to several formats, and easy-of-use.

startinpy allows you to:

1. insert incrementally points
2. delete vertices (useful for simplification, interpolation, and other operations)
3. interpolate and create grids with several methods: TIN, natural neighbours, IDW, Laplace, etc.
4. use other useful terrain Python libraries that are also NumPy-based, eg [laszy](https://laspy.readthedocs.io), [meshio](https://github.com/nschloe/meshio)
4. use other useful terrain Python libraries that are also NumPy-based, eg [laspy](https://laspy.readthedocs.io), [meshio](https://github.com/nschloe/meshio)
5. outputs the TIN to several formats: OBJ, PLY, GeoJSON, and CityJSON
6. extra attributes (the ones from LAS/LAZ) can be stored with the vertices

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ startinpy uses the [startin Rust library](https://github.com/hugoledoux/startin)
1. insert incrementally points
2. delete vertices (useful for simplification, interpolation, and other operations)
3. interpolate and create grids with several methods: TIN, natural neighbours, IDW, Laplace, etc.
4. use other useful terrain Python libraries that are also NumPy-based, eg [laszy](https://laspy.readthedocs.io), [meshio](https://github.com/nschloe/meshio)
4. use other useful terrain Python libraries that are also NumPy-based, eg [laspy](https://laspy.readthedocs.io), [meshio](https://github.com/nschloe/meshio)
5. outputs the TIN to several formats: OBJ, PLY, GeoJSON, and CityJSON
6. [extra attributes](attributes) (the ones from LAS/LAZ) can be stored with the vertices
:::
Expand Down

0 comments on commit 52e6474

Please sign in to comment.