|
1 | 1 | # ipyopenlayers |
2 | 2 |
|
3 | | -[](https://travis-ci.org/QuantStack/ipyopenlayers) |
4 | | -[](https://codecov.io/gh/QuantStack/ipyopenlayers) |
| 3 | +[](https://ipyopenlayers.readthedocs.io/en/latest/?badge=latest) |
| 4 | +[](https://ipyopenlayers.readthedocs.io/en/latest/lite/lab/index.html) |
5 | 5 |
|
6 | | -OpenLayers Jupyter Widget |
| 6 | +A Jupyter / Openlayers bridge enabling interactive maps in the Jupyter notebook. |
| 7 | + |
| 8 | +## Usage |
| 9 | + |
| 10 | +### Adding Raster Tile Layers and Controlling Zoom on the Map |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +This GIF demonstrates how to add Raster Tile layers to the map and control the zoom functionality. |
| 15 | + |
| 16 | +### Adding Vector Tile Layers and Changing Their Style |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +This GIF shows how to add Vector Tile layers to the map and modify their style. |
| 21 | + |
| 22 | +### GeoJSON Layer |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | +This image illustrates how to add a GeoJSON layer to the map. |
| 27 | + |
| 28 | + |
| 29 | +## Example Repository |
| 30 | + |
| 31 | +For a real-world example of how to use `ipyopenlayers`, check out this [electricity dashboard project](https://github.com/Nour-Cheour10/electricitymap_dashboard.git). |
| 32 | + |
| 33 | +This project showcases the integration of `ipyopenlayers` in an electricity dashboard application, demonstrating a use case of the library. |
7 | 34 |
|
8 | 35 | ## Installation |
9 | 36 |
|
@@ -75,6 +102,22 @@ After a change wait for the build to finish and then refresh your browser and th |
75 | 102 |
|
76 | 103 | If you make a change to the python code then you will need to restart the notebook kernel to have it take effect. |
77 | 104 |
|
| 105 | +## Documentation |
| 106 | + |
| 107 | +To get started with using `ipyopenlayers`, check out the full documentation |
| 108 | + |
| 109 | +https://ipyopenlayers.readthedocs.io/ |
| 110 | + |
| 111 | +## Try it Online |
| 112 | + |
| 113 | +You can try ipyopenlayers below, or open many other live examples in a new browser tab with JupyterLite. |
| 114 | + |
| 115 | +- [JupyterLite](https://ipyopenlayers.readthedocs.io/en/latest/lite/lab/index.html) |
| 116 | + |
| 117 | +[](https://ipyopenlayers.readthedocs.io/en/latest/lite/lab/index.html) |
| 118 | + |
| 119 | + |
| 120 | + |
78 | 121 | ## Updating the version |
79 | 122 |
|
80 | 123 | To update the version, install tbump and use it to bump the version. |
|
0 commit comments