fly/easy-osm2city
1
0
Fork 0
Code Issues Pull requests Activity
No description
241 commits 1 branch 0 tags 1 MiB
Shell 52.9%
Python 35.1%
PLpgSQL 12%
Find a file
fly 706805d342 Typo 
Signed-off-by: fly <merspieler@airmail.cc>
2021-02-05 19:10:31 +00:00
sql Initial commit 2018-11-18 15:00:00 +01:00
.gitignore Move scripts to own repo 2020-01-13 17:06:24 +00:00
build Fix duplicated warning message and print path 2020-01-15 15:16:10 +00:00
build_tile Revert "Does this avoid oom?" 2020-01-08 16:23:45 +00:00
clear-cache-files Updated Copyright year 2019-03-14 15:03:54 +00:00
create-db Always use the correct .databases file 2020-08-27 10:09:30 +00:00
create-project Reworked return codes 2019-04-04 06:48:30 +00:00
create-venv Use requirements.txt for installing pip packages 2019-06-09 13:37:43 +00:00
delete-db Always use the correct .databases file 2020-08-27 10:09:30 +00:00
edit-settings Reworked return codes 2019-04-04 06:48:30 +00:00
general-settings.template Added license header to all files 2018-11-21 21:17:10 +01:00
index-db Updated Copyright year 2019-03-14 15:03:54 +00:00
install Switch order 2020-01-13 17:17:54 +00:00
LICENSE Added LICENSE 2018-11-18 18:17:50 +00:00
parameters " missing 2019-10-12 05:31:00 +00:00
read-pbf Revert read-pbf-fast to read-pbf since it caused issues 2020-08-26 20:14:51 +10:00
README.md Added exception and fixed problem in continuation 2019-04-25 01:16:25 +00:00
update-programs Typo 2021-02-05 19:10:31 +00:00

README.md

easy-osm2city

And wrapper around osm2city inspired by easy-rsa.

Usage

Getting started

  • Clone the repo (or download the as zip/tar file and unpack it).
  • Then go into the directory, run ./install and follow the instructions.
  • Create a database using ./create-db <database>.
  • Download the .pbf file for the area you want to build and put it into the pbf directory.
    I recommend to download from GeoFabrik.
  • Read the .pbf file into the database by running ./read-pbf <database> <pbf-file>
  • If you want to speed up further opperation on the database, index it by running ./index-db <database>.
    I highly recommend to do so.
  • Next step is to create a project by running ./create-project <project> and following the instructions.
  • Now you can build your first scenery by running ./build project. You will find the scenery under projects/<your-project>/scenery.
  • If you don't know, what a program does, simply run it with the -h parameter to get help.

Other programs

Programs that were not covered by Getting started:

  • update-programs: Will update easy-osm2city, osm2city it self and osm2city-data
  • clear-cache-files <project>: Will delete cache files created by osm2city.
  • ./create-venv. This will create a virtual environment and installs all needed python packages. NOTE: This is run for you by the installer.
  • edit-settings <project>: Is a simple way to edit your params.inifile (which is used by osm2city to know what and how to generate the scenery).
    It will make sure, that everything is in the correct format and in the correct datatype.
  • ./delete-db <database>: Deletes the database.

Return codes

  • 0: Success
  • 1: Argument error
  • 2: IO error. An error with a file or database
  • 3: Child process failed/can not be called
  • 4: Unknown error
  • 130: Aborted by user.

User scripts

User scripts in the scripts/ directory are help scripts contributed by users. They Do not belong to the easy-osm2city concept but extend it. Use only if you know what you do.