geello 0.2.0

<div align="center">

# Geello


Geello (Ge**O_V**ello) try to render geo data through [GEO](https://github.com/georust/geo) and [VELLO](https://github.com/linebender/vello)

![Geello](assets/logo.png)

</div>

> [!WARNING]
> Geello is a testing project in an alpha state.
>

### v0.3.0 Work


- [ ] Calc image size with x/y resolution or WMTS zoom
- [ ] More Renderer, graph renderer
- [ ] More Renderer, animation renderer
- [ ] More docs

### As a library


Geello can be used as a library to render geo data into a texture.

1. Use `RenderedGeometry::new()` to create new geometry.

1. Read file or Create a `RenderOption`.

1. Set some options, like `RenderRegion` or `Transform`.

1. Get `Vello values` just like `Vello`.

1. Run one of functions below, or with `_with_new_texture`.

1. Use return value to draw on canvas or encode to file.

```rust
geello::render_to_texture(
    geoms: &mut Vec<RenderedGeometry>,
    device: &Device,
    queue: &Queue,
    renderer: &mut Renderer,
    texture: &Texture,
    transform: Affine,
    option: &RenderOption,
)
```

```rust
geello::render_to_buffer(
    geoms: &mut Vec<RenderedGeometry>,
    device: &Device,
    queue: &Queue,
    renderer: &mut Renderer,
    texture: &Texture,
    transform: Affine,
    option: &RenderOption,
)
```

### As a server


Geello can be used as a server to provide map render (real-time/cache) services like WMTS/WMS.

```bash
cargo r --release --features server
```

#### WMTS LIKE


```rust
// real-time
http://addr:port/wmts/real-time

// cache
http://addr:port/wmts/cache

//params
layers=${/path/to/json} // use `,` split multi layer, render as order
styles=${/path/to/render_option} // render_option to filter rendered geometry
x=${x}
y=${y}
z=${z}
format=${format} // like image/png or png
```

#### WMS LIKE


```rust
http://addr:port/wms

// params
layers=${/path/to/json} // use `,` split multi layer, render as order
styles=${/path/to/render_option} // render_option to filter rendered geometry
format=${format} // like image/png or png
width=${width}
height=${height}
bbox=${bbox}
```

#### What's More -> Animation Or Dynamic Data


Geello use web socket to handle real-time animation or dynamic data.

Such as a point that grows from small to large for representing importance.

Or a real-time route of a car.

```rust
ws://addr:port/ws/anim

// params
layers=${/path/to/json} // use `,` split multi layer, render as order
styles=${/path/to/render_option} // render_option to filter rendered geometry
format=${format} // like image/png or png
width=${width}
height=${height}
bbox=${bbox}
```

#### Web Map example


When run as server, Geello provides a web map example by open http://addr:port/map/index.html in browser.

### Docker


Package Page: [geello](https://github.com/DeadPoetSpoon/geello/pkgs/container/geello)

Run the docker image:

> [!WARNING]
> Need [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) installed
>
> Some how docker need xhost to Xserver access, WGPU need that to use GPU otherwise will use CPU, find some issues and docs:
>
> [wgpu/issues/2123-1012233430](https://github.com/gfx-rs/wgpu/issues/2123#issuecomment-1012233430): get the reason
>
> [wgpu/issues/2123-1428961445](https://github.com/gfx-rs/wgpu/issues/2123#issuecomment-1428961445): answer the question
>
> [archlinux docs](https://wiki.archlinux.org/title/Docker#Run_graphical_programs_inside_a_container): how to enable Xserver access, need [xhost](https://wiki.archlinuxcn.org/wiki/Xhost) installed
>

```bash
docker run --rm --gpus all -e "DISPLAY=:0.0" -e "GEELLO_ADDRESS=0.0.0.0" --mount type=bind,src=/tmp/.X11-unix,dst=/tmp/.X11-unix --device=/dev/dri:/dev/dri -p 8000:8000 ghcr.io/deadpoetspoon/geello:latest
```

### Contributing


Please!

### License


The code is available under the [MIT license](./LICENSE).