Libosmium

A fast and flexible C++ library for working with OpenStreetMap data.

Libosmium is developed on Linux, but also works on OSX and Windows (with some limitations).

There are a few applications that use the Osmium library in the examples directory. See the osmium-contrib repository for more example code.

Prerequisites

Because Libosmium uses many C++11 features you need a modern compiler and standard C++ library. Osmium needs at least GCC 4.8 or clang (LLVM) 3.4. (Some parts may work with older versions.)

Different parts of Libosmium (and the applications built on top of it) need different libraries. You DO NOT NEED to install all of them, just install those you need for your programs.

For details see the list of dependencies.

The following external (header-only) libraries are included in the libosmium repository:

If you want (some of) those libraries to be installed along with libosmium itself when calling make install, you have to use the CMake options INSTALL_GDALCPP, INSTALL_PROTOZERO, and/or INSTALL_UTFCPP.

Directories

benchmarks: Some benchmarks checking different parts of Libosmium.
cmake: CMake configuration scripts.
doc: Config for documentation.
examples: Osmium example applications.
include: C/C++ include files. All of Libosmium is in those header files which are needed for building Osmium applications.
test: Tests (see below).

Building

Osmium is a header-only library, so there is nothing to build for the library itself.

But there are some tests and examples that can be build. Libosmium uses cmake:

mkdir build
cd build
cmake ..
make

This will build the examples and tests. Call ctest to run the tests.

For more see the Libosmium Wiki.

Testing

See the Libosmium Wiki for instructions.

Osmium on 32bit Machines

Osmium works well on 64 bit machines, but on 32 bit machines there are some problems. Be aware that not everything will work on 32 bit architectures. This is mostly due to the 64 bit needed for node IDs. Also Osmium hasn't been tested well on 32 bit systems. Here are some issues you might run into:

Google Sparsehash does not work on 32 bit machines in our use case.
The mmap system call is called with a size_t argument, so it can't give you more than 4GByte of memory on 32 bit systems. This might be a problem.

Please report any issues you have and we might be able to solve them.