osmlab / atlas-checks

OSM data integrity checks with Atlas
BSD 3-Clause "New" or "Revised" License
57 stars 83 forks source link

Consider editing description of repo to make clear that it is useful as a headless OSM validator [Feature Request] #519

Open matkoniecz opened 3 years ago

matkoniecz commented 3 years ago

Is your feature request related to a problem? Please describe. I was looking for a headless OSM validator and I failed to find one. As I understand this repo is usable as a headless validator of OSM data

Describe the solution you'd like Right now https://github.com/osmlab/atlas-checks#atlas-checks starts from

The Atlas Checks framework and standalone application are tools to enable quality assurance of Atlas data files. For more information on the Atlas mapping file format please see the Atlas project in Github.

what to me sounds like Atlas-specific checks (data integrity?) not about checking meaning of OSM data and therefore useful also for people not using Atlas at all.

So it may make sense to use Atlas just to use atlas-checks for headless validation.

Describe alternatives you've considered I got confused and https://github.com/osmlab/atlas-checks/ is not about validating OSM data.

Additional context I have zero experience with https://github.com/osmlab/atlas-checks/ and Atlas format, I was just looking for headless validator of OSM data (road islands isolated from road network, road crossing waterway without bridge or ford, waterway=riverbank on unclosed lines etc).

Bentleysb commented 3 years ago

Hey @matkoniecz, thanks for checking out the project. You should be able to use Atlas Checks as headless OSM validator, but that generally requires converting OSM data from the OSM PBF format to the Atlas format using Atlas Generator. It is also possible to run small PBFs through Atlas Checks directly, however, that functionality uses an older part of the program that is less well maintained. Thanks for pointing out that the readme is not very clear on these points. We can see about getting that updates.