From 1f0918f7c4ab15df1f2dcecc1d892970ac98aae0 Mon Sep 17 00:00:00 2001 From: Ian Rees Date: Fri, 13 Jul 2018 10:35:56 -0700 Subject: [PATCH] Readme updates --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 46e8385..ea3bcee 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ PlanetUtils is a "high level" library that makes use of [Osmosis](https://wiki.o Make sure you have [Docker](https://www.docker.com/community-edition) installed. Then: ```sh -docker pull interline/planetutils:release-v0.3.2 +docker pull interline/planetutils:release-v0.4.0 ``` Any of the example commands below can be executed with `docker run`. It may be helpful to mount a local directory inside the container for persistence and to access output files. @@ -65,7 +65,7 @@ Any of the example commands below can be executed with `docker run`. It may be h - Example of using `docker run` with the `data` directory mounted as `/data`: ```sh -docker run --rm -v ${PWD}/data:/data -t interline/planetutils:release-v0.3.2 +docker run --rm -v ${PWD}/data:/data -t interline/planetutils:release-v0.4.0 ``` ### Using Homebrew on Mac OS @@ -81,8 +81,7 @@ brew install interline-io/planetutils/planetutils If you want to install and use the Python package directly, you'll need to provide: - Python 2.x -- Java -- [Osmosis](https://wiki.openstreetmap.org/wiki/Osmosis) +- Java and [Osmosis](https://wiki.openstreetmap.org/wiki/Osmosis) - [OSM C tools](https://gitlab.com/osm-c-tools/osmctools/) - [Osmium Tool](https://osmcode.org/osmium-tool/) - [PyOsmium](https://osmcode.org/pyosmium/) @@ -280,6 +279,10 @@ PlanetUtils wraps up a number of libraries, including Osmosis, Osmium, and OSM C | `osm_planet_update` | `--toolchain` | `osmosis` | `osmosis`, `osmium` | | `osm_planet_extract` | `--toolchain` | `osmosis` | `osmosis`, `osmium`, `osmctools` | +If you are using `osm_planet_extract` with `--toolchain=osmium`, you can also use the `--strategy=` option to select `simple, complete_ways (default) or smart`. + +If you are using `osm_planet_update` with `--toolchain=osmium`, you can also use the `--size=` option to limit the amount of updates downloaded from the OSM replication server. Osmium requires this data to be held in memory. The default is `1024` megabytes. + ## Support To report a bug, please [open an issue](https://github.com/interline-io/planetutils).