osm_map_processing/README.md

Overview
=
This project contains useful info/tools for processing OSM maps into the mapwriter file format (.map). It was developed to help generating offline map files for Locus on Android.

Dependencies / Prereqs
=
To run this program you'll need the following

* A Linux environment
* Python 3.x installed
* Java 1.8 or higher installed (OpenJDK works)
* wget installed
* bunzip2 installed (usually part of bzip2 package)

Installation
=
Head over to releases tab and download the latest. Extract the file and you're good to go. Everything is self-contained minus the above dependencies.

Running
=
To run the program, cd to the directory where you extracted the release and run './process_maps.py' with at least one '--map-list /path/to/list.txt parameter'. See the lists directory for examples on how to format the map list files.

Program Usage
=
```
usage: process_maps.py [-h] [--map-list MAP_LIST] [--no-sleep] [--use-ram]
                       [--max-heap-space MAX_HEAP_SPACE]
                       [--output-map-name OUTPUT_MAP_NAME]
                       [--cached-maps-dir CACHED_MAPS_DIR]

optional arguments:
  -h, --help            show this help message and exit
  --map-list MAP_LIST   a text file with one map URL per line, can be
                        specified more than once
  --no-sleep            don't sleep between downloads -- WARNING you can
                        easily run into throttling on mirrors if you use this
                        option
  --use-ram             use RAM for mapsforge processing -- WARNING mapsforge
                        uses 10x the map size in RAM for processing (ie. 100Mb
                        map = 1Gb RAM usage), you want a LOT of RAM for this
                        option
  --max-heap-space MAX_HEAP_SPACE
                        set the max heap space for the JVM, use standard -Xmx
                        values, default (4g) should be fine if not using
                        --use-ram argument
  --output-map-name OUTPUT_MAP_NAME
                        set the output .map and .poi file names
  --cached-maps-dir CACHED_MAPS_DIR
                        Use cached maps in the specified directory instead of
                        downloads using map lists
```

Licencing
=
All code is licensed Apache 2.0 and all non-code is licensed Creative Commons CC-BY-SA-3.0
Added notes that were used to create the tool 2016-01-12 19:12:34 +00:00			`Overview`
			`=`
Update docs to be more useful 2017-01-20 17:38:42 +00:00			`This project contains useful info/tools for processing OSM maps into the mapwriter file format (.map). It was developed to help generating offline map files for Locus on Android.`
Added notes that were used to create the tool 2016-01-12 19:12:34 +00:00
Update docs to be more useful 2017-01-20 17:38:42 +00:00			`Dependencies / Prereqs`
Added notes that were used to create the tool 2016-01-12 19:12:34 +00:00			`=`
Update docs to be more useful 2017-01-20 17:38:42 +00:00			`To run this program you'll need the following`
Added notes that were used to create the tool 2016-01-12 19:12:34 +00:00
Update docs to be more useful 2017-01-20 17:38:42 +00:00			`* A Linux environment`
			`* Python 3.x installed`
			`* Java 1.8 or higher installed (OpenJDK works)`
			`* wget installed`
			`* bunzip2 installed (usually part of bzip2 package)`

			`Installation`
			`=`
Fix typo in README 2017-01-20 17:40:34 +00:00			`Head over to releases tab and download the latest. Extract the file and you're good to go. Everything is self-contained minus the above dependencies.`
Update docs to be more useful 2017-01-20 17:38:42 +00:00
			`Running`
			`=`
			`To run the program, cd to the directory where you extracted the release and run './process_maps.py' with at least one '--map-list /path/to/list.txt parameter'. See the lists directory for examples on how to format the map list files.`

			`Program Usage`
			`=`
Fixup README formatting 2017-01-20 17:39:55 +00:00			```
Update docs to be more useful 2017-01-20 17:38:42 +00:00			`usage: process_maps.py [-h] [--map-list MAP_LIST] [--no-sleep] [--use-ram]`
Update readme for latest CLI args 2018-02-25 21:17:57 +00:00			`[--max-heap-space MAX_HEAP_SPACE]`
			`[--output-map-name OUTPUT_MAP_NAME]`
			`[--cached-maps-dir CACHED_MAPS_DIR]`
Update docs to be more useful 2017-01-20 17:38:42 +00:00
			`optional arguments:`
Update readme for latest CLI args 2018-02-25 21:17:57 +00:00			`-h, --help show this help message and exit`
			`--map-list MAP_LIST a text file with one map URL per line, can be`
			`specified more than once`
			`--no-sleep don't sleep between downloads -- WARNING you can`
			`easily run into throttling on mirrors if you use this`
			`option`
			`--use-ram use RAM for mapsforge processing -- WARNING mapsforge`
			`uses 10x the map size in RAM for processing (ie. 100Mb`
			`map = 1Gb RAM usage), you want a LOT of RAM for this`
			`option`
			`--max-heap-space MAX_HEAP_SPACE`
			`set the max heap space for the JVM, use standard -Xmx`
			`values, default (4g) should be fine if not using`
			`--use-ram argument`
			`--output-map-name OUTPUT_MAP_NAME`
			`set the output .map and .poi file names`
			`--cached-maps-dir CACHED_MAPS_DIR`
			`Use cached maps in the specified directory instead of`
			`downloads using map lists`
Fixup README formatting 2017-01-20 17:39:55 +00:00			```
Added licencing 2016-01-12 22:51:36 +00:00
			`Licencing`
			`=`
			`All code is licensed Apache 2.0 and all non-code is licensed Creative Commons CC-BY-SA-3.0`