@name@

Version @version@ (@date@)

  This software is free software and is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License. 


0. Index
--------

1. License
2. Copyright
3. About
4. System requirements
5. (Un)Installation
6. Running the application
7. Cooperation partners and supporters
8. Active Developers
9. Contact
10. Websites
11. Disclaimer


1. License
----------

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0


2. Copyright
------------

(C) @vendorCopyright@
@vendorName@
@vendorOrganisation@, @vendorCountry@
@vendorWebsiteUrl@


3. About
--------

The @name@ is a Java based front-end for 
the @citydbName@ version @citydbVersion@. It allows for high-performance 
loading and extracting 3D city model data.

* Full support for CityGML versions 2.0.0 and 1.0.0
* Support for CityGML Application Domain Extensions (ADEs) through
  software extensions
* Support for Oracle Locator/Spatial and PostgreSQL/PostGIS
* Reading/writing CityGML instance documents of arbitrary file size
* Export of KML/COLLADA/glTF models including tiling schemas for 
  visualization and interactive exploration of large city models
  in Digital Earth Browsers, 3D GIS, and computer graphics software
* Generic KML information balloons
* Export of thematic object data into tables. Supported data formats are
  CSV, Microsoft Excel, and direct upload into Google Spreadsheets
* Resolving and preservation of forward and backwards XLinks in 
  CityGML datasets
* Full support of 3D Coordinate Reference Systems (CRS) and 3D 
  coordinate transformations; support for user-defined CRS 
* Coordinate transformations for CityGML exports
* Map window for graphical selection of bounding boxes
* XML validation of CityGML instance documents
* Multithreaded programming facilitating high-performance CityGML 
  processing

The @name@ comes with both a Graphical
User Interface (GUI) and a Command Line Interface (CLI). The CLI 
allows for employing the tool in batch processing workflows and 
third party applications.


4. System requirements
----------------------

* Java JRE or JDK >= 1.8
* @citydbName@ version @citydbVersion@ on
  - Oracle Spatial DBMS >= 10G R2 with Spatial or Locator option
  - PostgreSQL DBMS >= 9.3 with PostGIS extension >= 2.0
  
The @name@ can be run on any platform 
providing appropriate Java support. It has been tested on the 
following platforms:
  - Microsoft Windows XP, Vista, Windows 7, 8, 10
  - Apple Mac OS X 10.9, 10.11, macOS 10.12, 10.13
  - Ubuntu 14 - 18


5. (Un)Installation
-------------------

It is recommended to use the universal installer to setup the
@name@ application on your local computer.
The universal installer will guide you through the steps of the
installation process. Afterwards, you can immediately run the application 
(see next section).

When you successfully install the @name@,
an uninstaller is automatically generated in the 'uninstaller' subfolder
of the installation directory. Please use this uninstaller in order to remove
the @name@ application files from your
computer. Alternatively, you can simply delete the entire installation
directory.


6. Running the application
--------------------------

For running the @name@ use one of the
following two options:

a) Recommended:
   Use the start scripts to launch the application. The start scripts
   are located in the "bin" folder of the installation directory.
   During setup you can additionally choose to create shortcuts for the
   start scripts on your desktop and in the start menu of your
   preferred OS.

   Please execute the start script suitable for your platform:
   - @appName@.bat   (Microsoft Windows family)
   - @appName@       (UNIX/Linux family, macOS)

   On most platforms, double-clicking the start script or its shortcut
   runs the @name@.

   PLEASE NOTE:
   The start scripts set the initial heap size of the Java Virtual
   Machine (JVM) to 1GB using the -Xms parameter of the JVM. This value
   has been chosen to be reasonable for most platforms. Please edit the
   start scripts in case you need to adapt the default values (e.g.,
   in order to increase the available main memory).

   For some UNIX/Linux distributions, you will have to run the start
   script from within a shell environment. Please open your favorite shell
   and first check whether execution rights are correctly set for the
   start script.

   Change to the "bin" folder and enter the following to make the start
   script executable for the owner of the file:

       chmod u+x @appName@

   Afterwards, simply run the start script by the following command:

       ./@appName@

b) Alternatively, you can directly run the @jar@
   from within a shell environment without using the start scripts. The
   runnable JAR archive is located in the "lib" subfolder of the
   installation folder.

   Open a shell, change to the installation folder and type the following:

       java -jar lib/@jar@ [-options]

   Make sure to define reasonable values for the available main memory.
   Otherwise you might quickly run into main memory issues due
   to restrictive JVM default values.

   This is also the recommended way to run the program in CLI mode without
   a graphical user interface. Simply add the "-shell" program argument to
   the above shell command:

       java -jar lib/@jar@ -shell [-options]

   Type "java -jar lib/@jar@" -help' to get a list of the
   available program arguments.

  
7. Cooperation partners and supporters
--------------------------------------

The @name@ v@version@ has been developed by
and with the support from the following cooperation partners:

* Chair of Geoinformatics, Technical University of Munich
  https://www.gis.bgu.tum.de/
* virtualcitySYSTEMS GmbH, Berlin
  http://www.virtualcitysystems.de/
* M.O.S.S. Computer Grafik Systeme GmbH, Taufkirchen
  http://www.moss.de/
  
   
8. Active Developers
--------------------

Claus Nagel <cnagel@virtualcitysystems.de>
Zhihang Yao <zyao@virtualcitysystems.de>
György Hudra <ghudra@moss.de>
Felix Kunde <felix-kunde@gmx.de>
Son H. Nguyen <son.nguyen@tum.de>
Thomas H. Kolbe <thomas.kolbe@tum.de>

Version @version@ is based on earlier versions of the
@name@. Please refer to the @citydbName@
documentation for the list of all contributors to previous versions. 


9. Contact
----------

cnagel@virtualcitysystems.de
thomas.kolbe@tum.de


10. Websites
------------

Official @citydbName@ website: 
@citydbWebsiteUrl@

Related websites:
@citydbVcsUrl@
https://github.com/tum-gis/3dcitydb-docker-postgis
@vendorWebsiteUrl@
http://www.citygml.org
http://www.citygmlwiki.org
http://www.opengeospatial.org/standards/citygml


11. Disclaimer
--------------

THIS SOFTWARE IS PROVIDED BY THE CHAIR OF GEOINFORMATION FROM TU MUNICH
(TUMGI) "AS IS" AND "WITH ALL FAULTS." 
TUMGI MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE 
QUALITY, SAFETY OR SUITABILITY OF THE SOFTWARE, EITHER EXPRESSED OR 
IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

TUMGI MAKES NO REPRESENTATIONS OR WARRANTIES AS TO THE TRUTH, ACCURACY OR 
COMPLETENESS OF ANY STATEMENTS, INFORMATION OR MATERIALS CONCERNING THE 
SOFTWARE THAT IS CONTAINED ON AND WITHIN ANY OF THE WEBSITES OWNED AND 
OPERATED BY TUMGI.

IN NO EVENT WILL TUMGI BE LIABLE FOR ANY INDIRECT, PUNITIVE, SPECIAL, 
INCIDENTAL OR CONSEQUENTIAL DAMAGES HOWEVER THEY MAY ARISE AND EVEN IF 
TUMGI HAVE BEEN PREVIOUSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.