Annotation of /branches/WIP-pyshapelib-bramz/README


Thuban - a Geographic Data Viewer
=================================

$Date$
$Revision$

Thuban is an interactive viewer for geographic data.  
Python and the wxWidgets framework ensure great portability.
Thuban is Free Software and runs on GNU/Linux, Windows 
and several other operating systems.

Homepage:                       https://thuban.intevation.org
Development infrastructure:     https://wald.intevation.org/projects/thuban/

About the Name
--------------

Thuban is the name of a star in the constellation Draco (The Dragon).
About 4000 years ago it was the north star.


Requirements
------------

Thuban requires the following software to be installed:

  Python     2.2.1    http://www.python.org
  wxWidgets  2.6.3.2  http://www.wxwidgets.org (formerly known as wxWindows)
  wxPython   2.6.3.2  http://www.wxpython.org
  proj       4.4.5    http://www.remotesensing.org/proj/
  SQLite     2.8.3    http://sqlite.org/
  PySQLite   0.4.3    http://pysqlite.org/

The versions given are the lowest versions that are known to work. for
proj, sqlite and pysqlite somewhat older versions probably work as well.
Note that the wxPython version must be the same as the wxWidgets version
(Some wxPython binary packages already contain the right wxWidgets version)

Optional software:

  GDAL       1.3.2  http://www.remotesensing.org/gdal/
     for raster image (geo-tiff) support

  psycopg    1.0.x  http://initd.org/software/psycopg
     for postgis connections. Newer version probably also work

  RXP        1.2.x  http://www.cogsci.ed.ac.uk/~richard/rxp.html
     usually comes directly with pyRXP.
  pyRXP      0.9    http://www.reportlab.org/pyrxp.html
     only for the automatic tests to validate Thuban's XML files.


Installation
------------

Building Thuban (this compiles the extension modules but leaves them in
a directory under build/):

   python setup.py build


To setup Thuban to run directly from the source directory:

   python setup.py install_local

You can run this without running build first.


To install Thuban:

   python setup.py install


for general information about the command line options of the setup.py
script, run

   python setup.py --help


If you build from SVN and want to have translated menus, dialogs etc.
you have to build the message catalogs manually before you run setup.py.
See po/README for more information.


Build Troubleshooting
---------------------

When building Thuban, you might have problems because of a missing file
wx/wxPython/wxPython.h.  This file is part of wxPython and may be
packaged in a separate package.  Unfortunately, on some systems this
file is not packaged at all.  On those systems you can try a work-around
built into Thuban, by passing the --use-wx-python-swig-hack to the
build_ext command.  This can be done on the command line for the build
command like this:

   python setup.py  build_ext --use-wx-python-swig-hack  build

You can also use it with the install_local command:

   python setup.py  build_ext --use-wx-python-swig-hack  install_local

Note, that this work-around relies on some wxPython internals and may
cease to work at some point.  We tested it with wxPython 2.6.


License
-------

Thuban is licensed under the terms of the 
GNU General Public License (GPL) version 2 or later.

However, some of the extension modules in the extension subdirectory are
licensed under other Free Software licenses. 
See the respective README files for details.
1	bh	2
2	bh	1669	Thuban - a Geographic Data Viewer
3	bh	2	=================================
4
5	bh	1669	$Date$
6			$Revision$
7
8	bernhard	2139	Thuban is an interactive viewer for geographic data.
9			Python and the wxWidgets framework ensure great portability.
10			Thuban is Free Software and runs on GNU/Linux, Windows
11			and several other operating systems.
12	bh	2
13	bernhard	2728	Homepage: https://thuban.intevation.org
14			Development infrastructure: https://wald.intevation.org/projects/thuban/
15	bh	2
16			About the Name
17			--------------
18
19			Thuban is the name of a star in the constellation Draco (The Dragon).
20			About 4000 years ago it was the north star.
21
22
23	bh	1669	Requirements
24			------------
25
26			Thuban requires the following software to be installed:
27
28	bh	1893	Python 2.2.1 http://www.python.org
29	bernhard	2728	wxWidgets 2.6.3.2 http://www.wxwidgets.org (formerly known as wxWindows)
30			wxPython 2.6.3.2 http://www.wxpython.org
31	bh	1893	proj 4.4.5 http://www.remotesensing.org/proj/
32	bernhard	2690	SQLite 2.8.3 http://sqlite.org/
33			PySQLite 0.4.3 http://pysqlite.org/
34	bh	1669
35	bh	1804	The versions given are the lowest versions that are known to work. for
36	bh	1669	proj, sqlite and pysqlite somewhat older versions probably work as well.
37	bernhard	2139	Note that the wxPython version must be the same as the wxWidgets version
38			(Some wxPython binary packages already contain the right wxWidgets version)
39	bh	1669
40			Optional software:
41
42	bernhard	2728	GDAL 1.3.2 http://www.remotesensing.org/gdal/
43	bh	1669	for raster image (geo-tiff) support
44
45			psycopg 1.0.x http://initd.org/software/psycopg
46			for postgis connections. Newer version probably also work
47
48	bernhard	2692	RXP 1.2.x http://www.cogsci.ed.ac.uk/~richard/rxp.html
49	bernhard	2695	usually comes directly with pyRXP.
50	bernhard	2692	pyRXP 0.9 http://www.reportlab.org/pyrxp.html
51			only for the automatic tests to validate Thuban's XML files.
52	bh	1669
53	bernhard	2692
54	bh	2	Installation
55			------------
56
57	bh	69	Building Thuban (this compiles the extension modules but leaves them in
58			a directory under build/):
59	bh	2
60			python setup.py build
61
62
63			To setup Thuban to run directly from the source directory:
64
65			python setup.py install_local
66
67			You can run this without running build first.
68
69
70			To install Thuban:
71
72			python setup.py install
73
74
75			for general information about the command line options of the setup.py
76			script, run
77
78			python setup.py --help
79
80
81	bernhard	2728	If you build from SVN and want to have translated menus, dialogs etc.
82	bh	671	you have to build the message catalogs manually before you run setup.py.
83			See po/README for more information.
84	bh	2
85	bh	671
86	bh	2592	Build Troubleshooting
87			---------------------
88
89			When building Thuban, you might have problems because of a missing file
90			wx/wxPython/wxPython.h. This file is part of wxPython and may be
91			packaged in a separate package. Unfortunately, on some systems this
92			file is not packaged at all. On those systems you can try a work-around
93			built into Thuban, by passing the --use-wx-python-swig-hack to the
94			build_ext command. This can be done on the command line for the build
95			command like this:
96
97			python setup.py build_ext --use-wx-python-swig-hack build
98
99			You can also use it with the install_local command:
100
101			python setup.py build_ext --use-wx-python-swig-hack install_local
102
103			Note, that this work-around relies on some wxPython internals and may
104	bernhard	2728	cease to work at some point. We tested it with wxPython 2.6.
105	bh	2592
106
107	bh	2	License
108			-------
109
110	bernhard	2728	Thuban is licensed under the terms of the
111			GNU General Public License (GPL) version 2 or later.
112	bh	2
113	bh	6	However, some of the extension modules in the extension subdirectory are
114	bernhard	2139	licensed under other Free Software licenses.
115			See the respective README files for details.
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision