Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 5.11 KB

INSTALL.md

File metadata and controls

105 lines (70 loc) · 5.11 KB
Raw

Installation

OpenStreetMap data

You need OpenStreetMap data loaded into a PostGIS database (see below for dependencies). These stylesheets currently work only with the osm2pgsql defaults (i.e. database name is gis, table names are planet_osm_point, etc).

It's probably easiest to grab an PBF of OSM data from Mapzen or geofabrik. Once you've set up your PostGIS database, import with osm2pgsql:

osm2pgsql -d gis ~/path/to/data.osm.pbf --style openstreetmap-carto.style

You can find a more detailed guide to setting up a database and loading data with osm2pgsql at switch2osm.org.

Custom indexes

Custom indexes are not required, but will speed up rendering, particularly for full planet databases, heavy load, or other production environments. They will not be as helpful with development using small extracts.

psql -d gis -f indexes.sql

Additionally you need some shapefiles.

Scripted download

To download the shapefiles you can run the following script from this directory. No further steps should be needed as the data has been processed and placed in the requisite directories.

./get-shapefiles.sh

Manual download

You can also download them manually at the following paths:

The repeated www.naturalearthdata.com in the Natural Earth shapefiles is correct.

Put these shapefiles at path/to/openstreetmap-carto/data.

Fonts

The stylesheet depends on a number of openly licensed fonts for support of all the languages found on the map. The package which supplies these fonts on Ubuntu 16.04 or Debian Testing is indicated.

If a font is missing, it will skip to the next available font which contains those characters. If you are not concerned with a particular script, you do not need its fonts. DejaVu Sans and Unifont are the two required fonts, and included on most systems.

Mapnik 3 is required for acceptable rendering of most non-Latin scripts, particularly those with complicated diacritics and tone marks.

Global

  • DejaVu Sans, for most languages (fonts-dejavu-core)
  • Droid Sans Fallback, as a reasonable fallback (fonts-droid-fallback)
  • Unifont, as a last resort fallback (ttf-unifont)

Southeast Asia

  • Arundina, for Thai (fonts-sipa-arundina)
  • Padauk, for Burmese (fonts-sil-padauk)
  • Khmer OS Metal Chrieng Regular, for Khmer (fonts-khmeros)

South Asia

  • Mukti Narrow, for Bangali (fonts-beng-extra)
  • Gargi Medium, for Devanagari (fonts-gargi)
  • TSCu_Paranar, for Tamil (fonts-taml-tscu)
  • Tibetan Machine Uni, for Tibetian (fonts-tibetan-machine)

On Ubuntu 16.04 or Debian Testing you can install all the fonts with

sudo apt-get install fonts-dejavu-core fonts-droid-fallback ttf-unifont \
  fonts-sipa-arundina fonts-sil-padauk fonts-khmeros \
  fonts-beng-extra fonts-gargi fonts-taml-tscu fonts-tibetan-machine

On Ubuntu 14.04, replace fonts-droid-fallback with fonts-droid.

Dependencies

For development, a style design studio is needed.

  • Kosmtik - Kosmtik can be launched with node index.js serve path/to/openstreetmap-carto/project.yaml
  • TileMill - This is a TileMill project you can copy (or symlink) directly into your Mapbox/project directory

For deployment, carto and Mapnik are required.

  • carto >= 0.9.5 (we're using instances with cascading rules and min/max zoom properties)
  • mapnik >= 2.1.0. Mapnik 3.0 is supported, but not required.

For both development and deployment, a database and some utilities are required

  • osm2pgsql to import your data into a PostGIS database
  • PostgreSQL
  • PostGIS
  • curl and unzip for downloading and decompressing files
  • shapeindex (a companion utility to Mapnik found in the mapnik-utils package) for indexing downloaded shapefiles

Development dependencies

Some colours, SVGs and other files are generated with helper scripts. Not all users will need these dependencies

  • Python and Ruby to run helper scripts
  • PyYAML if editing the MML (layer definition) file (packaged as python-yaml on Ubuntu, or installed with pip install pyyaml)
  • Color Math and numpy if running generate_road_colors.py helper script (may be obtained with pip install colormath numpy)