Commit 591b4205 authored by Rick Gruber-Riemer's avatar Rick Gruber-Riemer

First draft version of manual

parent 8c60a7c4
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# osm2city documentation build configuration file, created by
# sphinx-quickstart on Sat Jan 23 16:17:58 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.pngmath',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'osm2city'
copyright = '2016, osm2city team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'osm2citydoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'osm2city.tex', 'osm2city Documentation',
'osm2city team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'osm2city', 'osm2city Documentation',
['osm2city team'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'osm2city', 'osm2city Documentation',
'osm2city team', 'osm2city', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
.. _chapter-deploy-label:
########################################
Deploy and Use Generated Scenery Objects
########################################
FIXME: stuff going into FGDATA
FIXME: texture stuff linking
FIXME: scenery path
.. _chapter-generation-label:
##################
Scenery Generation
##################
FIXME: hide objects folder for FGElevCaching?
.. osm2city documentation master file, created by
sphinx-quickstart on Sat Jan 23 16:17:58 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to osm2city's documentation!
====================================
While the article on Flightgear's Wiki_ presents in general terms what ``osm2city`` is and what features it has, this manual goes into depth with many aspects of generating scenery objects based on OpenStreetMap_ (OSM) data and deploying/using them in FlightGear_.
.. _FlightGear: http://www.flightgear.org/
.. _Wiki: http://wiki.flightgear.org/Osm2city.py
.. _OpenStreetMap: http://www.osm.org/
Before you generate your own sceneries, you might want to get familiar with the output of ``osm2city`` by first deploying some of the downloadable already generated sceneries and have a look at chapter :ref:`Deploy and Use Generated Scenery Objects <chapter-deploy-label>`. The following list is not exhaustive and more sceneries are typically announced in the Sceneries_ part of the FlightGear Forums:
* `Areas populated with osm2city scenery <http://wiki.flightgear.org/Areas_populated_with_osm2city_scenery>`_
* `LOWI city buildings <http://forum.flightgear.org/viewtopic.php?f=5&t=19625>`_
* `EDDC city models <http://forum.flightgear.org/viewtopic.php?f=5&t=18851#p174940>`_
* `OMDB & OMDW <http://forum.flightgear.org/viewtopic.php?f=5&t=28218>`_
.. _Sceneries: http://forum.flightgear.org/viewforum.php?f=5
**Contents:**
.. toctree::
:maxdepth: 2
installation
preparation
generation
using
parameters
deploy
**Indices and tables:**
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _chapter-installation-label:
############
Installation
############
The following specifies software and data requirements as part of the installation. Please be aware that different steps in scenery generation (e.g. generating elevation data, generating scenery objects) might require a lot of memory and are CPU intensive. Either use decent hardware or experiment with the size of the sceneries. However it is more probable that your computer gets at limits when flying around in FlightGear with sceneries using ``osm2city`` than when generating the sceneries.
==============
Pre-requisites
==============
------
Python
------
``osm2city`` is written in Python and needs Python for execution. Python is available on all major desktop operating systems — including but not limited to Windows, Linux and Mac OS X. See http://www.python.org.
Currently Python version 2.7 is used for development and is therefore the recommended version.
-------------------------
Python Extension Packages
-------------------------
osm2city uses the following Python extension packages, which must be installed on your system and be included in your ``PYTHONPATH``:
* curl
* matplotlib
* networkx
* numpy
* pil
* scipy
* shapely
Please make sure to use Python 2.7 compatible extensions. Often Python 3 compatible packages have a "3" in their name. Most Linux distributions come by default with the necessary packages — often they are prefixed with ``python-`` (e.g. ``python-numpy``). On Windows WinPython (https://winpython.github.io/) together with Christoph Gohlke's unofficial Windows binaries for Python extension packages (http://www.lfd.uci.edu/~gohlke/pythonlibs/) works well.
========================
Installation of osm2city
========================
There is no installer package - neither on Windows nor Linux. ``osm2city`` consists of a set of Python programs "osm2city_" and the related data in "osm2city-data_". You need both.
.. _osm2city: https://gitlab.com/fg-radi/osm2city
.. _osm2city-data: https://gitlab.com/fg-radi/osm2city-data
Do the following:
#. Download the packages either using Git_ or as a zip-package.
#. Add the ``osm2city`` directory to your ``PYTHONPATH``. You can read more about this at https://docs.python.org/2/using/cmdline.html#envvar-PYTHONPATH.
#. Create soft links between as described in the following subchapter.
.. _Git: http://www.git-scm.com/
-----------------------------------
Creating Soft Links to Texture Data
-----------------------------------
Many of the ``osm2city`` programs must have access to texture data in ``osm2city-data``. The following assumes that both the ``osm2city`` and ``osm2city-data`` are stored within the same directory.
On a Linux workstation do the following:
::
$ cd osm2city
$ ln -sf ../osm2city-data/tex
$ ln -sf ../osm2city-data/tex
On a Windows computer do the following (path may differ):
::
> mklink /J C:\development\osm2city\tex.src C:\development\osm2city-data\tex.src
> mklink /J C:\development\osm2city\tex C:\development\osm2city-data\tex
.. _chapter-parameters-label:
##########
Parameters
##########
FIXME generate ini file
FIXME check ini file for unused parameters
FIXME link to minimal parameters
FIXME all decimals need to be with "." - i.e. local specific decimal separators like "," are not accepted.
FIXME: Note  Python does not recognize environment variables, please use full paths in the parameters file (no $HOME etc).
This diff is collapsed.
.. _chapter-using-label:
#######################
Using Generated Scenery
#######################
FIXME: Add to path
FIXME: change material for urban
FIXME: consider sharing
FIXME: copy texture stuff
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment