From a408da4cccf0c6a6c0c222df2e901e764ce7054d Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Fri, 15 Nov 2024 15:07:30 +0100 Subject: [PATCH] remove cmake and related installation instructions --- CMakeLists.txt | 216 ------------------------------------- README.md | 16 +-- cmake/paths-py-no-php.tmpl | 14 --- cmake/tool-installed.tmpl | 13 --- cmake/tool.tmpl | 13 --- docs/admin/Faq.md | 62 +---------- docs/admin/Installation.md | 51 +-------- 7 files changed, 13 insertions(+), 372 deletions(-) delete mode 100644 CMakeLists.txt delete mode 100644 cmake/paths-py-no-php.tmpl delete mode 100644 cmake/tool-installed.tmpl delete mode 100755 cmake/tool.tmpl diff --git a/CMakeLists.txt b/CMakeLists.txt deleted file mode 100644 index e31362fe..00000000 --- a/CMakeLists.txt +++ /dev/null @@ -1,216 +0,0 @@ -#----------------------------------------------------------------------------- -# -# CMake Config -# -# Nominatim -# -#----------------------------------------------------------------------------- - -cmake_minimum_required(VERSION 3.0 FATAL_ERROR) -list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake") - - -#----------------------------------------------------------------------------- -# -# Project version -# -#----------------------------------------------------------------------------- - -project(nominatim) - -set(NOMINATIM_VERSION_MAJOR 4) -set(NOMINATIM_VERSION_MINOR 5) -set(NOMINATIM_VERSION_PATCH 0) - -set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}") - -add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}") - -# Setting GIT_HASH -find_package(Git) -if (GIT_FOUND) - execute_process( - COMMAND "${GIT_EXECUTABLE}" log -1 --format=%h - WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} - OUTPUT_VARIABLE GIT_HASH - OUTPUT_STRIP_TRAILING_WHITESPACE - ERROR_QUIET - ) -endif() - -#----------------------------------------------------------------------------- -# Configuration -#----------------------------------------------------------------------------- - -set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database") -set(BUILD_API on CACHE BOOL "Build everything for the API server") -set(BUILD_TESTS on CACHE BOOL "Build test suite") -set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)") -set(INSTALL_MUNIN_PLUGINS on CACHE BOOL "Install Munin plugins for supervising Nominatim") - -#----------------------------------------------------------------------------- -# osm2pgsql (imports/updates only) -#----------------------------------------------------------------------------- - -if (BUILD_IMPORTER AND BUILD_OSM2PGSQL) - if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt") - message(FATAL_ERROR "The osm2pgsql directory is empty.\ - Did you forget to check out Nominatim recursively?\ - \nTry updating submodules with: git submodule update --init") - endif() - set(BUILD_TESTS_SAVED "${BUILD_TESTS}") - set(BUILD_TESTS off) - add_subdirectory(osm2pgsql) - set(BUILD_TESTS ${BUILD_TESTS_SAVED}) -endif() - - -#----------------------------------------------------------------------------- -# python (imports/updates only) -#----------------------------------------------------------------------------- - -if (BUILD_IMPORTER OR BUILD_API) - find_package(PythonInterp 3.7 REQUIRED) -endif() - -#----------------------------------------------------------------------------- -# import scripts and utilities (importer only) -#----------------------------------------------------------------------------- - -if (BUILD_IMPORTER) - find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz - PATHS ${PROJECT_SOURCE_DIR}/data - NO_DEFAULT_PATH - DOC "Location of the country grid file." - ) - - if (NOT COUNTRY_GRID_FILE) - message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n" - " wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz") - endif() - - configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl - ${PROJECT_BINARY_DIR}/nominatim) -endif() - -#----------------------------------------------------------------------------- -# Tests -#----------------------------------------------------------------------------- - -if (BUILD_TESTS) - include(CTest) - - set(TEST_BDD db osm2pgsql api) - - find_program(PYTHON_BEHAVE behave) - find_program(PYLINT NAMES pylint3 pylint) - find_program(PYTEST NAMES pytest py.test-3 py.test) - - if (PYTHON_BEHAVE) - message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}") - foreach (test ${TEST_BDD}) - add_test(NAME bdd_${test} - COMMAND ${PYTHON_BEHAVE} ${test} - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd) - set_tests_properties(bdd_${test} - PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}") - endforeach() - else() - message(WARNING "behave not found. BDD tests disabled." ) - endif() - - if (PYLINT) - message(STATUS "Using pylint binary ${PYLINT}") - add_test(NAME pylint - COMMAND ${PYLINT} nominatim - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) - else() - message(WARNING "pylint not found. Python linting tests disabled.") - endif() - - if (PYTEST) - message(STATUS "Using pytest binary ${PYTEST}") - add_test(NAME pytest - COMMAND ${PYTEST} test/python - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) - else() - message(WARNING "pytest not found. Python tests disabled." ) - endif() -endif() - -#----------------------------------------------------------------------------- -# Installation -#----------------------------------------------------------------------------- - - -include(GNUInstallDirs) -set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME}) -set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME}) -set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME}) -set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins) - -if (BUILD_IMPORTER) - configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin) - install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin - DESTINATION ${CMAKE_INSTALL_BINDIR} - RENAME nominatim) - - configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py-no-php.tmpl paths-py.installed) - - foreach (submodule nominatim_db nominatim_api) - install(DIRECTORY src/${submodule} - DESTINATION ${NOMINATIM_LIBDIR}/lib-python - FILES_MATCHING PATTERN "*.py" - PATTERN "paths.py" EXCLUDE - PATTERN __pycache__ EXCLUDE) - install(FILES ${PROJECT_BINARY_DIR}/paths-py.installed - DESTINATION ${NOMINATIM_LIBDIR}/lib-python/${submodule} - RENAME paths.py) - endforeach() - - install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR}) - - install(FILES ${COUNTRY_GRID_FILE} - data/words.sql - DESTINATION ${NOMINATIM_DATADIR}) -endif() - -if (BUILD_OSM2PGSQL) - if (${CMAKE_VERSION} VERSION_LESS 3.13) - # Installation of subdirectory targets was only introduced in 3.13. - # So just copy the osm2pgsql file for older versions. - install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql - DESTINATION ${NOMINATIM_LIBDIR}) - else() - install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR}) - endif() -endif() - -install(FILES settings/env.defaults - settings/address-levels.json - settings/phrase-settings.json - settings/import-admin.lua - settings/import-street.lua - settings/import-address.lua - settings/import-full.lua - settings/import-extratags.lua - settings/flex-base.lua - settings/icu_tokenizer.yaml - settings/country_settings.yaml - DESTINATION ${NOMINATIM_CONFIGDIR}) - -install(DIRECTORY settings/icu-rules - DESTINATION ${NOMINATIM_CONFIGDIR}) -install(DIRECTORY settings/country-names - DESTINATION ${NOMINATIM_CONFIGDIR}) - -if (INSTALL_MUNIN_PLUGINS) - install(FILES munin/nominatim_importlag - munin/nominatim_query_speed - munin/nominatim_requests - DESTINATION ${NOMINATIM_MUNINDIR}) -endif() - -message(WARNING "Building with CMake is deprecated and will be removed in Nominatim 5.0." - "Use Nominatim pip packages instead.\n" - "See https://nominatim.org/release-docs/develop/admin/Installation/#downloading-and-building-nominatim") diff --git a/README.md b/README.md index d130074e..3b0f328a 100644 --- a/README.md +++ b/README.md @@ -27,21 +27,21 @@ can be found at nominatim.org as well. A quick summary of the necessary steps: -1. Compile Nominatim: +1. Create a Python virtualenv and install the packages: - mkdir build - cd build - cmake .. - make - sudo make install + python3 -m venv nominatim-venv + ./nominatim-venv/bin/pip install packaging/nominatim-{api,db} 2. Create a project directory, get OSM data and import: mkdir nominatim-project cd nominatim-project - nominatim import --osm-file + ../nominatim-venv/bin/nominatim import --osm-file -3. Point your webserver to the nominatim-project/website directory. +3. Start the webserver: + + ./nominatim-venv/bin/pip install uvicorn falcon + ../nominatim-venv/bin/nominatim serve License diff --git a/cmake/paths-py-no-php.tmpl b/cmake/paths-py-no-php.tmpl deleted file mode 100644 index a95cb664..00000000 --- a/cmake/paths-py-no-php.tmpl +++ /dev/null @@ -1,14 +0,0 @@ -# SPDX-License-Identifier: GPL-2.0-only -# -# This file is part of Nominatim. (https://nominatim.org) -# -# Copyright (C) 2022 by the Nominatim developer community. -# For a full list of authors see the git log. -""" -Path settings for extra data used by Nominatim (installed version). -""" -from pathlib import Path - -SQLLIB_DIR = (Path('@NOMINATIM_LIBDIR@') / 'lib-sql').resolve() -DATA_DIR = Path('@NOMINATIM_DATADIR@').resolve() -CONFIG_DIR = Path('@NOMINATIM_CONFIGDIR@').resolve() diff --git a/cmake/tool-installed.tmpl b/cmake/tool-installed.tmpl deleted file mode 100644 index 915f1d69..00000000 --- a/cmake/tool-installed.tmpl +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/env python3 -import sys -import os - -sys.path.insert(1, '@NOMINATIM_LIBDIR@/lib-python') - -from nominatim_db import cli -from nominatim_db import version - -version.GIT_COMMIT_HASH = '@GIT_HASH@' - -exit(cli.nominatim(module_dir='@NOMINATIM_LIBDIR@/module', - osm2pgsql_path='@NOMINATIM_LIBDIR@/osm2pgsql')) diff --git a/cmake/tool.tmpl b/cmake/tool.tmpl deleted file mode 100755 index 4053ca35..00000000 --- a/cmake/tool.tmpl +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/env python3 -import sys -import os - -sys.path.insert(1, '@CMAKE_SOURCE_DIR@/src') - -from nominatim_db import cli -from nominatim_db import version - -version.GIT_COMMIT_HASH = '@GIT_HASH@' - -exit(cli.nominatim(module_dir='@CMAKE_BINARY_DIR@/module', - osm2pgsql_path='@CMAKE_BINARY_DIR@/osm2pgsql/osm2pgsql')) diff --git a/docs/admin/Faq.md b/docs/admin/Faq.md index efcd5741..1d0252d3 100644 --- a/docs/admin/Faq.md +++ b/docs/admin/Faq.md @@ -37,31 +37,6 @@ nominatim import --continue indexing Otherwise it's best to start the full setup from the beginning. - -### nominatim.so version mismatch - -When running the import you may get a version mismatch: -`COPY_END for place failed: ERROR: incompatible library "/srv/Nominatim/nominatim/build/module/nominatim.so": version mismatch` - -pg_config seems to use bad includes sometimes when multiple versions -of PostgreSQL are available in the system. Make sure you remove the -server development libraries (`postgresql-server-dev-13` on Ubuntu) -and recompile (`cmake .. && make`). - - -### I see the error "ERROR: permission denied for language c" - -`nominatim.so`, written in C, is required to be installed on the database -server. Some managed database (cloud) services like Amazon RDS do not allow -this. There is currently no work-around other than installing a database -on a non-managed machine. - - -### I see the error: "function transliteration(text) does not exist" - -Reinstall the nominatim functions with `nominatim refresh --functions` -and check for any errors, e.g. a missing `nominatim.so` file. - ### I see the error: "ERROR: mmap (remap) failed" This may be a simple out-of-memory error. Try reducing the memory used @@ -103,39 +78,6 @@ for default Ubuntu operating system for example it's `www-data`. GRANT SELECT ON ALL TABLES IN SCHEMA public TO "www-data"; ``` -### Website reports "Could not load library "nominatim.so" - -Example error message - -``` - SELECT make_standard_name('3039 E MEADOWLARK LN') [nativecode=ERROR: could not - load library "/srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so": - /srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so: cannot open shared - object file: Permission denied - CONTEXT: PL/pgSQL function make_standard_name(text) line 5 at assignment] -``` - -The PostgreSQL database, i.e. user `postgres`, needs to have access to that file. - -The permission need to be read & executable by everybody, but not writeable -by everybody, e.g. - -``` - -rwxr-xr-x 1 nominatim nominatim 297984 build/module/nominatim.so -``` - -Try `chmod a+r nominatim.so; chmod a+x nominatim.so`. - -When you recently updated your operating system, updated PostgreSQL to -a new version or moved files (e.g. the build directory) you should -recreate `nominatim.so`. Try - -``` - cd build - rm -r module/ - cmake $main_Nominatim_path && make -``` - ### Setup fails with "DB Error: extension not found" Make sure you have the PostgreSQL extensions "hstore" and "postgis" installed. @@ -172,4 +114,6 @@ for more information. ### Can I import negative OSM ids into Nominatim? -See [this question of Stackoverflow](https://help.openstreetmap.org/questions/64662/nominatim-flatnode-with-negative-id). +No, negative IDs are no longer supported by osm2pgsql. You can use +large 64-bit IDs that are guaranteed not to clash with OSM IDs. However, +you will not able to use a flatnode file with them. diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md index 3db16c3b..dadbe460 100644 --- a/docs/admin/Installation.md +++ b/docs/admin/Installation.md @@ -41,19 +41,6 @@ Furthermore the following Python libraries are required: These will be installed automatically when using pip installation. -When using legacy CMake-based installation: - - * [cmake](https://cmake.org/) - * [expat](https://libexpat.github.io/) - * [proj](https://proj.org/) - * [bzip2](http://www.bzip.org/) - * [zlib](https://www.zlib.net/) - * [ICU](http://site.icu-project.org/) - * [nlohmann/json](https://json.nlohmann.me/) - * [Boost libraries](https://www.boost.org/), including system and file system - * PostgreSQL client libraries - * a recent C++ compiler (gcc 5+ or Clang 3.8+) - For running continuous updates: * [pyosmium](https://osmcode.org/pyosmium/) @@ -124,11 +111,10 @@ The release contains all necessary files. Just unpack it. ### Downloading the latest development version -If you want to install latest development version from github, make sure to -also check out the osm2pgsql subproject: +If you want to install latest development version from github: ``` -git clone --recursive https://github.com/openstreetmap/Nominatim.git +git clone https://github.com/osm-search/Nominatim.git ``` The development version does not include the country grid. Download it separately: @@ -139,8 +125,6 @@ wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/countr ### Building Nominatim -#### Building the latest development version with pip - Nominatim is easiest to run from its own virtual environment. To create one, run: sudo apt-get install virtualenv @@ -150,36 +134,5 @@ To install Nominatim directly from the source tree into the virtual environment, /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api} -#### Building in legacy CMake mode - -!!! warning - Installing Nominatim through CMake is now deprecated. The infrastructure - will be removed in Nominatim 5.0. Please switch to pip installation. - -The code must be built in a separate directory. Create the directory and -change into it. - -``` -mkdir build -cd build -``` - -Nominatim uses cmake and make for building. Assuming that you have created the -build at the same level as the Nominatim source directory run: - -``` -cmake ../Nominatim -make -sudo make install -``` - -Nominatim installs itself into `/usr/local` per default. To choose a different -installation directory add `-DCMAKE_INSTALL_PREFIX=` to the -cmake command. Make sure that the `bin` directory is available in your path -in that case, e.g. - -``` -export PATH=/bin:$PATH -``` Now continue with [importing the database](Import.md).