Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/indoorequal/indoorequal

Generate vector tiles from OpenStreetMap indoor data
https://github.com/indoorequal/indoorequal

indoorequal openmaptiles openmaptiles-schema openstreetmap osm

Last synced: 3 months ago
JSON representation

Generate vector tiles from OpenStreetMap indoor data

Awesome Lists containing this project

README 

        
# indoor=



indoor= generate Mapbox's Vector Tiles (MVT) of [OpenStreetMap][osm] indoor data. It implements parts of [Simple Indoor Tagging][s-i-t].



Discover:



- [the frontend, indoorequal.org](https://github.com/indoorequal/indoorequal.org)

- [the library to integrate indoor=, maplibre-gl-indoorequal](https://github.com/indoorequal/maplibre-gl-indoorequal)

- [the library to integrate indoor=, openlayers-indoorequal](https://github.com/indoorequal/openlayers-indoorequal)

- [the vector tile schema](https://indoorequal.com/doc/schema)



indoor= is build with [openmaptiles-tools][omt-tools].



## Development



In development, you should disable tiles caching.



Edit `docker-compose.override.yml`:



    version: "3"

    services:

      postserve:

        ports:

        - "8090:8090"

      postserve-cache:



And follow the usage instructions.



You can also run tests written with [pgTAP][]:



    ./script/test



## Usage



### Import data from [OpenStreetMap][osm]



To start the initial import of the planet:



    ./script/import



To use another area than the planet, open `.env` file and update the `AREA` variable with the name of your area. Use `make list-geofabrik` to find the available names.

Then run `./script/import`.



### Import your own data



1. Prepare `.osm` file with [JOSM][] or other tool

1. Convert file to `.osm.pbf` with [osmium-tools][]: `osmium cat map.osm --output map.osm.pbf`

1. Put the map.osm.pbf file to the `./data` directory

1. Tune params in the `.env` file (`DIFF_MODE=false` and `AREA=map`)

1. Import data with `./script/import`



### Update data



To start a one-time update and invalidate the tile cache. With OSM data you probably want to update it regulary.



    ./script/update



### Generate mbtiles



To generate a mbtiles file located at `data/tiles.mbtiles`



    make generate-tiles-pg



Warning: Depending of the `AREA`, it can takes a lot of time to generate the mbtiles.



### Serve vector tiles



To run the service in production with tiles caching:



    docker-compose up -d postserve postserve-cache



The tiles will be available at http://localhost:8090/



To serve the tiles on another host than `localhost:8090`, for instance `indoorequal.org`, set `OMT_HOST=https://indoorequal.org` and `PPORT=443` to the `.env` file.



## License



All code in this repository is under the [BSD license](./LICENSE.md) and the cartography decisions encoded in the schema and SQL are licensed under [CC-BY](./LICENSE.md).



Products or services using maps derived from indoor= schema need to visibly credit "IndoorEqual.org" and "OpenMapTiles.org" or reference "indoor=" and "OpenMapTiles" with a link to https://indoorequal.org/ and https://openmaptiles.org/. Exceptions to attribution requirement can be granted on request.



For a browsable electronic map based on indoor=, OpenMapTiles and OpenStreetMap data, the

credit should appear in the corner of the map. For example:



[© indoor=](https://indoorequal.org/) [© OpenMapTiles](https://openmaptiles.org/) [© OpenStreetMap contributors](https://www.openstreetmap.org/copyright)



For printed and static maps a similar attribution should be made in a textual

description near the image, in the same fashion as if you cite a photograph.



[osm]: https://openstreetmap.org/

[s-i-t]: https://wiki.openstreetmap.org/wiki/Simple_Indoor_Tagging

[omt-tools]: https://github.com/openmaptiles/openmaptiles-tools

[pgtap]: https://pgtap.org/

[josm]: https://josm.openstreetmap.de/

[osmium-tools]: https://osmcode.org/osmium-tool/