node package manager

osmium

Node.js bindings to Osmium

node-osmium

Flexible Javascript library for working with OpenStreetMap data.

Provides bindings to the libosmium C++ library.

If you want top performance use libosmium directly in C++. These node-osmium bindings, due to the expense of passing objects from C++ to Javascript, are much slower than working in C++ directly. Consider node-osmium only for small extracts and prototyping. For large extracts or planet processing we recommend leveraging the libosmium C++ API instead of using node-osmium.

@springmeyer and @joto are maintaining node-osmium but not actively adding features. We will consider pull requests adding features only when they come with very solid tests, add very clear value to the bindings, and seem easy to maintain.

  • Node.js v0.10.x, v4.x, or v5.x (v4 and v5 supported only with node-osmium >= 0.5.x)
  • libosmium (http://osmcode.org/libosmium, https://github.com/osmcode/libosmium)
  • protozero (https://github.com/mapbox/protozero) (The protozero headers are included in the libosmium repository, so if you used libosmium from git, protozero is already available.)
  • Mocha (http://visionmedia.github.io/mocha/, for tests)

By default, binaries are provided and no external dependencies or compile is needed.

Just do:

npm install osmium

We currently provide binaries for 64 bit OS X and 64 bit Linux. Running npm install on other platforms will fall back to a source compile (see Developing below for build details).

See the tutorial for an introduction. There are some demo applications in the 'demo' directory. See the README.md there. You can also have a look at the tests in the test directory.

If you wish to develop on node-osmium you can check out the code and then build like:

git clone https://github.com/osmcode/node-osmium.git
cd node-osmium
make

Use make debug to build with debug information. Use make coverage to build with code coverage.

Use make VERBOSE=1 to output compiler calls used etc.

npm install mocha
make test
  • Compiler that supports -std=c++11 (>= clang++ 3.4 || >= g++ 4.8)
  • libosmium
  • Boost >= 1.46 with development headers
  • zlib

See also the dependency information for the Osmium library.

Set dependencies up on Ubuntu Precise (12.04) like:

sudo apt-add-repository --yes ppa:chris-lea/node.js
sudo apt-add-repository --yes ppa:ubuntu-toolchain-r/test
sudo apt-get -y update
sudo apt-get -y install git gcc-4.8 g++-4.8 build-essential nodejs
sudo apt-get -y install libboost-dev zlib1g-dev libexpat1-dev libsparsehash-dev
export CC=gcc-4.8
export CXX=g++-4.8
git clone https://github.com/scrosby/OSM-binary.git
cd OSM-binary/src
make && sudo make install

Set dependencies up on OS X like:

git clone https://github.com/mapnik/mapnik-packaging.git
cd mapnik-packaging/osx
export CXX11=true
source MacOSX.sh
./scripts/build_bzip2.sh
./scripts/build_expat.sh
./scripts/build_google_sparsetable.sh
./scripts/build_boost.sh --with-test --with-program_options
./scripts/build_protobuf.sh
./scripts/build_osm-pbf.sh
# NOTE: in the same terminal then run the build commands 
# Or from a different terminal re-run `source MacOSX.sh` 

node-osmium is available under the Boost Software License. See LICENSE.txt for details.

Please open bug reports on https://github.com/osmcode/node-osmium/issues. You can ask questions on the OSM developer mailing list or on OFTC net IRC channel #osm-dev.