\n\nWhat is Pelias?\n \nPelias is a search engine for places worldwide, powered by open data. It turns addresses and place names into geographic coordinates, and turns geographic coordinates into places and addresses. With Pelias, you’re able to turn your users’ place searches into actionable geodata and transform your geodata into real places.\n
\nWe think open data, open source, and open strategy win over proprietary solutions at any part of the stack and we want to ensure the services we offer are in line with that vision. We believe that an open geocoder improves over the long-term only if the community can incorporate truly representative local knowledge.\n\n\n# Pelias Polyline Importer\n\nThe polyline importer facilitates importing road network data in to Pelias from a list of [polyline encoded](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) line strings.\n\n## Prerequisites\n\nNode.js is required. See [Pelias software requirements](https://github.com/pelias/documentation/blob/master/requirements.md) for supported versions.\n\n## Clone and Install dependencies\n\nSince this module is just one part of our geocoder, we'd recommend starting with our [Dockerfiles](https://github.com/pelias/dockerfiles/) for quick setup, or our [full installation docs](https://github.com/pelias/pelias-doc/blob/master/installing.md) to use this module.\n\n```bash\n$ git clone https://github.com/pelias/polylines.git && cd polylines\n$ npm install\n```\n\n## Download data\n\nPre-processed planet-wide road network files are available to download from [Geocode Earth](https://geocode.earth/data#openstreetmap).\n\n> Note: the file extensions `.0sv` and `.polylines` are used interchangeably, they both refer to the same file format; however there is code that looks for the `.0sv` extension which is therefore preferable.\n\nFor more information on how the extract was generated, see the wiki article: [Generating polylines from Valhalla](https://github.com/pelias/polylines/wiki/Generating-polylines-from-Valhalla).\n\nWe also have some smaller extracts for testing purposes, a small number were manually cut from pbf for the geographies of our major contributors. See the 'Generating a custom polylines extract from a PBF extract' section below for more info on how you can generate your own extracts:\n\n**note:** these extracts were generated using a different method from the planet cut above.\n\n- [Berlin](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/berlin.gz) (1.9MB, 49k roads)\n- [New York](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/new_york.gz) (4.2MB, 102k roads)\n- [Finland](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/finland.gz) (7.7MB, 100k roads)\n- [Sweden](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/sweden.gz) (5.9MB, 126k roads)\n- [London](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/london.gz) (5.6MB, 166k roads)\n- [Paris](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/paris.gz) (2.9MB, 81k roads)\n- [San Francisco](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/san_francisco.gz) (1.3MB, 27k roads)\n- [New Zealand](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/new_zealand.gz) (3.1MB, 52k roads)\n- [Chicago](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/chicago.gz) (3.5MB, 88k roads)\n- [Singapore](https://s3.amazonaws.com/pelias-data.nextzen.org/polylines/singapore.gz) (0.6MB, 16k roads)\n\nOnce you have downloaded and extracted the data you will need to follow the *Configuration* steps below in order to tell Pelias where they can be found.\n\nIf you would like to use a different source of polyline data you might need to tweak the defaults in `./stream/pipeline.js`, open an issue if you get stuck.\n\n## Generating your own data\n\nYou can generate a polylines file from your own data, the data MUST be encoded in the following format:\n\n- each row of the file represents one document, rows are terminated with a newline (`\\n`) character.\n- rows contain multiple columns, columns are delimited with a null byte (`\\0`) character.\n\nThe geometry is encoded using the [Google polyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) at a precision of `6`.\n\nNOTE: many libraries will default the precision to `5`, this will cause errors, be sure to select the correct [polyline precision](https://www.mapzen.com/blog/polyline-precision/).\n\nThere is a script included in this repo which is capable of re-encoding files generated with precison `5` to precision `6`, you can find it in `bin/reencode.js`.\n\nEach row begins with the encoded polyline, followed by a null byte (`\\0`) then followed by one or more names (delimited with a null byte) and finally terminated with a newline (`\\n`).\n\nExample:\n\n```\n{polyline6}\\0{name}\\0{name}\\n\n```\n\n```\noozdnAwvbsBoA?g@{@SoAf@{@nAg@Plaça de la Creu\n```\n\n```\n00000000: 6f6f 7a64 6e41 7776 6273 426f 413f 6740 oozdnAwvbsBoA?g@\n00000010: 7b40 536f 4166 407b 406e 4167 4000 506c {@SoAf@{@nAg@.Pl\n00000020: 61c3 a761 2064 6520 6c61 2043 7265 750a a..a de la Creu.\n```\n\n## Configuration\n\nIn order to tell the importer the location of your downloads and environmental settings you will first need to create a `~/pelias.json` file.\n\nSee [the config](https://github.com/pelias/config) documentation for details on the structure of this file. Your relevant config info for the polyline module might look something like this:\n\n**note:** the importer currently only supports a single entry in the `files` array. Also, the config file **only** accepts \"polyline\" (without the \"s\").\n\n```javascript\n \"imports\": {\n \"polyline\": {\n \"datapath\": \"/data\",\n \"files\": [ \"road_network.0sv\" ]\n }\n }\n```\n\n### Administrative Hierarchy Lookup\n\nPolyline data doesn't have a full administrative hierarchy (ie, country, state,\ncounty, etc. names), but it can be calculated using data from [Who's on\nFirst](https://whosonfirst.org). See the [readme](https://github.com/pelias/wof-admin-lookup/blob/master/README.md)\nfor [pelias/wof-admin-lookup](https://github.com/pelias/wof-admin-lookup) for more information. By default,\nadminLookup is enabled. To disable, set `imports.adminLookup.enabled` to `false` in Pelias config.\n\n**Note:** Admin lookup requires loading around 5GB of data into memory.\n\n## Running an import\n\nThis will start the import process, it will take around 30 seconds to prime it's in-memory data and then you should see regular debugging output in the terminal.\n\n```bash\n$ PELIAS_CONFIG= npm start\n```\n\n## CLI tool\n\nYou can use the CLI tool to run imports and for debugging purposes:\n\n**note:** by default the cli tool will read from `stdin` and write to `stdout`.\n\n```bash\n$ node ./bin/cli.js --help\nUsage: cli.js [options]\nOptions:\n\n --file read from file instead of stdin\n --config read filename from pelias config (overrides --file)\n --pretty indent output (stdout only)\n --db save to elasticsearch instead of printing to stdout\n\n```\n\n### Examples\n\nRun a 'dry-run' of the import process:\n\n```bash\nnode ./bin/cli.js --config --pretty\n```\n\nImport a specific file to elasticsearch:\n\n```bash\nnode ./bin/cli.js --file=/tmp/myfile.polylines --db\n```\n\n### Generating a custom polylines extract from a PBF extract\n\nYou can generate a custom polylines extract using this [OSM PBF tool](https://github.com/missinglink/pbf).\n\nNote: golang 1.9+ is required, please ensure this is correctly installed before continuing.\n\n```\n$ go version\ngo version go1.10 linux/amd64\n\n$ go install github.com/missinglink/pbf@latest\n\n$ pbf --help\n\n$ wget https://s3.amazonaws.com/metro-extracts.nextzen.org/chicago_illinois.osm.pbf\n\n$ pbf streets chicago_illinois.osm.pbf | head\n\nyop}nApvc_gDqAywAEast Altgeld Avenue\nwto}nAfpl_gDqFuzEEast Altgeld Avenue\n_mr}nAbvb~fDkFmQ}BkQ}AkdBEast Altgeld Avenue\nmwp}nAt{q~fDKkW]yFi@mDwBcIeS_f@qE}LmDyMwAaH_AoE}C{Uy@mMYaHyCwlDSsFi@iFwEaUEast Altgeld Avenue\nsmvaoAzxdmfDwbAtyB}cAvzBscAzxBmcAhyB{j@pnAmE|HNorth Navarre Avenue\nwq~hoAvt~dgD?hGJfD\\fCl@zBr@dBrBbDv@jBx@hCpBtBBbCDnB@`@gBpC]jBEzCF~BL~AdBxH?VKpSHidden Lakes Boulevard\no~cooAb~}xfDn_@i^Taggert Court\n{garnA|_~zfDo@qdA}@kEWater Tower Lane\nka|}nAh`jlgDdD{C~MmNrByHTall Grass Court\nonvdnAbntyfDpMvOhHtCTall Grass Court\n\n\n$ pbf streets chicago_illinois.osm.pbf > chicago_illinois.polylines\n\n```\n\n## Issues\n\nIf you have any issues getting set up or the documentation is missing something, please open an issue here: https://github.com/pelias/polylines/issues\n\n## Contributing\n\nPlease fork and pull request against upstream master on a feature branch.\n\nPretty please; provide unit tests and script fixtures in the `test` directory.\n\n## Code Linting\n\nA `.jshintrc` file is provided which contains a linting config, usually your text editor will understand this config and give you inline hints on code style and readability.\n\nThese settings are strictly enforced when you do a `git commit`, you can execute `git commit` at any time to run the linter against your code.\n\n### Running Unit Tests\n\n```bash\n$ npm test\n```\n\n### Continuous Integration\n\nTravis tests every change against our supported Node.js versions.\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/pelias/design/master/logo/pelias_github/Github_markdown_hero.png\"){kind=logo}
\n![](\"https://img.shields.io/github/license/pelias/api?style=flat&color=orange\")
![](\"https://img.shields.io/docker/pulls/pelias/api?style=flat&color=informational\")
![](\"https://img.shields.io/gitter/room/pelias/pelias?style=flat&color=yellow\")