Skip to content

Commit 04fa68c

Browse files
committed
added README and exemplary graph picture
1 parent 16524eb commit 04fa68c

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# OpenStreetMap Tool Statistics
2+
3+
This project should enable those who are interested in the usage of OpenStreetMap editors to create simple usage graphs for a particular editor. This is similar to what is done on the [OSM wiki's editor stats page](https://wiki.openstreetmap.org/wiki/Editor_usage_stats) but aims to provide more fine-grained information about single editors. This way, software maintainers or community members can observe how an editor evolved over time and can try to draw conclusions about incidents and their impacts.
4+
5+
## Functionality
6+
7+
Currently `osm_editor_graphs.py` creates three graphs showing how the number of changesets, the number of edits, and the number of distinct users of a given editor changed over time.
8+
9+
Run `./osm_editor_graphs.py --help` for a list of available options.
10+
11+
## Usage
12+
13+
This software currently processes the results of the [editor-stats](https://github.com/Zverik/editor-stats) tools, which are also used to generate the data for the OSM wiki's editor stats page. Therefore, it is necessary to run these tools on the [Planet OSM](https://planet.openstreetmap.org/) changesets file beforehand.
14+
15+
Example:
16+
17+
```bash
18+
# assume editor-stats and this project are cloned locally
19+
# create folder for data
20+
mkdir data
21+
# download latest changeset file from planet.osm
22+
wget -P data https://planet.openstreetmap.org/planet/changesets-latest.osm.bz2
23+
# convert to csv using editor-stats
24+
bzcat data/changesets-latest.osm.bz2 | editor-stats/xml2csv.pl > data/changesets.csv
25+
# generate .lst files using editor-stats, e.g. for each month in 2017
26+
for i in `seq -w 1 12`; do
27+
cat data/changesets.csv | editor-stats/stats.pl 2017-$i > data/2017-$i.lst
28+
done
29+
# generate graphs using this tool, e.g. for editor StreetComplete
30+
osm-tool-stats/osm_editor_graphs.py -e StreetComplete --outdir data data/*.lst
31+
```
32+
33+
This is how an example graph for the number of users may look like:
34+
35+
![](res/StreetComplete_users.png)
36+
37+
## Misc
38+
39+
It may be necessary to tune the plotting a little bit. Maybe further functionality will be added later. Pull Requests are welcome.

res/StreetComplete_users.png

48.5 KB
Loading

0 commit comments

Comments
 (0)