https://github.com/osm-search/nominatim-data-analyser

QA Tool for Nominatim. Helps to improve the OpenStreetMap data quality and therefore the Nominatim search results.
https://github.com/osm-search/nominatim-data-analyser

nominatim openstreetmap

Last synced: about 2 months ago
JSON representation

QA Tool for Nominatim. Helps to improve the OpenStreetMap data quality and therefore the Nominatim search results.

• Host: GitHub
• URL: https://github.com/osm-search/nominatim-data-analyser
• Owner: osm-search
• License: gpl-2.0
• Created: 2021-06-03T08:10:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-15T19:07:45.000Z (12 months ago)
• Last Synced: 2024-05-01T20:28:12.590Z (8 months ago)
• Topics: nominatim, openstreetmap
• Language: Python
• Homepage:
• Size: 2.18 MB
• Stars: 11
• Watchers: 4
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Nominatim-Data-Analyser ![CI Build-Tests](https://github.com/osm-search/Nominatim-Data-Analyser/actions/workflows/ci-build-tests.yml/badge.svg)

The Nominatim Data Analyser is a QA tool used to scan the nominatim database and extract

suspect data from it. These data are then presented to mappers through a [visual interface](https://nominatim.org/qa/) so that they can correct them directly.

# Frontend

The repository containing the frontend of the tool can be found [there](https://github.com/osm-search/Nominatim-Data-Analyser-Frontend).

# Installation procedure

Clone this repository by running:

```

git clone https://github.com/osm-search/Nominatim-Data-Analyser

```

Then you can compile everything with

    python3 setup.py build

Or you can directly compile and install the analyser with

    pip install .

## Database

Make sure to have a Nominatim database set up on your server. You can change

the database DSN by supplying a custom config.yaml file.

## Configuration file

Some parts of the analyser are configurable. You can find the default

configuration in `src/nominatim_data_analyser/default_config.yaml`. To

modify the configuration create a copy of the file with the modified

values and put it as `config.yaml` in the directory where the analyser

is executed.

## Frontend set up

To set up the frontend, please check the frontend [repository](https://github.com/osm-search/Nominatim-Data-Analyser-Frontend).

For the webapp to fetch the data extracted by the analyser, you need to serve the `````` defined in ```analyser/config/config.yaml``` of the QA Data Analyser Tool with a web server. It should be accessible through the `````` also defined in the configuration of the QA Data Analyser Tool.

  

# Running the analyser

Analysis is run with the nominatim-data-analyser tool:

* --execute-all: Executes all QA rules.

* --filter [rules_names…]: Filters some QA rules so they are not executed.

* --execute-one : Executes the given QA rule.

* --config: Set a custom location for the configuration file.

During development you can run the same tool directly from the source tree

after having built everything using the supplied `cli.py`.

# Tests

[Pytest](https://docs.pytest.org/en/6.2.x/getting-started.html) is used for the tests and it should be installed:

```

pip install pytest

```

To run the tests for the analyser: execute ```pytest``` command at the root folder of the project.

# Reporting errors in the rule

To report some errors in the rule, please follow the [CONTRIBUTING.md](CONTRIBUTING.md)

# Documentation

An advanced documentation of the tool can be found in the [Overview.md](docs/Overview.md) file.