Compare commits

...

9 Commits

Author SHA1 Message Date
Sarah Hoffmann
b3796b9e25 remove download instructions for country grid 2022-11-19 17:07:18 +01:00
Sarah Hoffmann
4efd5f6444 adapt to 4.1.1 release 2022-11-19 16:21:26 +01:00
Marc Tobias
75f2efaf49 Tiger install doc: add -refresh website- step 2022-11-19 16:18:35 +01:00
marc tobias
4f82a9a789 Documentation: remove year from TIGER filename 2022-11-19 16:18:15 +01:00
Mauricio Scheffer
ebfdee62d7 docs: fix links to rank docs 2022-11-19 16:18:06 +01:00
Sarah Hoffmann
912db1cbc4 docs: add types-psutil requirement 2022-11-19 16:17:47 +01:00
Sarah Hoffmann
456520750e Merge pull request #2827 from mtmail/docs-4.1.x
Documentation: Add missing wget to Ubuntu install instructions
2022-09-25 12:42:51 +02:00
marc tobias
2950fa6ad5 Documentation: Add missing wget to Ubuntu install instructions 2022-09-23 20:49:14 +02:00
Sarah Hoffmann
d259f01d62 adapt to 4.1.0 release 2022-08-05 15:30:06 +02:00
8 changed files with 23 additions and 44 deletions

View File

@@ -211,8 +211,8 @@ be more than one. The attributes of that element contain:
* `ref` - content of `ref` tag if it exists * `ref` - content of `ref` tag if it exists
* `lat`, `lon` - latitude and longitude of the centroid of the object * `lat`, `lon` - latitude and longitude of the centroid of the object
* `boundingbox` - comma-separated list of corner coordinates ([see notes](#boundingbox)) * `boundingbox` - comma-separated list of corner coordinates ([see notes](#boundingbox))
* `place_rank` - class [search rank](../develop/Ranking#search-rank) * `place_rank` - class [search rank](../customize/Ranking#search-rank)
* `address_rank` - place [address rank](../develop/Ranking#address-rank) * `address_rank` - place [address rank](../customize/Ranking#address-rank)
* `display_name` - full comma-separated address * `display_name` - full comma-separated address
* `class`, `type` - key and value of the main OSM tag * `class`, `type` - key and value of the main OSM tag
* `importance` - computed importance rank * `importance` - computed importance rank

View File

@@ -5,22 +5,22 @@ address set to complement the OSM house number data in the US. You can add
TIGER data to your own Nominatim instance by following these steps. The TIGER data to your own Nominatim instance by following these steps. The
entire US adds about 10GB to your database. entire US adds about 10GB to your database.
1. Get preprocessed TIGER 2021 data: 1. Get preprocessed TIGER data:
cd $PROJECT_DIR cd $PROJECT_DIR
wget https://nominatim.org/data/tiger2021-nominatim-preprocessed.csv.tar.gz wget https://nominatim.org/data/tiger-nominatim-preprocessed-latest.csv.tar.gz
2. Import the data into your Nominatim database: 2. Import the data into your Nominatim database:
nominatim add-data --tiger-data tiger2021-nominatim-preprocessed.csv.tar.gz nominatim add-data --tiger-data tiger-nominatim-preprocessed-latest.csv.tar.gz
3. Enable use of the Tiger data in your `.env` by adding: 3. Enable use of the Tiger data in your existing `.env` file by adding:
echo NOMINATIM_USE_US_TIGER_DATA=yes >> .env echo NOMINATIM_USE_US_TIGER_DATA=yes >> .env
4. Apply the new settings: 4. Apply the new settings:
nominatim refresh --functions nominatim refresh --functions --website
See the [TIGER-data project](https://github.com/osm-search/TIGER-data) for more See the [TIGER-data project](https://github.com/osm-search/TIGER-data) for more

View File

@@ -55,8 +55,8 @@ To install all necessary packages run:
sudo apt install php-cgi phpunit php-codesniffer \ sudo apt install php-cgi phpunit php-codesniffer \
python3-pip python3-setuptools python3-dev python3-pip python3-setuptools python3-dev
pip3 install --user behave mkdocs mkdocstrings pytest \ pip3 install --user behave mkdocs mkdocstrings pytest pylint \
pylint mypy types-PyYAML types-jinja2 types-psycopg2 mypy types-PyYAML types-jinja2 types-psycopg2 types-psutil
``` ```
The `mkdocs` executable will be located in `.local/bin`. You may have to add The `mkdocs` executable will be located in `.local/bin`. You may have to add

View File

@@ -1,4 +1,4 @@
site_name: Nominatim Documentation site_name: Nominatim 4.1.1
theme: readthedocs theme: readthedocs
docs_dir: ${CMAKE_CURRENT_BINARY_DIR} docs_dir: ${CMAKE_CURRENT_BINARY_DIR}
site_url: https://nominatim.org site_url: https://nominatim.org

View File

@@ -28,7 +28,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
postgresql-10-postgis-2.4 \ postgresql-10-postgis-2.4 \
postgresql-contrib-10 postgresql-10-postgis-scripts \ postgresql-contrib-10 postgresql-10-postgis-scripts \
php-cli php-pgsql php-intl libicu-dev python3-pip \ php-cli php-pgsql php-intl libicu-dev python3-pip \
python3-psutil python3-jinja2 python3-yaml python3-icu git python3-psutil python3-jinja2 python3-yaml python3-icu
# Some of the Python packages that come with Ubuntu 18.04 are too old, so # Some of the Python packages that come with Ubuntu 18.04 are too old, so
# install the latest version from pip: # install the latest version from pip:
@@ -105,25 +105,18 @@ fi #DOCS:
# #
if [ "x$1" == "xyes" ]; then #DOCS: :::sh if [ "x$1" == "xyes" ]; then #DOCS: :::sh
cd $USERHOME cd $USERHOME
git clone --recursive https://github.com/openstreetmap/Nominatim.git wget https://nominatim.org/release/Nominatim-4.1.1.tar.bz2
cd Nominatim tar xf Nominatim-4.1.1.tar.bz2
else #DOCS: else #DOCS:
cd $USERHOME/Nominatim #DOCS: cd $USERHOME/Nominatim #DOCS:
fi #DOCS: fi #DOCS:
# When installing the latest source from github, you also need to
# download the country grid:
if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh
wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
fi #DOCS:
# The code must be built in a separate directory. Create this directory, # The code must be built in a separate directory. Create this directory,
# then configure and build Nominatim in there: # then configure and build Nominatim in there:
mkdir $USERHOME/build mkdir $USERHOME/build
cd $USERHOME/build cd $USERHOME/build
cmake $USERHOME/Nominatim cmake $USERHOME/Nominatim-4.1.1
make make
sudo make install sudo make install

View File

@@ -28,7 +28,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
postgresql-contrib-12 postgresql-12-postgis-3-scripts \ postgresql-contrib-12 postgresql-12-postgis-3-scripts \
php-cli php-pgsql php-intl libicu-dev python3-dotenv \ php-cli php-pgsql php-intl libicu-dev python3-dotenv \
python3-psycopg2 python3-psutil python3-jinja2 \ python3-psycopg2 python3-psutil python3-jinja2 \
python3-icu python3-datrie python3-yaml git python3-icu python3-datrie python3-yaml
# #
# System Configuration # System Configuration
@@ -99,25 +99,18 @@ fi #DOCS:
# #
if [ "x$1" == "xyes" ]; then #DOCS: :::sh if [ "x$1" == "xyes" ]; then #DOCS: :::sh
cd $USERHOME cd $USERHOME
git clone --recursive https://github.com/openstreetmap/Nominatim.git wget https://nominatim.org/release/Nominatim-4.1.1.tar.bz2
cd Nominatim tar xf Nominatim-4.1.1.tar.bz2
else #DOCS: else #DOCS:
cd $USERHOME/Nominatim #DOCS: cd $USERHOME/Nominatim #DOCS:
fi #DOCS: fi #DOCS:
# When installing the latest source from github, you also need to
# download the country grid:
if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh
wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
fi #DOCS:
# The code must be built in a separate directory. Create this directory, # The code must be built in a separate directory. Create this directory,
# then configure and build Nominatim in there: # then configure and build Nominatim in there:
mkdir $USERHOME/build mkdir $USERHOME/build
cd $USERHOME/build cd $USERHOME/build
cmake $USERHOME/Nominatim cmake $USERHOME/Nominatim-4.1.1
make make
sudo make install sudo make install

View File

@@ -28,7 +28,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
postgresql-contrib-14 postgresql-14-postgis-3-scripts \ postgresql-contrib-14 postgresql-14-postgis-3-scripts \
php-cli php-pgsql php-intl libicu-dev python3-dotenv \ php-cli php-pgsql php-intl libicu-dev python3-dotenv \
python3-psycopg2 python3-psutil python3-jinja2 \ python3-psycopg2 python3-psutil python3-jinja2 \
python3-icu python3-datrie git python3-icu python3-datrie
# #
# System Configuration # System Configuration
@@ -99,25 +99,18 @@ fi #DOCS:
# #
if [ "x$1" == "xyes" ]; then #DOCS: :::sh if [ "x$1" == "xyes" ]; then #DOCS: :::sh
cd $USERHOME cd $USERHOME
git clone --recursive https://github.com/openstreetmap/Nominatim.git wget https://nominatim.org/release/Nominatim-4.1.1.tar.bz2
cd Nominatim tar xf Nominatim-4.1.1.tar.bz2
else #DOCS: else #DOCS:
cd $USERHOME/Nominatim #DOCS: cd $USERHOME/Nominatim #DOCS:
fi #DOCS: fi #DOCS:
# When installing the latest source from github, you also need to
# download the country grid:
if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh
wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
fi #DOCS:
# The code must be built in a separate directory. Create this directory, # The code must be built in a separate directory. Create this directory,
# then configure and build Nominatim in there: # then configure and build Nominatim in there:
mkdir $USERHOME/build mkdir $USERHOME/build
cd $USERHOME/build cd $USERHOME/build
cmake $USERHOME/Nominatim cmake $USERHOME/Nominatim-4.1.1
make make
sudo make install sudo make install