Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/developmentseed/rio-viz
Visualize Cloud Optimized GeoTIFF in browser
https://github.com/developmentseed/rio-viz
Last synced: 3 months ago
JSON representation
Visualize Cloud Optimized GeoTIFF in browser
- Host: GitHub
- URL: https://github.com/developmentseed/rio-viz
- Owner: developmentseed
- License: mit
- Created: 2019-04-23T20:15:55.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T06:58:47.000Z (7 months ago)
- Last Synced: 2024-05-16T02:34:15.080Z (6 months ago)
- Language: HTML
- Homepage:
- Size: 7.83 MB
- Stars: 150
- Watchers: 11
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-earthobservation-code - rio-viz - Visualize Cloud Optimized GeoTIFF in browser `html` `Python` (`Python` processing of optical imagery (non deep learning) / Cloud Native Geospatial)
README
# rio-viz
A Rasterio plugin to visualize Cloud Optimized GeoTIFF in browser.
## Install
You can install rio-viz using pip
```bash
$ pip install rio-viz
```
with 3d feature
```bash
# 3d visualization features is optional
$ pip install -U pip
$ pip install rio-viz["mvt"]
```
Build from source
```bash
$ git clone https://github.com/developmentseed/rio-viz.git
$ cd rio-viz
$ pip install -e .
```
## CLI
```bash
$ rio viz --help
Usage: rio viz [OPTIONS] SRC_PATH
Rasterio Viz cli.
Options:
--nodata NUMBER|nan Set nodata masking values for input dataset.
--minzoom INTEGER Overwrite minzoom
--maxzoom INTEGER Overwrite maxzoom
--port INTEGER Webserver port (default: 8080)
--host TEXT Webserver host url (default: 127.0.0.1)
--no-check Ignore COG validation
--reader TEXT rio-tiler Reader (BaseReader). Default is `rio_tiler.io.COGReader`
--layers TEXT limit to specific layers (only used for MultiBand and MultiBase Readers). (e.g --layers b1 --layers b2).
--server-only Launch API without opening the rio-viz web-page.
--config NAME=VALUE GDAL configuration options.
--help Show this message and exit.
```
## Multi Reader support
rio-viz support multiple/custom reader as long they are subclass of `rio_tiler.io.base.BaseReader`.
```bash
# Multi Files as Bands
$ rio viz "cog_band{2,3,4}.tif" --reader rio_viz.io.MultiFilesBandsReader
# Simple Mosaic
$ rio viz "tests/fixtures/mosaic_cog{1,2}.tif" --reader rio_viz.io.MosaicReader
# MultiBandReader
# Landsat 8 - rio-tiler-pds
# We use `--layers` to limit the number of bands
$ rio viz LC08_L1TP_013031_20130930_20170308_01_T1 \
--reader rio_tiler_pds.landsat.aws.landsat8.L8Reader \
--layers B1,B2 \
--config GDAL_DISABLE_READDIR_ON_OPEN=FALSE \
--config CPL_VSIL_CURL_ALLOWED_EXTENSIONS=".TIF,.ovr"
# MultiBaseReader
# We use `--layers` to limit the number of assets
rio viz https://earth-search.aws.element84.com/v0/collections/sentinel-s2-l2a-cogs/items/S2A_34SGA_20200318_0_L2A \
--reader rio_tiler.io.STACReader \
--layers B04,B03,B02
```
## RestAPI
When launching rio-viz, the application will create a FastAPI application to access and read the data you want. By default the CLI will open a web-page for you to explore your file but you can use `--server-only` option to ignore this.
```bash
$ rio viz my.tif --server-only
# In another console
$ curl http://127.0.0.1:8080/info | jq
{
"bounds": [6.608576517072109, 51.270642883468895, 11.649386808679436, 53.89267160832534],
"band_metadata": [...],
"band_descriptions": [...],
"dtype": "uint8",
"nodata_type": "Mask",
"colorinterp": [
"red",
"green",
"blue"
]
}
```
You can see the full API documentation over `http://127.0.0.1:8080/docs`
## In Notebook environment
Thanks to the awesome [server-thread](https://github.com/banesullivan/server-thread) we can use `rio-viz` application in Notebook environment.
```python
import time
import httpx
from folium import Map, TileLayer
from rio_viz.app import Client
# Create rio-viz Client (using server-thread to launch backgroud task)
client = Client("https://data.geo.admin.ch/ch.swisstopo.swissalti3d/swissalti3d_2019_2573-1085/swissalti3d_2019_2573-1085_0.5_2056_5728.tif")
# Gives some time for the server to setup
time.sleep(1)
r = httpx.get(
f"{client.endpoint}/tilejson.json",
params = {
"rescale": "1600,2000", # from the info endpoint
"colormap_name": "terrain",
}
).json()
bounds = r["bounds"]
m = Map(
location=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),
zoom_start=r["minzoom"]
)
aod_layer = TileLayer(
tiles=r["tiles"][0],
opacity=1,
attr="Yo!!"
)
aod_layer.add_to(m)
m
```
## 3D (Experimental)
rio-viz supports Mapbox VectorTiles encoding from a raster array. This feature was added to visualize sparse data stored as raster but will also work for dense array. This is highly experimental and might be slow to render in certain browser and/or for big rasters.
## Docker
Ready to use docker image can be found on Github registry.
- https://github.com/developmentseed/rio-viz/pkgs/container/rio-viz
```bash
docker run \
--volume "$PWD":/data \
--platform linux/amd64 \
--rm -it -p 8080:8080 ghcr.io/developmentseed/rio-viz:latest \
rio viz --host 0.0.0.0 /data/your-file.tif
```
Notes:
- `--platform linux/amd64` is only needed if you are using latest MacOS M1 machines
- `--volume "$PWD":/data` is needed to mount your local directory to the docker image
- rio-viz's option `--host 0.0.0.0` is required to access the web server
## Contribution & Development
See [CONTRIBUTING.md](https://github.com/developmentseed/rio-viz/blob/main/CONTRIBUTING.md)
## Authors
Created by [Development Seed]()
## Changes
See [CHANGES.md](https://github.com/developmentseed/rio-viz/blob/main/CHANGES.md).
## License
See [LICENSE.txt](https://github.com/developmentseed/rio-viz/blob/main/LICENSE)