From 59d39da1763fd26c34c18dfc4d775f3897b5ffd0 Mon Sep 17 00:00:00 2001 From: Daniel Graf Date: Sat, 21 Feb 2026 06:07:16 +0100 Subject: [PATCH 1/3] docs: update README for import script and remove Reitti integration section - Adjusted import script example to use named parameters for clarity. - Removed outdated Reitti integration instructions and replaced with placeholder text. --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 03c11b3..3b0d5b5 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,7 @@ docker run -d \ ```bash # Filter and import a country extract ./scripts/filter_osm.sh germany-latest.osm.pbf germany-filtered.osm.pbf -./scripts/import.sh germany-filtered.osm.pbf ./data 16g +./scripts/import.sh germany-filtered.osm.pbf --data-dir ./data --memory 16g # Import planet data with custom settings ./scripts/filter_osm.sh planet-latest.osm.pbf planet-filtered.osm.pbf @@ -230,15 +230,7 @@ curl 'http://localhost:8080/api/v1/geometry/12345' ## Integration with Reitti -To use PAIKKA with Reitti, configure the geocoding service in Reitti's settings: - -1. Start PAIKKA service on your server -2. Set the admin password in your configuration -3. In Reitti, go to Settings → Geocoding -4. Add a new geocoding service: - - **Name**: PAIKKA - - **URL**: `http://your-paikka-server:8080/api/v1/reverse?lat={lat}&lon={lon}` - - **Priority**: Set as primary service +TBA ## Getting Support From 6181669547a167891cadfbce4bfda6bc9f3bc64e Mon Sep 17 00:00:00 2001 From: "Daniel Graf (aider-ce)" Date: Sat, 21 Feb 2026 06:11:44 +0100 Subject: [PATCH 2/3] docs: Add detailed explanation of PAIKKA's opinionated POI filtering in Limitations section --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 3b0d5b5..2500e01 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,32 @@ Standard geocoding solutions often fall short for specific personal tracking nee - Boundary data is dependent on availability within the source nodes. - Optimized for read-heavy serving; updates require re-importing prepared data. - Focused strictly on reverse geocoding (coordinates to place). +- **Highly Opinionated POI Selection:** PAIKKA is deliberately selective about which Points of Interest it imports. It only includes POIs with the following OSM tags: + - `amenity` (e.g., restaurant, school, hospital, fuel, atm) + - `shop` (e.g., supermarket, clothes, bakery) + - `tourism` (e.g., hotel, museum, attraction) + - `leisure` (e.g., fitness_centre, playground, park) + - `office` (e.g., company, government, insurance) + - `craft` (e.g., carpenter, electrician, painter) + - `healthcare` (e.g., hospital, pharmacy, clinic) + - `emergency` (e.g., ambulance_station, fire_hydrant) + - `historic` (e.g., monument, archaeological_site) + - `natural` (e.g., peak, cave, waterfall) + - `man_made` (e.g., tower, pier, windmill) + - `place` (e.g., city, town, village, neighbourhood) + - `sport` (e.g., tennis, swimming, fitness) + - `public_transport` (e.g., stop_position, station) + - `railway` (stations only) + - `aeroway` (e.g., aerodrome, helipad) + - `building` (commercial, retail, industrial, office - but not residential or generic "yes") + + Many common OSM features are explicitly excluded, such as: + - Residential buildings and landuse + - Natural features like trees and grass + - Amenities like benches, drinking water, and picnic tables + - Swimming pools and fountains + + If you need comprehensive POI coverage including all OSM features, **Nominatim** would be a better fit for your use case. While it would be technically possible to import the complete unfiltered dataset, this was never the intended design and has not been tested. ## Features From 30e299fe627b115fe3043ab8421f21d55d7eb343 Mon Sep 17 00:00:00 2001 From: Daniel Graf Date: Sat, 21 Feb 2026 06:15:39 +0100 Subject: [PATCH 3/3] docs: fix README typos and improve consistency - Fixed spelling of "neighbourhood" to "neighborhood" for consistency. - Replaced hyphen with an en dash in lists for formatting consistency. - Updated exclusions section to include "electric-poles" and "trash cans." --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2500e01..f3b3cd1 100644 --- a/README.md +++ b/README.md @@ -36,16 +36,16 @@ Standard geocoding solutions often fall short for specific personal tracking nee - `historic` (e.g., monument, archaeological_site) - `natural` (e.g., peak, cave, waterfall) - `man_made` (e.g., tower, pier, windmill) - - `place` (e.g., city, town, village, neighbourhood) + - `place` (e.g., city, town, village, neighborhood) - `sport` (e.g., tennis, swimming, fitness) - `public_transport` (e.g., stop_position, station) - `railway` (stations only) - `aeroway` (e.g., aerodrome, helipad) - - `building` (commercial, retail, industrial, office - but not residential or generic "yes") + - `building` (commercial, retail, industrial, office – but not residential or generic "yes") Many common OSM features are explicitly excluded, such as: - - Residential buildings and landuse - Natural features like trees and grass + - Man-made structures like electric-poles, trash cans - Amenities like benches, drinking water, and picnic tables - Swimming pools and fountains @@ -53,8 +53,7 @@ Standard geocoding solutions often fall short for specific personal tracking nee ## Features -- **Planet-scale data processing** - Import and process complete OpenStreetMap datasets -- **High-performance geocoding** – Fast and efficient reverse geocoding +- **High performance geocoding** – Fast and efficient reverse geocoding - **RESTful API** – Simple HTTP endpoints for geocoding operations - **Web Dashboard** – Administrative interface for monitoring and statistics - **Boundary support** – Administrative boundary data for hierarchical location information