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.


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.4.0.4  http://www.wxwidgets.org (formerly known as wxWindows)
  wxPython   2.4.0.4  http://www.wxpython.org
  proj       4.4.5    http://www.remotesensing.org/proj/
  SQLite     2.8.3    http://www.hwaci.com/sw/sqlite/
  PySQLite   0.4.3    http://pysqlite.sourceforge.net

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.1.8  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


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 CVS 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.4 and
wxPython 2.5.


License
-------

Thuban is licensed under the terms of the GNU General Public License (GPL).

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
14			About the Name
15			--------------
16
17			Thuban is the name of a star in the constellation Draco (The Dragon).
18			About 4000 years ago it was the north star.
19
20
21	bh	1669	Requirements
22			------------
23
24			Thuban requires the following software to be installed:
25
26	bh	1893	Python 2.2.1 http://www.python.org
27	bernhard	2139	wxWidgets 2.4.0.4 http://www.wxwidgets.org (formerly known as wxWindows)
28	bh	1893	wxPython 2.4.0.4 http://www.wxpython.org
29			proj 4.4.5 http://www.remotesensing.org/proj/
30			SQLite 2.8.3 http://www.hwaci.com/sw/sqlite/
31			PySQLite 0.4.3 http://pysqlite.sourceforge.net
32	bh	1669
33	bh	1804	The versions given are the lowest versions that are known to work. for
34	bh	1669	proj, sqlite and pysqlite somewhat older versions probably work as well.
35	bernhard	2139	Note that the wxPython version must be the same as the wxWidgets version
36			(Some wxPython binary packages already contain the right wxWidgets version)
37	bh	1669
38			Optional software:
39
40			GDAL 1.1.8 http://www.remotesensing.org/gdal/
41			for raster image (geo-tiff) support
42
43			psycopg 1.0.x http://initd.org/software/psycopg
44			for postgis connections. Newer version probably also work
45
46
47	bh	2	Installation
48			------------
49
50	bh	69	Building Thuban (this compiles the extension modules but leaves them in
51			a directory under build/):
52	bh	2
53			python setup.py build
54
55
56			To setup Thuban to run directly from the source directory:
57
58			python setup.py install_local
59
60			You can run this without running build first.
61
62
63			To install Thuban:
64
65			python setup.py install
66
67
68			for general information about the command line options of the setup.py
69			script, run
70
71			python setup.py --help
72
73
74	bh	671	If you build from CVS and want to have translated menus, dialogs etc.
75			you have to build the message catalogs manually before you run setup.py.
76			See po/README for more information.
77	bh	2
78	bh	671
79	bh	2592	Build Troubleshooting
80			---------------------
81
82			When building Thuban, you might have problems because of a missing file
83			wx/wxPython/wxPython.h. This file is part of wxPython and may be
84			packaged in a separate package. Unfortunately, on some systems this
85			file is not packaged at all. On those systems you can try a work-around
86			built into Thuban, by passing the --use-wx-python-swig-hack to the
87			build_ext command. This can be done on the command line for the build
88			command like this:
89
90			python setup.py build_ext --use-wx-python-swig-hack build
91
92			You can also use it with the install_local command:
93
94			python setup.py build_ext --use-wx-python-swig-hack install_local
95
96			Note, that this work-around relies on some wxPython internals and may
97			cease to work at some point. We tested it with wxPython 2.4 and
98			wxPython 2.5.
99
100
101	bh	2	License
102			-------
103
104	bernhard	2139	Thuban is licensed under the terms of the GNU General Public License (GPL).
105	bh	2
106	bh	6	However, some of the extension modules in the extension subdirectory are
107	bernhard	2139	licensed under other Free Software licenses.
108			See the respective README files for details.
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision