openzim / openzim/maps

Should we support search for streets, natural places, ...

Open
#35 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
19
Forks
5
Avg merge
4m
Merged PRs (30d)
2

Description

In maps 0.1.0, we have support for search of administrative divisions (cities, counties, regions, countries more or less - depends on country subdivision schema).

Do we wanna support:

  • search for streets?
  • search for natural places? (lakes, mountains, ...)

The potential problem regarding the streets is that it will inevitably grow the ZIM (not sure how much) and it does not seems that easy to find a free dataset of "name, lat, long". Maybe we can reuse Nominatim dataset or logic to create our own pre-processed dataset.

The potential problem with natural places it to make a distinction between relevant and un-relevant places, we tend to find tons of stuff. Geonames has most of this data, but we end up we tons of things, with a significant potential for noise in search results (especially since we rely on natural ZIM search which doesn't support specifying which type of "thing" you are searching for).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing administrative-division search in maps 0.1.0 and how its ZIM data is produced. Investigate the Nominatim and Geonames options mentioned, including dataset size and result relevance; done requires a decided scope and implementation approach for streets and/or natural places.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.