geostat/README.md

GEOSTAT
=======

Tools for computing various statistics related to Geocaching/Opencaching
------------------------------------------------------------------------

### Usage

```
Usage: [-p] [-g file] [-MDHh]
Generate stats from Opencaching data or GPX files.

 * Data source:
	-p	use Opencaching.pl
	-u user	user for Opencaching
	-g file	use specified gpx file
	-q	use local SQLite file
	-n	get only unfound caches (works only with SQLite)
 * Output:
	-M	print geographically extreme caches
	-D	print furthest and closest caches
	-H file	render a heat map to a file
	-s n	stamp size for a heat map (default = 15)
	-e	use exponential to flatten the heat map
	-m map	chosen map: Poland, Poland_relief, Poland_big, Europe or a name of voivodeship (default = Poland)
	-L	print all caches
	-T	print D/T matrix
	-O	print owner count for found caches
	-Y	print types count for found caches
	-W	output all data in HTML format
	-h	display this help screen
```

There is a helper program `geodb` which manages local SQLite database. It can initialize the database from full data dump or update it according to changelogs grabbed from OKApi.

HTML output requires a style sheet. Sample one is included as `geo.css`.

### Installation

To compile it requires:

*   C++ compliler supporting C++17 and a minor subset of C++2a (e.g. GCC-9 or Clang-8).
*   meson (at least 0.47.0) + ninja build system
*   libcurl: https://curl.haxx.se/libcurl/
*   JSON for Modern C++: https://github.com/nlohmann/json
*   gpxlib: http://irdvo.nl/gpxlib/
*   heatmap: https://github.com/lucasb-eyer/heatmap
*   ImageMagick or GraphicsMagick Magick++ library

To build the project copy `config_user_example.h` to `config_user.h` and fill it out (at least API key is needed). Then
run `meson build; cd build; ninja`. You might need to set `CXX` variable to point to a correct compiler.

### Credits

* Maps of Poland `Poland.png` and `Poland_big.png` come from `https://pl.wikipedia.org/wiki/Plik:Poland_location_map.svg` and are licensed under CC-BY-SA and GNU FDL.

* Map of Poland `Poland_relief.png` comes from `https://commons.wikimedia.org/wiki/File:Relief_Map_of_Poland.svg` and is licensed under CC-BY-SA.

* Map of Europe `Europe.png` comes from `https://pl.wikipedia.org/wiki/Plik:Europe_location_map.svg` and is licensed under PD.

* Maps of Voivodeships of Poland come from `https://commons.wikimedia.org/wiki/File:Podlaskie_Voivodeship_location_map.svg`, `https://commons.wikimedia.org/wiki/File:Pomeranian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Kuyavian-Pomeranian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Warmian-Masurian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Masovian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Lesser_Poland_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Greater_Poland_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Opole_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Lower_Silesian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Silesian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Lublin_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Subcarpathian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:West_Pomeranian_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:%C5%9Awi%C4%99tokrzyskie_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:Lubusz_Voivodeship_location_map.svg`, `https://pl.wikipedia.org/wiki/Plik:%C5%81%C3%B3d%C5%BA_Voivodeship_location_map.svg`
and are licensed under CC-BY-SA.