Skip to content

Commit faf07f7

Browse files
committed
README
1 parent 7559bec commit faf07f7

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,38 @@
1-
# Jupyter Server TiTiler (`jupyter-server-titiler`)
1+
# Jupyter MicroGIS
22

33
[![Github Actions Status](https://github.com/geojupyter/jupyter-server-titiler/workflows/Build/badge.svg)](https://github.com/geojupyter/jupyter-server-titiler/actions/workflows/build.yml)
44

5-
A Jupyter Server extension which runs TiTiler.
5+
> [!IMPORTANT]
6+
> This repository is experimental and in the prototype stage.
7+
> Expect nothing to work.
8+
9+
A Jupyter extension which provides a barebones read-only GIS experience from Xarray and
10+
GeoPandas objects in a widget.
11+
12+
Goals:
13+
14+
* Serve users' simplest reasons for leaving JupyterLab for QGIS to make a cloud-only
15+
workflow more comfortable
16+
* Simple API with usable defaults (`explore(ds, ds, gdf, { data: gdf, symbology: "choropleth"}`)
17+
* Re-arrange, show/hide, change transparency of layers
18+
19+
Stretch goals:
20+
21+
* Data discovery interface to find and visualize public datasets alongside your
22+
Python data objects
23+
* Simple symbology editing
24+
25+
Non-goals:
26+
27+
* Exporting maps
28+
* Data analysis (use a Notebook!)
29+
* Advanced Symbology
630

731
This extension is composed of a Python package named `jupyter_server_titiler`
832
for the server extension and an NPM package named `jupyter-server-titiler`
933
for the frontend extension.
1034

35+
1136
## Requirements
1237

1338
- JupyterLab >= 4.0.0

0 commit comments

Comments
 (0)