GuillaumeGomez / docker_mimir

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python 3.5 pipenv

docker_mimir: Default Mimir Import Tool

  • This tool is the easiest way to import data for the Mimir geocoding system.
  • Basically docker_mimir is an import pipeline based on invoke. The easiest way to configure invoke is to create a custom configuration file. All possible variables are commented in the default configuration file: invoke.yaml.
  • Running docker_mimir requires pipenv.

How to use it

To configure the required data directories, some environment variable can be set (in cli or in a .env file in the directory). The env variables that can be set as follows:

OSM_DIR=<path to osm data dir>
ADDR_DIR=<path to addresses data dir>
COSMOGONY_DIR=<path to cosmogony data dir>
  • Note that you don't need to set the variable that are not used in the configuration file.
  • Once the variables are set, to run mimir you need to do:
pipenv run inv -f docker_settings.yaml load-in-docker-and-test
  • The file docker_settings.yaml contains an example configuration to download and import data about Luxembourg.
  • This will:
    • run a docker-compose up.
    • import some data in Mimir.
    • run geocoder-tester and write results in a local directory.

About Tests

  • If you don't want to run the tests you can also use invoke chaining calls:
pipenv run inv -f docker_settings.yaml compose-up load-all compose-down
  • Some other docker-compose files can also be given (this will use the docker compose override mechanism). It will for example make it possible to use customly build image to run tests on a given Mimir (or Fafnir, Cosmogony, ...) branch.

  • The file paths are given with the --files arguments, as follows:

pipenv run inv -f docker_settings.yaml load-in-docker-and-test --files my-docker-compose.yml --files my-other-compose.yml

About


Languages

Language:Python 96.8%Language:Dockerfile 3.2%