From 09943cf4807bf9aa80d48a7332b0b235b4eb6f4a Mon Sep 17 00:00:00 2001 From: Anshul Singhvi Date: Sat, 2 Mar 2024 06:29:59 +0530 Subject: [PATCH] Flesh out the README --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d3fac08d0..8da19ca9d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Screenshot 2024-03-01 at 4 20 14 PM +GeometryOps.jl ![Lifecycle:Experimental](https://img.shields.io/badge/Lifecycle-Experimental-339999) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://asinghvi17.github.io/GeometryOps.jl/stable/) @@ -7,11 +7,14 @@ GeometryOps logo +> [!CAUTION] +> This package is still under very heavy development! Use with care. + GeometryOps.jl is a package for geometric calculations on (primarily 2D) geometries. -The driving idea behind this package is to unify all the disparate packages for geometric calculations in Julia, and make them [GeoInterface.jl](https://github.com/JuliaGeo/GeoInterface.jl)-compatible. We seem to be focusing primarily on 2/2.5D geometries for now. +The driving idea behind this package is to unify all the disparate packages for geometric calculations in Julia, and make them [GeoInterface.jl](https://github.com/JuliaGeo/GeoInterface.jl)-compatible. We are focusing primarily on 2/2.5D geometries for now. All methods in this package will consume any geometry which is compatible with GeoInterface - see its [integrations page](https://juliageo.org/GeoInterface.jl/stable/reference/integrations/) for more info on that! -Most of the usecases are driven by GIS and similar Earth data workflows, so this might be a bit specialized towards that, but methods should always be general to any coordinate space. +Most of the use cases are driven by GIS and similar Earth data workflows, so this might be a bit specialized towards that, but methods should always be general to any coordinate space. We welcome contributions, either as pull requests or discussion on issues! @@ -20,7 +23,7 @@ We welcome contributions, either as pull requests or discussion on issues! GeometryOps tries to offer most of the basic geometry operations you'd need, implemented in pure Julia and accepting any GeoInterface.jl compatible type. - General geometry methods (OGC methods): `equals`, `extent`, `distance`, `crosses`, `contains`, `intersects`, etc -- Targeted function application over large nested geometries (`apply`) +- Targeted function application over large nested geometries (`apply`) and reduction over geometries (`applyreduce`) - `signed_area`, `centroid`, `distance`, etc for valid geometries - Line and polygon simplification (`simplify`) - Polygon clipping, `intersection`, `difference` and `union` @@ -33,7 +36,6 @@ See the "API" page in the docs for a more complete list! ### Planned additions - Arclength interpolation (absolute and relative) -- Buffering, hulls -- Some kind of `applyreduce` primitive ([#38](https://github.com/asinghvi17/GeometryOps.jl/issues/38)) +- Buffering, hulls (convex and otherwise) - Checks for valid geometries (empty linestrings, null points, etc) ([#14](https://github.com/asinghvi17/GeometryOps.jl/issues/14)) - Operations on spherical (non-Euclidean) geometry ([#17](https://github.com/asinghvi17/GeometryOps.jl/issues/17))