osm-clipper 0.1.0

Small python tool to clip pre-defined areas from the planet osm file.

OpenStreetMap clipper

Small python tool to clip pre-defined areas from large osm.pbf files, using osmconvert or osmosis.

The tool is at the moment specifically written to split OpenStreetMap Protocolbuffer Binary Format (PBF) files into a set of countries and/or regions, based on the GADM36 classification. Future versions will allow for user-defined regional classifications as well.

Please note: This package is still in development phase. In case of any problems, or if you have any suggestions for improvements, please raise an issue.

Installation

1. Open the python environment in your command prompt or bash in which you want to install this package.
2. Type pip install osm-clipper and it should install itself into your python environment.
3. Now you can import the package like any other package!

OR:

1. Clone the repository or download the package on your computer and extract the folder.
2. Go to the osm_clipper folder in your command prompt or bash.
3. Type python setup.py install and it should install itself into your python environment.
4. Now you can import the package like any other package!

Dependency on osmcovert or osmosis

In essence, osm_clipper is just a wrapper around osmconvert and osmosis. To make it work, make sure you add either osmconvert or osmosis to your environmental variables.

How to set environmental variables on Windows:

1. Search for Edit the System Environmental Variables and click on it.
2. Click on the Environmental Variables button.
3. Search in your System variables for Path.
4. Click on the New button and add the location of osmconvert and/or osmosis.

NOTE: the default is osmconvert. If you want to use osmosis, specify osmconvert==False in the single_countries or all_countries functions.

License

Copyright (C) 2020 Elco Koks. All versions released under the MIT license.