Browse Source

Update README.md

Thomas Kandler 7 years ago
parent
commit
72f7769858
1 changed files with 30 additions and 1 deletions
  1. 30
    1
      README.md

+ 30
- 1
README.md View File

@@ -1,4 +1,33 @@
1 1
 geocode-vs
2 2
 ==========
3 3
 
4
-Getting coordinates from multiple providers
4
+### Purpose
5
+
6
+Getting a unified way to access the most important geocoding APIs (Nominatim, Google, MapQuest, HERE, OpenCage) to compare and evaluate.
7
+
8
+### Usage
9
+
10
+Just run the script by providing a .txt file with each location to geocode on a new line, e.g.:
11
+
12
+    cat places.txt  
13
+    Berlin  
14
+    Amsterdam  
15
+    Montpellier
16
+    ...
17
+    python geocode-vs.py places.txt
18
+  
19
+The script will access `API.json` for API keys (if neccessary) and will output `cities.csv` as well as `outliers.txt`. Don't forget to update your `API.json` to get access to the MapQuest, HERE and OpenCage geocoding results. The `outliers.txt` is some kind of shoot from the hip for evaluating the quality of the data. Outliers will be summarized in the console and simply mean that the coordinates for a location are not within the standard deviation of all 5 providers. This is by no means a real measure for quality, just a hint or a reminder to implement some real quality measurement.
20
+
21
+### Version
22
+
23
+* querying APIs works
24
+* generating a CSV works
25
+* getting (somewhat questionable) descriptive statistics works
26
+
27
+ToDo:
28
+* well-thought quality control
29
+* optimized output
30
+* arguments, e.g. choice of providers
31
+* error/exception handling
32
+* simplification/refactoring
33
+