install.txt 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190
  1. .. _ref-gis-install:
  2. ======================
  3. GeoDjango Installation
  4. ======================
  5. Overview
  6. ========
  7. In general, GeoDjango installation requires:
  8. 1. :ref:`python24` and :ref:`django`
  9. 2. :ref:`spatial_database`
  10. 3. :ref:`geospatial_libs`
  11. Details for each of the requirements and installation instructions
  12. are provided in the sections below. In addition, platform-specific
  13. instructions are available for:
  14. * :ref:`macosx`
  15. * :ref:`ubuntudebian`
  16. * :ref:`windows`
  17. .. admonition:: Use the Source
  18. Because GeoDjango takes advantage of the latest in the open source geospatial
  19. software technology, recent versions of the libraries are necessary.
  20. If binary packages aren't available for your platform,
  21. :ref:`installation from source <build_from_source>`
  22. may be required. When compiling the libraries from source, please follow the
  23. directions closely, especially if you're a beginner.
  24. Requirements
  25. ============
  26. .. _python24:
  27. Python 2.4+
  28. -----------
  29. Because of heavy use of the decorator syntax, Python 2.4 is minimum
  30. version supported by GeoDjango. Python 2.5+ is recommended because the
  31. `ctypes`__ module comes included; otherwise, 2.4 users will need to
  32. `download and install ctypes`__.
  33. __ http://docs.python.org/lib/module-ctypes.html
  34. __ http://sourceforge.net/projects/ctypes/files/
  35. .. _django:
  36. Django
  37. ------
  38. Because GeoDjango is included with Django, please refer to Django's
  39. :doc:`installation instructions </intro/install>` for details on how to install.
  40. .. _spatial_database:
  41. Spatial Database
  42. ----------------
  43. PostgreSQL (with PostGIS), MySQL, Oracle, and SQLite (with SpatiaLite) are
  44. the spatial databases currently supported.
  45. .. note::
  46. PostGIS is recommended, because it is the most mature and feature-rich
  47. open source spatial database.
  48. The geospatial libraries required for a GeoDjango installation depends
  49. on the spatial database used. The following lists the library requirements,
  50. supported versions, and any notes for each of the supported database backends:
  51. ================== ============================== ================== ==========================================================
  52. Database Library Requirements Supported Versions Notes
  53. ================== ============================== ================== ==========================================================
  54. PostgreSQL GEOS, PROJ.4, PostGIS 8.1+ Requires PostGIS.
  55. MySQL GEOS 5.x Not OGC-compliant; limited functionality.
  56. Oracle GEOS 10.2, 11 XE not supported; not tested with 9.
  57. SQLite GEOS, GDAL, PROJ.4, SpatiaLite 3.6.+ Requires SpatiaLite 2.3+, pysqlite2 2.5+, and Django 1.1.
  58. ================== ============================== ================== ==========================================================
  59. .. _geospatial_libs:
  60. Geospatial Libraries
  61. --------------------
  62. GeoDjango uses and/or provides interfaces for the the following open source
  63. geospatial libraries:
  64. ======================== ==================================== ================================ ==========================
  65. Program Description Required Supported Versions
  66. ======================== ==================================== ================================ ==========================
  67. :ref:`GEOS <ref-geos>` Geometry Engine Open Source Yes 3.2, 3.1, 3.0
  68. `PROJ.4`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 4.7, 4.6, 4.5, 4.4
  69. :ref:`GDAL <ref-gdal>` Geospatial Data Abstraction Library No (but, required for SQLite) 1.7, 1.6, 1.5, 1.4
  70. :ref:`GeoIP <ref-geoip>` IP-based geolocation library No 1.4
  71. `PostGIS`__ Spatial extensions for PostgreSQL Yes (PostgreSQL only) 1.5, 1.4, 1.3
  72. `SpatiaLite`__ Spatial extensions for SQLite Yes (SQLite only) 2.4, 2.3
  73. ======================== ==================================== ================================ ==========================
  74. .. admonition:: Install GDAL
  75. While :ref:`gdalbuild` is technically not required, it is *recommended*.
  76. Some features of GeoDjango (including the :ref:`ref-layermapping` and the geographic
  77. admin) depend on its functionality.
  78. .. note::
  79. The GeoDjango interfaces to GEOS, GDAL, and GeoIP may be used
  80. independently of Django. In other words, no database or settings file
  81. required -- just import them as normal from :mod:`django.contrib.gis`.
  82. .. _PROJ.4: http://trac.osgeo.org/proj/
  83. __ http://postgis.refractions.net/
  84. __ http://www.gaia-gis.it/spatialite/index.html
  85. .. _build_from_source:
  86. Building from Source
  87. ====================
  88. When installing from source on UNIX and GNU/Linux systems, please follow
  89. the installation instructions carefully, and install the libraries in the
  90. given order. If using MySQL or Oracle as the spatial database, only GEOS
  91. is required.
  92. .. note::
  93. On Linux platforms, it may be necessarry to run the ``ldconfig``
  94. command after installing each library. For example::
  95. $ sudo make install
  96. $ sudo ldconfig
  97. .. note::
  98. OS X users are required to install `Apple Developer Tools`_ in order
  99. to compile software from source. This is typically included on your
  100. OS X installation DVDs.
  101. .. _Apple Developer Tools: http://developer.apple.com/tools/xcode/
  102. .. _geosbuild:
  103. GEOS
  104. ----
  105. GEOS is a C++ library for performing geometric operations, and is the default
  106. internal geometry representation used by GeoDjango (it's behind the "lazy"
  107. geometries). Specifically, the C API library is called (e.g., ``libgeos_c.so``)
  108. directly from Python using ctypes.
  109. First, download GEOS 3.2 from the refractions Web site and untar the source
  110. archive::
  111. $ wget http://download.osgeo.org/geos/geos-3.2.2.tar.bz2
  112. $ tar xjf geos-3.2.2.tar.bz2
  113. Next, change into the directory where GEOS was unpacked, run the configure
  114. script, compile, and install::
  115. $ cd geos-3.2.2
  116. $ ./configure
  117. $ make
  118. $ sudo make install
  119. $ cd ..
  120. Troubleshooting
  121. ^^^^^^^^^^^^^^^
  122. Can't find GEOS Library
  123. ~~~~~~~~~~~~~~~~~~~~~~~
  124. When GeoDjango can't find GEOS, this error is raised::
  125. ImportError: Could not find the GEOS library (tried "geos_c"). Try setting GEOS_LIBRARY_PATH in your settings.
  126. The most common solution is to properly configure your :ref:`libsettings` *or* set
  127. :ref:`geoslibrarypath` in your settings.
  128. If using a binary package of GEOS (e.g., on Ubuntu 8.10), you may need to :ref:`binutils`.
  129. .. _geoslibrarypath:
  130. ``GEOS_LIBRARY_PATH``
  131. ~~~~~~~~~~~~~~~~~~~~~
  132. If your GEOS library is in a non-standard location, or you don't want to
  133. modify the system's library path then the :setting:`GEOS_LIBRARY_PATH` setting
  134. may be added to your Django settings file with the full path to the GEOS
  135. C library. For example::
  136. GEOS_LIBRARY_PATH = '/home/bob/local/lib/libgeos_c.so'
  137. .. note::
  138. The setting must be the *full* path to the **C** shared library; in
  139. other words you want to use ``libgeos_c.so``, not ``libgeos.so``.
  140. .. _proj4:
  141. PROJ.4
  142. ------
  143. `PROJ.4`_ is a library for converting geospatial data to different coordinate
  144. reference systems.
  145. First, download the PROJ.4 source code and datum shifting files [#]_::
  146. $ wget http://download.osgeo.org/proj/proj-4.7.0.tar.gz
  147. $ wget http://download.osgeo.org/proj/proj-datumgrid-1.5.zip
  148. Next, untar the source code archive, and extract the datum shifting files in the
  149. ``nad`` subdirectory. This must be done *prior* to configuration::
  150. $ tar xzf proj-4.7.0.tar.gz
  151. $ cd proj-4.7.0/nad
  152. $ unzip ../../proj-datumgrid-1.5.zip
  153. $ cd ..
  154. Finally, configure, make and install PROJ.4::
  155. $ ./configure
  156. $ make
  157. $ sudo make install
  158. $ cd ..
  159. .. _postgis:
  160. PostGIS
  161. -------
  162. `PostGIS`__ adds geographic object support to PostgreSQL, turning it
  163. into a spatial database. :ref:`geosbuild` and :ref:`proj4` should be
  164. installed prior to building PostGIS.
  165. .. note::
  166. The `psycopg2`_ module is required for use as the database adaptor
  167. when using GeoDjango with PostGIS.
  168. .. _psycopg2: http://initd.org/projects/psycopg2
  169. First download the source archive, and extract::
  170. $ wget http://postgis.refractions.net/download/postgis-1.5.1.tar.gz
  171. $ tar xzf postgis-1.5.1.tar.gz
  172. $ cd postgis-1.5.1
  173. Next, configure, make and install PostGIS::
  174. $ ./configure
  175. Finally, make and install::
  176. $ make
  177. $ sudo make install
  178. $ cd ..
  179. .. note::
  180. GeoDjango does not automatically create a spatial database. Please
  181. consult the section on :ref:`spatialdb_template` for more information.
  182. __ http://postgis.refractions.net/
  183. .. _gdalbuild:
  184. GDAL
  185. ----
  186. `GDAL`__ is an excellent open source geospatial library that has support for
  187. reading most vector and raster spatial data formats. Currently, GeoDjango only
  188. supports :ref:`GDAL's vector data <ref-gdal>` capabilities [#]_.
  189. :ref:`geosbuild` and :ref:`proj4` should be installed prior to building GDAL.
  190. First download the latest GDAL release version and untar the archive::
  191. $ wget http://download.osgeo.org/gdal/gdal-1.7.2.tar.gz
  192. $ tar xzf gdal-1.7.2.tar.gz
  193. $ cd gdal-1.7.2
  194. Configure, make and install::
  195. $ ./configure
  196. $ make # Go get some coffee, this takes a while.
  197. $ sudo make install
  198. $ cd ..
  199. .. note::
  200. Because GeoDjango has it's own Python interface, the preceding instructions
  201. do not build GDAL's own Python bindings. The bindings may be built by
  202. adding the ``--with-python`` flag when running ``configure``. See
  203. `GDAL/OGR In Python`__ for more information on GDAL's bindings.
  204. If you have any problems, please see the troubleshooting section below for
  205. suggestions and solutions.
  206. __ http://trac.osgeo.org/gdal/
  207. __ http://trac.osgeo.org/gdal/wiki/GdalOgrInPython
  208. .. _gdaltrouble:
  209. Troubleshooting
  210. ^^^^^^^^^^^^^^^
  211. Can't find GDAL Library
  212. ~~~~~~~~~~~~~~~~~~~~~~~
  213. When GeoDjango can't find the GDAL library, the ``HAS_GDAL`` flag
  214. will be false::
  215. >>> from django.contrib.gis import gdal
  216. >>> gdal.HAS_GDAL
  217. False
  218. The solution is to properly configure your :ref:`libsettings` *or* set
  219. :ref:`gdallibrarypath` in your settings.
  220. .. _gdallibrarypath:
  221. ``GDAL_LIBRARY_PATH``
  222. ~~~~~~~~~~~~~~~~~~~~~
  223. If your GDAL library is in a non-standard location, or you don't want to
  224. modify the system's library path then the :setting:`GDAL_LIBRARY_PATH`
  225. setting may be added to your Django settings file with the full path to
  226. the GDAL library. For example::
  227. GDAL_LIBRARY_PATH = '/home/sue/local/lib/libgdal.so'
  228. .. _gdaldata:
  229. Can't find GDAL data files (``GDAL_DATA``)
  230. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  231. When installed from source, GDAL versions 1.5.1 and below have an autoconf bug
  232. that places data in the wrong location. [#]_ This can lead to error messages
  233. like this::
  234. ERROR 4: Unable to open EPSG support file gcs.csv.
  235. ...
  236. OGRException: OGR failure.
  237. The solution is to set the ``GDAL_DATA`` environment variable to the location of the
  238. GDAL data files before invoking Python (typically ``/usr/local/share``; use
  239. ``gdal-config --datadir`` to find out). For example::
  240. $ export GDAL_DATA=`gdal-config --datadir`
  241. $ python manage.py shell
  242. If using Apache, you may need to add this environment variable to your configuration
  243. file::
  244. SetEnv GDAL_DATA /usr/local/share
  245. .. _spatialite:
  246. SpatiaLite
  247. ----------
  248. .. versionadded:: 1.1
  249. .. note::
  250. Mac OS X users should follow the instructions in the :ref:`kyngchaos` section,
  251. as it is much easier than building from source.
  252. `SpatiaLite`__ adds spatial support to SQLite, turning it into a full-featured
  253. spatial database. Because SpatiaLite has special requirements, it typically
  254. requires SQLite and pysqlite2 (the Python SQLite DB-API adaptor) to be built from
  255. source. :ref:`geosbuild` and :ref:`proj4` should be installed prior to building
  256. SpatiaLite.
  257. After installation is complete, don't forget to read the post-installation
  258. docs on :ref:`create_spatialite_db`.
  259. __ http://www.gaia-gis.it/spatialite/index.html
  260. .. _sqlite:
  261. SQLite
  262. ^^^^^^
  263. Typically, SQLite packages are not compiled to include the `R*Tree module`__ --
  264. thus it must be compiled from source. First download the latest amalgamation
  265. source archive from the `SQLite download page`__, and extract::
  266. $ wget http://sqlite.org/sqlite-amalgamation-3.6.23.1.tar.gz
  267. $ tar xzf sqlite-amalgamation-3.6.23.1.tar.gz
  268. $ cd sqlite-3.6.23.1
  269. Next, run the ``configure`` script -- however the ``CFLAGS`` environment variable
  270. needs to be customized so that SQLite knows to build the R*Tree module::
  271. $ CFLAGS="-DSQLITE_ENABLE_RTREE=1" ./configure
  272. $ make
  273. $ sudo make install
  274. $ cd ..
  275. .. note::
  276. If using Ubuntu, installing a newer SQLite from source can be very difficult
  277. because it links to the existing ``libsqlite3.so`` in ``/usr/lib`` which
  278. many other packages depend on. Unfortunately, the best solution at this time
  279. is to overwrite the existing library by adding ``--prefix=/usr`` to the
  280. ``configure`` command.
  281. __ http://www.sqlite.org/rtree.html
  282. __ http://www.sqlite.org/download.html
  283. .. _spatialitebuild :
  284. SpatiaLite Library (``libspatialite``) and Tools (``spatialite``)
  285. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  286. After SQLite has been built with the R*Tree module enabled, get the latest
  287. SpatiaLite library source and tools bundle from the `download page`__::
  288. $ wget http://www.gaia-gis.it/spatialite/libspatialite-amalgamation-2.3.1.tar.gz
  289. $ wget http://www.gaia-gis.it/spatialite/spatialite-tools-2.3.1.tar.gz
  290. $ tar xzf libspatialite-amalgamation-2.3.1.tar.gz
  291. $ tar xzf spatialite-tools-2.3.1.tar.gz
  292. Prior to attempting to build, please read the important notes below to see if
  293. customization of the ``configure`` command is necessary. If not, then run the
  294. ``configure`` script, make, and install for the SpatiaLite library::
  295. $ cd libspatialite-amalgamation-2.3.1
  296. $ ./configure # May need to modified, see notes below.
  297. $ make
  298. $ sudo make install
  299. $ cd ..
  300. Finally, do the same for the SpatiaLite tools::
  301. $ cd spatialite-tools-2.3.1
  302. $ ./configure # May need to modified, see notes below.
  303. $ make
  304. $ sudo make install
  305. $ cd ..
  306. .. note::
  307. If you've installed GEOS and PROJ.4 from binary packages, you will have to specify
  308. their paths when running the ``configure`` scripts for *both* the library and the
  309. tools (the configure scripts look, by default, in ``/usr/local``). For example,
  310. on Debian/Ubuntu distributions that have GEOS and PROJ.4 packages, the command would be::
  311. $ ./configure --with-proj-include=/usr/include --with-proj-lib=/usr/lib --with-geos-include=/usr/include --with-geos-lib=/usr/lib
  312. .. note::
  313. For Mac OS X users building from source, the SpatiaLite library *and* tools
  314. need to have their ``target`` configured::
  315. $ ./configure --target=macosx
  316. __ http://www.gaia-gis.it/spatialite/sources.html
  317. .. _pysqlite2:
  318. pysqlite2
  319. ^^^^^^^^^
  320. Because SpatiaLite must be loaded as an external extension, it requires the
  321. ``enable_load_extension`` method, which is only available in versions 2.5+.
  322. Thus, download pysqlite2 2.6, and untar::
  323. $ wget http://pysqlite.googlecode.com/files/pysqlite-2.6.0.tar.gz
  324. $ tar xzf pysqlite-2.6.0.tar.gz
  325. $ cd pysqlite-2.6.0
  326. Next, use a text editor (e.g., ``emacs`` or ``vi``) to edit the ``setup.cfg`` file
  327. to look like the following::
  328. [build_ext]
  329. #define=
  330. include_dirs=/usr/local/include
  331. library_dirs=/usr/local/lib
  332. libraries=sqlite3
  333. #define=SQLITE_OMIT_LOAD_EXTENSION
  334. .. note::
  335. The important thing here is to make sure you comment out the the
  336. ``define=SQLITE_OMIT_LOAD_EXTENSION`` flag and that the ``include_dirs``
  337. and ``library_dirs`` settings are uncommented and set to the appropriate
  338. path if the SQLite header files and libraries are not in ``/usr/include``
  339. and ``/usr/lib``, respectively.
  340. After modifying ``setup.cfg`` appropriately, then run the ``setup.py`` script
  341. to build and install::
  342. $ sudo python setup.py install
  343. Post-Installation
  344. =================
  345. .. _spatialdb_template:
  346. Creating a Spatial Database Template for PostGIS
  347. ------------------------------------------------
  348. Creating a spatial database with PostGIS is different than normal because
  349. additional SQL must be loaded to enable spatial functionality. Because of
  350. the steps in this process, it's better to create a database template that
  351. can be reused later.
  352. First, you need to be able to execute the commands as a privileged database
  353. user. For example, you can use the following to become the ``postgres`` user::
  354. $ sudo su - postgres
  355. .. note::
  356. The location *and* name of the PostGIS SQL files (e.g., from
  357. ``POSTGIS_SQL_PATH`` below) depends on the version of PostGIS.
  358. PostGIS versions 1.3 and below use ``<pg_sharedir>/contrib/lwpostgis.sql``;
  359. whereas version 1.4 uses ``<sharedir>/contrib/postgis.sql`` and
  360. version 1.5 uses ``<sharedir>/contrib/postgis-1.5/postgis.sql``.
  361. The example below assumes PostGIS 1.5, thus you may need to modify
  362. ``POSTGIS_SQL_PATH`` and the name of the SQL file for the specific
  363. version of PostGIS you are using.
  364. Once you're a database super user, then you may execute the following commands
  365. to create a PostGIS spatial database template. If running Ubuntu :ref:`ibex`
  366. or Debian :ref:`lenny`, please refer to their specific documentation for
  367. modifications to these commands::
  368. $ POSTGIS_SQL_PATH=`pg_config --sharedir`/contrib/postgis-1.5
  369. # Creating the template spatial database.
  370. $ createdb -E UTF8 template_postgis
  371. $ createlang -d template_postgis plpgsql # Adding PLPGSQL language support.
  372. # Allows non-superusers the ability to create from this template
  373. $ psql -d postgres -c "UPDATE pg_database SET datistemplate='true' WHERE datname='template_postgis';"
  374. # Loading the PostGIS SQL routines
  375. $ psql -d template_postgis -f $POSTGIS_SQL_PATH/postgis.sql
  376. $ psql -d template_postgis -f $POSTGIS_SQL_PATH/spatial_ref_sys.sql
  377. # Enabling users to alter spatial tables.
  378. $ psql -d template_postgis -c "GRANT ALL ON geometry_columns TO PUBLIC;"
  379. $ psql -d template_postgis -c "GRANT ALL ON geography_columns TO PUBLIC;"
  380. $ psql -d template_postgis -c "GRANT ALL ON spatial_ref_sys TO PUBLIC;"
  381. These commands may be placed in a shell script for later use; for convenience
  382. the following scripts are available:
  383. =============== ==========================================
  384. PostGIS Version Shell Script
  385. =============== ==========================================
  386. 1.3 `create_template_postgis-1.3.sh`_
  387. 1.4 `create_template_postgis-1.4.sh`_
  388. 1.5 `create_template_postgis-1.5.sh`_
  389. =============== ==========================================
  390. Afterwards, you may create a spatial database by simply specifying
  391. ``template_postgis`` as the template to use (via the ``-T`` option)::
  392. $ createdb -T template_postgis <db name>
  393. .. note::
  394. While the ``createdb`` command does not require database super-user privileges,
  395. it must be executed by a database user that has permissions to create databases.
  396. You can create such a user with the following command::
  397. $ createuser --createdb <user>
  398. .. _create_template_postgis-1.3.sh: http://geodjango.org/docs/create_template_postgis-1.3.sh
  399. .. _create_template_postgis-1.4.sh: http://geodjango.org/docs/create_template_postgis-1.4.sh
  400. .. _create_template_postgis-1.5.sh: http://geodjango.org/docs/create_template_postgis-1.5.sh
  401. .. _create_template_postgis-debian.sh: http://geodjango.org/docs/create_template_postgis-debian.sh
  402. .. _create_spatialite_db:
  403. Creating a Spatial Database for SpatiaLite
  404. -------------------------------------------
  405. After the SpatiaLite library and tools have been installed, it is now possible
  406. to create spatial database for use with GeoDjango. In order to do this, download
  407. the spatial database initialization SQL from the `SpatiaLite Resources`__ page::
  408. $ wget http://www.gaia-gis.it/spatialite/init_spatialite-2.3.sql.gz
  409. $ gunzip init_spatialite-2.3.sql.gz
  410. Now, the ``spatialite`` command can be used to initialize a spatial database::
  411. $ spatialite geodjango.db < init_spatialite-2.3.sql
  412. .. note::
  413. The parameter ``geodjango.db`` is the *filename* of the SQLite database
  414. you want to use. Use the same in the :setting:`DATABASE_NAME`
  415. inside your ``settings.py``.
  416. __ http://www.gaia-gis.it/spatialite/resources.html
  417. Add ``django.contrib.gis`` to ``INSTALLED_APPS``
  418. ------------------------------------------------
  419. Like other Django contrib applications, you will *only* need to add
  420. :mod:`django.contrib.gis` to :setting:`INSTALLED_APPS` in your settings.
  421. This is the so that ``gis`` templates can be located -- if not done, then
  422. features such as the geographic admin or KML sitemaps will not function properly.
  423. .. _addgoogleprojection:
  424. Add Google Projection to ``spatial_ref_sys`` table
  425. --------------------------------------------------
  426. .. versionchanged:: 1.2
  427. .. note::
  428. If running PostGIS 1.4 and above, the entry is already included in the
  429. default ``spatial_ref_sys`` table. You can skip this step.
  430. In order to conduct database transformations to the so-called "Google"
  431. projection (a spherical mercator projection used by Google Maps),
  432. an entry must be added to your spatial database's ``spatial_ref_sys`` table.
  433. Invoke the Django shell from your project and execute the
  434. ``add_srs_entry`` function::
  435. $ python manage shell
  436. >>> from django.contrib.gis.utils import add_srs_entry
  437. >>> add_srs_entry(900913)
  438. .. note::
  439. In Django 1.1 the name of this function is ``add_postgis_srs``.
  440. This adds an entry for the 900913 SRID to the ``spatial_ref_sys`` (or equivalent)
  441. table, making it possible for the spatial database to transform coordinates in
  442. this projection. You only need to execute this command *once* per spatial database.
  443. Troubleshooting
  444. ===============
  445. If you can't find the solution to your problem here then participate in the
  446. community! You can:
  447. * Join the ``#geodjango`` IRC channel on FreeNode (may be accessed on the
  448. Web via `Mibbit`__). Please be patient and polite -- while you may not
  449. get an immediate response, someone will attempt to answer your question
  450. as soon as they see it.
  451. * Ask your question on the `GeoDjango`__ mailing list.
  452. * File a ticket on the `Django trac`__ if you think there's a bug. Make
  453. sure to provide a complete description of the problem, versions used,
  454. and specify the component as "GIS".
  455. __ http://www.mibbit.com/?server=irc.freenode.net&channel=%23geodjango
  456. __ http://groups.google.com/group/geodjango
  457. __ http://code.djangoproject.com/simpleticket
  458. .. _libsettings:
  459. Library Environment Settings
  460. ----------------------------
  461. By far, the most common problem when installing GeoDjango is that the
  462. external shared libraries (e.g., for GEOS and GDAL) cannot be located. [#]_
  463. Typically, the cause of this problem is that the operating system isn't aware
  464. of the directory where the libraries built from source were installed.
  465. In general, the library path may be set on a per-user basis by setting
  466. an environment variable, or by configuring the library path for the entire
  467. system.
  468. ``LD_LIBRARY_PATH`` environment variable
  469. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  470. A user may set this environment variable to customize the library paths
  471. they want to use. The typical library directory for software
  472. built from source is ``/usr/local/lib``. Thus, ``/usr/local/lib`` needs
  473. to be included in the ``LD_LIBRARY_PATH`` variable. For example, the user
  474. could place the following in their bash profile::
  475. export LD_LIBRARY_PATH=/usr/local/lib
  476. Setting System Library Path
  477. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  478. On GNU/Linux systems, there is typically a file in ``/etc/ld.so.conf``, which may include
  479. additional paths from files in another directory, such as ``/etc/ld.so.conf.d``.
  480. As the root user, add the custom library path (like ``/usr/local/lib``) on a
  481. new line in ``ld.so.conf``. This is *one* example of how to do so::
  482. $ sudo echo /usr/local/lib >> /etc/ld.so.conf
  483. $ sudo ldconfig
  484. For OpenSolaris users, the system library path may be modified using the
  485. ``crle`` utility. Run ``crle`` with no options to see the current configuration
  486. and use ``crle -l`` to set with the new library path. Be *very* careful when
  487. modifying the system library path::
  488. # crle -l $OLD_PATH:/usr/local/lib
  489. .. _binutils:
  490. Install ``binutils``
  491. ^^^^^^^^^^^^^^^^^^^^
  492. GeoDjango uses the ``find_library`` function (from the ``ctypes.util`` Python
  493. module) to discover libraries. The ``find_library`` routine uses a program
  494. called ``objdump`` (part of the ``binutils`` package) to verify a shared
  495. library on GNU/Linux systems. Thus, if ``binutils`` is not installed on your
  496. Linux system then Python's ctypes may not be able to find your library even if
  497. your library path is set correctly and geospatial libraries were built perfectly.
  498. The ``binutils`` package may be installed on Debian and Ubuntu systems using the
  499. following command::
  500. $ sudo apt-get install binutils
  501. Similarly, on Red Hat and CentOS systems::
  502. $ sudo yum install binutils
  503. Platform Specific Instructions
  504. ==============================
  505. .. _macosx:
  506. Mac OS X
  507. --------
  508. Because of the variety of packaging systems available for OS X, users have
  509. several different options for installing GeoDjango. These options are:
  510. * :ref:`kyngchaos`
  511. * :ref:`fink`
  512. * :ref:`macports`
  513. * :ref:`build_from_source`
  514. .. note::
  515. Currently, the easiest and recommended approach for installing GeoDjango
  516. on OS X is to use the KyngChaos packages.
  517. This section also includes instructions for installing an upgraded version
  518. of :ref:`macosx_python` from packages provided by the Python Software
  519. Foundation, however, this is not required.
  520. .. _macosx_python:
  521. Python
  522. ^^^^^^
  523. Although OS X comes with Python installed, users can use framework
  524. installers (`2.5`__ and `2.6`__ are available) provided by
  525. the Python Software Foundation. An advantage to using the installer is
  526. that OS X's Python will remain "pristine" for internal operating system
  527. use.
  528. __ http://python.org/ftp/python/2.5.4/python-2.5.4-macosx.dmg
  529. __ http://python.org/ftp/python/2.6.2/python-2.6.2-macosx2009-04-16.dmg
  530. .. note::
  531. You will need to modify the ``PATH`` environment variable in your
  532. ``.profile`` file so that the new version of Python is used when
  533. ``python`` is entered at the command-line::
  534. export PATH=/Library/Frameworks/Python.framework/Versions/Current/bin:$PATH
  535. .. _kyngchaos:
  536. KyngChaos Packages
  537. ^^^^^^^^^^^^^^^^^^
  538. William Kyngesburye provides a number of `geospatial library binary packages`__
  539. that make it simple to get GeoDjango installed on OS X without compiling
  540. them from source. However, the `Apple Developer Tools`_ are still necessary
  541. for compiling the Python database adapters :ref:`psycopg2_kyngchaos` (for PostGIS)
  542. and :ref:`pysqlite2_kyngchaos` (for SpatiaLite).
  543. .. note::
  544. SpatiaLite users should consult the :ref:`spatialite_kyngchaos` section
  545. after installing the packages for additional instructions.
  546. Download the framework packages for:
  547. * UnixImageIO
  548. * PROJ
  549. * GEOS
  550. * SQLite3 (includes the SpatiaLite library)
  551. * GDAL
  552. Install the packages in the order they are listed above, as the GDAL and SQLite
  553. packages require the packages listed before them. Afterwards, you can also
  554. install the KyngChaos binary packages for `PostgreSQL and PostGIS`__.
  555. After installing the binary packages, you'll want to add the following to
  556. your ``.profile`` to be able to run the package programs from the command-line::
  557. export PATH=/Library/Frameworks/UnixImageIO.framework/Programs:$PATH
  558. export PATH=/Library/Frameworks/PROJ.framework/Programs:$PATH
  559. export PATH=/Library/Frameworks/GEOS.framework/Programs:$PATH
  560. export PATH=/Library/Frameworks/SQLite3.framework/Programs:$PATH
  561. export PATH=/Library/Frameworks/GDAL.framework/Programs:$PATH
  562. export PATH=/usr/local/pgsql/bin:$PATH
  563. __ http://www.kyngchaos.com/software/frameworks
  564. __ http://www.kyngchaos.com/software/postgres
  565. .. note::
  566. Use of these binaries requires Django 1.0.3 and above. If you are
  567. using a previous version of Django (like 1.0.2), then you will have
  568. to add the the following in your settings::
  569. GEOS_LIBRARY_PATH='/Library/Frameworks/GEOS.framework/GEOS'
  570. GDAL_LIBRARY_PATH='/Library/Frameworks/GDAL.framework/GDAL'
  571. .. _psycopg2_kyngchaos:
  572. psycopg2
  573. ~~~~~~~~
  574. After you've installed the KyngChaos binaries and modified your ``PATH``, as
  575. described above, ``psycopg2`` may be installed using the following command::
  576. $ sudo python easy_install psycopg2
  577. .. note::
  578. To use ``easy_install`` you'll need to install Python's `setuptools`_.
  579. .. _setuptools: http://pypi.python.org/pypi/setuptools
  580. .. _pysqlite2_kyngchaos:
  581. pysqlite2
  582. ~~~~~~~~~
  583. Follow the :ref:`pysqlite2` source install instructions, however,
  584. when editing the ``setup.cfg`` use the following instead::
  585. [build_ext]
  586. #define=
  587. include_dirs=/Library/Frameworks/SQLite3.framework/unix/include
  588. library_dirs=/Library/Frameworks/SQLite3.framework/unix/lib
  589. libraries=sqlite3
  590. #define=SQLITE_OMIT_LOAD_EXTENSION
  591. .. _spatialite_kyngchaos:
  592. SpatiaLite
  593. ~~~~~~~~~~
  594. When :ref:`create_spatialite_db`, the ``spatialite`` program is required.
  595. However, instead of attempting to compile the SpatiaLite tools from source,
  596. download the `SpatiaLite Binaries`__ for OS X, and install ``spatialite`` in a
  597. location available in your ``PATH``. For example::
  598. $ curl -O http://www.gaia-gis.it/spatialite/spatialite-tools-osx-x86-2.3.1.tar.gz
  599. $ tar xzf spatialite-tools-osx-x86-2.3.1.tar.gz
  600. $ cd spatialite-tools-osx-x86-2.3.1/bin
  601. $ sudo cp spatialite /Library/Frameworks/SQLite3.framework/Programs
  602. Finally, for GeoDjango to be able to find the KyngChaos SpatiaLite library,
  603. add the following to your ``settings.py``::
  604. SPATIALITE_LIBRARY_PATH='/Library/Frameworks/SQLite3.framework/SQLite3'
  605. __ http://www.gaia-gis.it/spatialite/binaries.html
  606. .. _fink:
  607. Fink
  608. ^^^^
  609. `Kurt Schwehr`__ has been gracious enough to create GeoDjango packages for users
  610. of the `Fink`__ package system. The following packages are available, depending
  611. on which version of Python you want to use:
  612. * ``django-gis-py26``
  613. * ``django-gis-py25``
  614. * ``django-gis-py24``
  615. __ http://schwehr.org/blog/
  616. __ http://www.finkproject.org/
  617. .. _macports:
  618. MacPorts
  619. ^^^^^^^^
  620. `MacPorts`__ may be used to install GeoDjango prerequisites on Macintosh
  621. computers running OS X. Because MacPorts still builds the software from source,
  622. the `Apple Developer Tools`_ are required.
  623. Summary::
  624. $ sudo port install postgresql83-server
  625. $ sudo port install geos
  626. $ sudo port install proj
  627. $ sudo port install postgis
  628. $ sudo port install gdal
  629. $ sudo port install libgeoip
  630. .. note::
  631. You will also have to modify the ``PATH`` in your ``.profile`` so
  632. that the MacPorts programs are accessible from the command-line::
  633. export PATH=/opt/local/bin:/opt/local/lib/postgresql83/bin
  634. In addition, add the ``FALLBACK_DYLD_LIBRARY_PATH`` setting so that
  635. the libraries can be found by Python::
  636. export FALLBACK_DYLD_LIBRARY_PATH=/opt/local/lib:/opt/local/lib/postgresql83
  637. __ http://www.macports.org/
  638. .. _ubuntudebian:
  639. Ubuntu & Debian GNU/Linux
  640. -------------------------
  641. .. _ubuntu:
  642. Ubuntu
  643. ^^^^^^
  644. .. _heron:
  645. 8.04 and lower
  646. ~~~~~~~~~~~~~~
  647. The 8.04 (and lower) versions of Ubuntu use GEOS v2.2.3 in their binary packages,
  648. which is incompatible with GeoDjango. Thus, do *not* use the binary packages
  649. for GEOS or PostGIS and build some prerequisites from source, per the instructions
  650. in this document; however, it is okay to use the PostgreSQL binary packages.
  651. For more details, please see the Debian instructions for :ref:`etch` below.
  652. .. _ibex:
  653. 8.10
  654. ~~~~
  655. Use the synaptic package manager to install the following packages::
  656. $ sudo apt-get install binutils libgdal1-1.5.0 postgresql-8.3-postgis postgresql-server-dev-8.3 python-psycopg2 python-setuptools
  657. Afterwards, you may install Django with Python's ``easy_install`` script (the
  658. Ubuntu package ``python-django`` uses an older version missing several
  659. important bug fixes for GeoDjango)::
  660. $ sudo easy_install Django
  661. That's it! For the curious, the required binary prerequisites packages are:
  662. * ``binutils``: for ctypes to find libraries
  663. * ``postgresql-8.3``
  664. * ``postgresql-server-dev-8.3``: for ``pg_config``
  665. * ``postgresql-8.3-postgis``: for PostGIS 1.3.3
  666. * ``libgeos-3.0.0``, and ``libgeos-c1``: for GEOS 3.0.0
  667. * ``libgdal1-1.5.0``: for GDAL 1.5.0 library
  668. * ``proj``: for PROJ 4.6.0 -- but no datum shifting files, see note below
  669. * ``python-psycopg2``
  670. * ``python-setuptools``: for ``easy_install``
  671. Optional packages to consider:
  672. * ``libgeoip1``: for :ref:`GeoIP <ref-geoip>` support
  673. * ``gdal-bin``: for GDAL command line programs like ``ogr2ogr``
  674. * ``python-gdal`` for GDAL's own Python bindings -- includes interfaces for raster manipulation
  675. .. note::
  676. The Ubuntu ``proj`` package does not come with the datum shifting files
  677. installed, which will cause problems with the geographic admin because
  678. the ``null`` datum grid is not available for transforming geometries to the
  679. spherical mercator projection. A solution is to download the
  680. datum-shifting files, create the grid file, and install it yourself::
  681. $ wget http://download.osgeo.org/proj/proj-datumgrid-1.4.tar.gz
  682. $ mkdir nad
  683. $ cd nad
  684. $ tar xzf ../proj-datumgrid-1.4.tar.gz
  685. $ nad2bin null < null.lla
  686. $ sudo cp null /usr/share/proj
  687. Otherwise, the Ubuntu ``proj`` package is fine for general use as long as you
  688. do not plan on doing any database transformation of geometries to the
  689. Google projection (900913).
  690. .. note::
  691. The PostGIS SQL files are not placed the PostgreSQL share directory in the
  692. Ubuntu packages. Use the `create_template_postgis-debian.sh`_ script
  693. instead when :ref:`spatialdb_template`.
  694. .. _debian:
  695. Debian
  696. ------
  697. .. _etch:
  698. 4.0 (Etch)
  699. ^^^^^^^^^^
  700. The situation here is the same as that of Ubuntu :ref:`heron` -- in other words,
  701. some packages must be built from source to work properly with GeoDjango.
  702. Binary Packages
  703. ~~~~~~~~~~~~~~~
  704. The following command will install acceptable binary packages, as well as
  705. the development tools necessary to build the rest of the requirements::
  706. $ sudo apt-get install binutils bzip2 gcc g++ flex make postgresql-8.1 postgresql-server-dev-8.1 python-ctypes python-psycopg2 python-setuptools
  707. Required package information:
  708. * ``binutils``: for ctypes to find libraries
  709. * ``bzip2``: for decompressing the source packages
  710. * ``gcc``, ``g++``, ``make``: GNU developer tools used to compile the libraries
  711. * ``flex``: required to build PostGIS
  712. * ``postgresql-8.1``
  713. * ``postgresql-server-dev-8.1``: for ``pg_config``
  714. * ``python-ctypes``: Python 2.4 needs to have ctypes installed separately
  715. * ``python-psycopg2``
  716. * ``python-setuptools``: for ``easy_install``
  717. Optional packages:
  718. * ``libgeoip``: for :ref:`GeoIP <ref-geoip>` support
  719. Source Packages
  720. ~~~~~~~~~~~~~~~
  721. You will still have to install :ref:`geosbuild`, :ref:`proj4`,
  722. :ref:`postgis`, and :ref:`gdalbuild` from source. Please follow the
  723. directions carefully.
  724. .. _lenny:
  725. 5.0 (Lenny)
  726. ^^^^^^^^^^^
  727. This version is comparable to Ubuntu :ref:`ibex`, so the command
  728. is very similar::
  729. $ sudo apt-get install binutils libgdal1-1.5.0 postgresql-8.3 postgresql-8.3-postgis postgresql-server-dev-8.3 python-psycopg2 python-setuptools
  730. This assumes that you are using PostgreSQL version 8.3. Else, replace ``8.3``
  731. in the above command with the appropriate PostgreSQL version.
  732. .. note::
  733. Please read the note in the Ubuntu :ref:`ibex` install documentation
  734. about the ``proj`` package -- it also applies here because the package does
  735. not include the datum shifting files.
  736. .. _post_install:
  737. Post-installation Notes
  738. ~~~~~~~~~~~~~~~~~~~~~~~
  739. If the PostgreSQL database cluster was not initiated after installing, then it
  740. can be created (and started) with the following command::
  741. $ sudo pg_createcluster --start 8.3 main
  742. Afterwards, the ``/etc/init.d/postgresql-8.3`` script should be used to manage
  743. the starting and stopping of PostgreSQL.
  744. In addition, the SQL files for PostGIS are placed in a different location on
  745. Debian 5.0 . Thus when :ref:`spatialdb_template` either:
  746. * Create a symbolic link to these files::
  747. $ sudo ln -s /usr/share/postgresql-8.3-postgis/{lwpostgis,spatial_ref_sys}.sql /usr/share/postgresql/8.3
  748. If not running PostgreSQL 8.3, then replace ``8.3`` in the command above with the correct version.
  749. * Or use the `create_template_postgis-debian.sh`_ to create the spatial database.
  750. .. _windows:
  751. Windows XP
  752. ----------
  753. Python
  754. ^^^^^^
  755. First, download the `Python 2.6 installer`__ from the Python Web site. Next,
  756. execute the installer and use defaults, e.g., keep 'Install for all users'
  757. checked and the installation path set as ``C:\Python26``.
  758. .. note::
  759. You may already have a version of Python installed in ``C:\python`` as ESRI
  760. products sometimes install a copy there. *You should still install a
  761. fresh version of Python 2.6.*
  762. __ http://python.org/ftp/python/2.6.2/python-2.6.2.msi
  763. PostgreSQL
  764. ^^^^^^^^^^
  765. First, select a mirror and download the latest `PostgreSQL 8.3 installer`__ from
  766. the EnterpriseDB Web site.
  767. .. note::
  768. PostgreSQL 8.3 is required because PostGIS is not available yet for 8.4.
  769. After downloading, simply click on the installer, follow the
  770. on-screen directions, and keep the default options (e.g., keep the installation
  771. path as ``C:\Program Files\PostgreSQL\8.3``).
  772. .. note::
  773. This PostgreSQL installation process will create both a new windows user to be the
  774. 'postgres service account' and a special 'postgres superuser' to own the database
  775. cluster. You will be prompted to set a password for both users (make sure to write
  776. them down!). To see basic details on the 'service user' account right click on
  777. 'My Computer' and select 'Manage' or go to: Control Panel -> Administrative Tools ->
  778. Computer Management -> System Tools -> Local Users and Groups.
  779. If installed successfully, the PostgreSQL server will run in the background each time
  780. the system as started as a Windows service. When finished, the installer should launch
  781. the Application Stack Builder (ASB) -- use this to install PostGIS, see instructions
  782. below for more details. A 'PostgreSQL 8.3' start menu group should be created that
  783. contains shortcuts for the ASB and 'Command Prompt', which launches a terminal window
  784. in the PostgreSQL directory.
  785. __ http://www.enterprisedb.com/products/pgdownload.do#windows
  786. PostGIS
  787. ^^^^^^^
  788. From the Application Stack Builder (Programs -> PostgreSQL 8.3), select
  789. 'PostgreSQL Database Server 8.3 on port 5432' from the drop down menu. Next,
  790. select 'PostGIS 1.3.6 for PostgreSQL 8.3' from the 'Spatial Extensions' tree
  791. in the list. Select only the default options during install (do not uncheck
  792. the option to create a default PostGIS database).
  793. .. note::
  794. You will be prompted to enter your 'postgres superuser' password in the
  795. 'Database Connection Information' dialog.
  796. psycopg2
  797. ^^^^^^^^
  798. The ``psycopg2`` Python module provides the interface between Python and the
  799. PostgreSQL database. Download the `Windows installer`__ (v2.0.10) and run
  800. using the default settings. [#]_
  801. __ http://www.stickpeople.com/projects/python/win-psycopg/psycopg2-2.0.10.win32-py2.6-pg8.3.7-release.exe
  802. GeoDjango Installer
  803. ^^^^^^^^^^^^^^^^^^^
  804. Download the `GeoDjango Installer`__; this was created [#]_ to simplify the rest
  805. of the process for installing GeoDjango on Windows platforms. The installer
  806. automatically installs Django 1.1, GDAL 1.6.0, PROJ 4.6.1 (including datum grid
  807. files), and configures the necessary environment variables.
  808. Once the installer has completed, log out and log back in so that the
  809. modifications to the system environment variables take effect, and you
  810. should be good to go.
  811. .. note::
  812. The installer modifies the system ``Path`` environment variable to
  813. include ``C:\Program Files\PostgreSQL\8.3\bin`` and
  814. ``C:\Program Files\GeoDjango\bin``. This is required so that Python
  815. may find the GEOS DLL provided by PostGIS and the GDAL DLL provided
  816. by the installer. The installer also sets the ``GDAL_DATA`` and
  817. ``PROJ_LIB`` environment variables.
  818. __ http://geodjango.org/windows/GeoDjango_Installer.exe
  819. .. rubric:: Footnotes
  820. .. [#] The datum shifting files are needed for converting data to and from certain projections.
  821. For example, the PROJ.4 string for the `Google projection (900913) <http://spatialreference.org/ref/epsg/900913/proj4>`_
  822. requires the ``null`` grid file only included in the extra datum shifting files.
  823. It is easier to install the shifting files now, then to have debug a problem caused by their absence later.
  824. .. [#] Specifically, GeoDjango provides support for the `OGR <http://gdal.org/ogr>`_ library, a component of GDAL.
  825. .. [#] See `GDAL ticket #2382 <http://trac.osgeo.org/gdal/ticket/2382>`_.
  826. .. [#] GeoDjango uses the `find_library <http://docs.python.org/library/ctypes.html#finding-shared-libraries>`_
  827. routine from ``ctypes.util`` to locate shared libraries.
  828. .. [#] The ``psycopg2`` Windows installers are packaged and maintained by
  829. `Jason Erickson <http://www.stickpeople.com/projects/python/win-psycopg/>`_.
  830. .. [#] The source code for the installer is available in the `nsis_installer <http://geodjango.org/hg/nsis_installer/>`_
  831. GeoDjango mercurial repository.