Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
irees committed Jul 13, 2018
1 parent dca010a commit 1f0918f
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ 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.

- 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 <command>
docker run --rm -v ${PWD}/data:/data -t interline/planetutils:release-v0.4.0 <command>
```

### Using Homebrew on Mac OS
Expand All @@ -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/)
Expand Down Expand Up @@ -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).
Expand Down

0 comments on commit 1f0918f

Please sign in to comment.