Awesome Open Source
Awesome Open Source

build npm version

name-suggestion-index

Canonical features for OpenStreetMap

What is it?

The goal of this project is to maintain a canonical list of commonly used features for suggesting consistent spelling and tagging in OpenStreetMap.

Watch the video from our talk at State of the Map US 2019 to learn more about this project!

Browse the index

You can browse the index at https://nsi.guide/.

How it's used

When mappers create features in OpenStreetMap, they are not always consistent about how they name and tag things. For example, we may prefer McDonald's tagged as amenity=fast_food but we see many examples of other spellings (Mc Donald's, McDonalds, McDonald’s) and taggings (amenity=restaurant).

Building a canonical feature index allows two very useful things:

  • We can suggest the most "correct" way to tag things as users create them while editing.
  • We can scan the OSM data for "incorrect" features and produce lists for review and cleanup.
Name Suggestion Index in use in iD

The name-suggestion-index is in use in iD when adding a new item

Currently used in:

About the index

Generated files (do not edit):

The files under dist/* are generated:

  • dist/nsi.json - The complete index
  • dist/dissolved.json - List of items that we believe may be dissolved based on Wikidata claims
  • dist/taginfo.json - List of all tags this project supports (see: https://taginfo.openstreetmap.org/)
  • dist/wikidata.json - Cached data retrieved from Wikidata
  • dist/collected/* - Frequently occuring tags collected from OpenStreetMap
  • dist/config/* - A copy of the config files (see below)
  • dist/filtered/* - Subset of tags that we are keeping or discarding
  • dist/presets/* - Preset files generated for iD and JOSM editors

Source files (edit these):

The files under config/*, data/*, and features/* can be edited:

  • config/*:
    • config/genericWords.json - Regular expressions used to find and discard generic names
    • config/matchGroups.json - Groups of OpenStreetMap tags that are considered equivalent for purposes of matching
    • config/replacements.json - Mapping of old Wikidata QIDs map to their replacement new Wikidata and Wikipedia values.
    • config/trees.json - Metadata about subtrees in this project, and regular expressions used to keep and discard tags
  • data/* - Data files for each kind of feature, organized by topic and OpenStreetMap tag
    • data/brands/**/*.json
    • data/flags/**/*.json
    • data/operators/**/*.json
    • data/transit/**/*.json
    • and so on…
  • features/* - GeoJSON files that define custom regions where the features are allowed
    • features/us/new_jersey.geojson
    • features/ca/quebec.geojson
    • and so on…

👉 See CONTRIBUTING.md for info about how to contribute to this index.

Downloading the index files:

You can download the files from the index directly from GitHub or use a CDN.

Latest published release (stable forever):

Direct from GitHub (docs):

https://raw.githubusercontent.com/osmlab/name-suggestion-index/{branch or tag}/{path to file}
https://raw.githubusercontent.com/osmlab/name-suggestion-index/v4.0.2/dist/name-suggestions.presets.min.xml

Via JSDelivr CDN (docs):

https://cdn.jsdelivr.net/npm/[email protected]{semver}/{path to file}
https://cdn.jsdelivr.net/npm/[email protected]/dist/name-suggestions.presets.min.xml
Current development version (breaks sometimes!):

Direct from GitHub (docs):

https://raw.githubusercontent.com/osmlab/name-suggestion-index/{branch or tag}/{path to file}
https://raw.githubusercontent.com/osmlab/name-suggestion-index/main/dist/presets/nsi-josm-presets.min.xml

Via JSDelivr CDN (docs):

https://cdn.jsdelivr.net/gh/[email protected]{branch or tag}/{path to file}
https://cdn.jsdelivr.net/gh/osmlab/[email protected]/dist/presets/nsi-josm-presets.min.xml

Participate!

We're always looking for help! If you have any questions or want to reach out to a maintainer, ping bhousel on:

Prerequisites

  • Node.js version 10 or newer
  • git for your platform

Installing

  • Clone this project, for example: git clone [email protected]:osmlab/name-suggestion-index.git
  • cd into the project folder,
  • Run npm install to install libraries

Building the index

  • npm run build
    • Processes any custom locations under features/**/*.geojson
    • Regenerates dist/filtered/* keep and discard lists
    • Any new items from the keep list not already present in the index will be merged into it
    • Outputs many warnings to suggest updates to data/**/*.json

Building nsi.guide

https://nsi.guide/ is a web application written in ReactJS that lets anyone browse the index.

  • The source code for this app can be found under app/*
  • npm run appbuild will rebuild it.

Other commands

  • npm run wikidata - Fetch useful data from Wikidata - labels, descriptions, logos, etc.
  • npm run dist - Rebuild and minify the generated files in the dist/ folder.
  • npm run - Lists other available commands

Collecting names from planet

This takes a long time and a lot of disk space. It can be done occasionally by project maintainers. You do not need to do these steps in order to contribute to the index.

  • Install osmium command-line tool and node package (may only be available on some environments)
    • apt-get install osmium-tool or brew install osmium-tool or similar
    • npm install --no-save osmium
  • Download the planet
    • curl -L -o planet-latest.osm.pbf https://planet.openstreetmap.org/pbf/planet-latest.osm.pbf
  • Prefilter the planet file to only include named items with keys we are looking for:
    • osmium tags-filter planet-latest.osm.pbf -R name,brand,operator,network -o filtered.osm.pbf
  • Run node scripts/collect_all.js /path/to/filtered.osm.pbf
    • results will go in dist/collected/*.json
  • A new challenge:
    • Attempt an npm run build. Now that unique id properties are generated, it is possible that this command will fail.
    • This can happen if there are multiple new items that end up with the same id (e.g. "MetroBus" vs "Metrobus")
    • You'll need to just pick one to keep, then keep trying to run npm run build until the duplicate id issues are gone.
    • git add . && git commit -m 'Collected common names from latest planet'

License

name-suggestion-index is available under the 3-Clause BSD License. See the LICENSE.md file for more details.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (68,103
openstreetmap (132
osm (40
transit (32
flags (26
operators (16

Find Open Source By Browsing 7,000 Topics Across 59 Categories