{"title":"Installing Geospatial libraries","version":"2.2","locale":"en","docname":"ref/contrib/gis/install/geolibs","url":"/en/2.2/ref/contrib/gis/install/geolibs/","canonical":"https://djangodocs.dev/en/2.2/ref/contrib/gis/install/geolibs/","summary":"GeoDjango uses and/or provides interfaces for the following open source geospatial libraries: Program Description Required Supported Versions GEOS Geometry Engine…","html":"

Installing Geospatial librariesLink to this heading#

\n

GeoDjango uses and/or provides interfaces for the following open source\ngeospatial libraries:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Program

Description

Required

Supported Versions

GEOS

Geometry Engine Open Source

Yes

3.7, 3.6, 3.5, 3.4

PROJ.4

Cartographic Projections library

Yes (PostgreSQL and SQLite only)

5.2, 5.1, 5.0, 4.x

GDAL

Geospatial Data Abstraction Library

Yes

2.3, 2.2, 2.1, 2.0, 1.11

GeoIP

IP-based geolocation library

No

2

PostGIS

Spatial extensions for PostgreSQL

Yes (PostgreSQL only)

2.5, 2.4, 2.3, 2.2, 2.1

SpatiaLite

Spatial extensions for SQLite

Yes (SQLite only)

4.3, 4.2, 4.1

\n
\n

Note that older or more recent versions of these libraries may also work\ntotally fine with GeoDjango. Your mileage may vary.

\n\n

On Debian/Ubuntu, you are advised to install the following packages which will\ninstall, directly or by dependency, the required geospatial libraries:

\n
Shell
$ sudo apt-get install binutils libproj-dev gdal-bin\n
\n

Please also consult platform-specific instructions if you are on macOS\nor Windows.

\n
\n

Building from sourceLink to this heading#

\n

When installing from source on UNIX and GNU/Linux systems, please follow\nthe installation instructions carefully, and install the libraries in the\ngiven order. If using MySQL or Oracle as the spatial database, only GEOS\nis required.

\n\n\n
\n

GEOSLink to this heading#

\n

GEOS is a C++ library for performing geometric operations, and is the default\ninternal geometry representation used by GeoDjango (it’s behind the “lazy”\ngeometries). Specifically, the C API library is called (e.g., libgeos_c.so)\ndirectly from Python using ctypes.

\n

First, download GEOS from the GEOS website and untar the source archive:

\n
Code
$ wget https://download.osgeo.org/geos/geos-X.Y.Z.tar.bz2\n$ tar xjf geos-X.Y.Z.tar.bz2\n
\n

Next, change into the directory where GEOS was unpacked, run the configure\nscript, compile, and install:

\n
Code
$ cd geos-X.Y.Z\n$ ./configure\n$ make\n$ sudo make install\n$ cd ..\n
\n
\n

TroubleshootingLink to this heading#

\n
\n
Can’t find GEOS libraryLink to this heading#
\n

When GeoDjango can’t find GEOS, this error is raised:

\n
Text
ImportError: Could not find the GEOS library (tried "geos_c"). Try setting GEOS_LIBRARY_PATH in your settings.\n
\n

The most common solution is to properly configure your Library environment settings or set\nGEOS_LIBRARY_PATH in your settings.

\n

If using a binary package of GEOS (e.g., on Ubuntu), you may need to Install binutils.

\n
\n
\n
GEOS_LIBRARY_PATHLink to this heading#
\n

If your GEOS library is in a non-standard location, or you don’t want to\nmodify the system’s library path then the GEOS_LIBRARY_PATH\nsetting may be added to your Django settings file with the full path to the\nGEOS C library. For example:

\n
Code
GEOS_LIBRARY_PATH = '/home/bob/local/lib/libgeos_c.so'\n
\n\n

See also My logs are filled with GEOS-related errors.

\n
\n
\n
\n
\n

PROJ.4Link to this heading#

\n

PROJ.4 is a library for converting geospatial data to different coordinate\nreference systems.

\n

First, download the PROJ.4 source code and datum shifting files [1]:

\n
Code
$ wget https://download.osgeo.org/proj/proj-X.Y.Z.tar.gz\n$ wget https://download.osgeo.org/proj/proj-datumgrid-X.Y.tar.gz\n
\n

Next, untar the source code archive, and extract the datum shifting files in the\nnad subdirectory. This must be done prior to configuration:

\n
Code
$ tar xzf proj-X.Y.Z.tar.gz\n$ cd proj-X.Y.Z/nad\n$ tar xzf ../../proj-datumgrid-X.Y.tar.gz\n$ cd ..\n
\n

Finally, configure, make and install PROJ.4:

\n
Code
$ ./configure\n$ make\n$ sudo make install\n$ cd ..\n
\n
\n
\n

GDALLink to this heading#

\n

GDAL is an excellent open source geospatial library that has support for\nreading most vector and raster spatial data formats. Currently, GeoDjango only\nsupports GDAL’s vector data capabilities [2].\nGEOS and PROJ.4 should be installed prior to building GDAL.

\n

First download the latest GDAL release version and untar the archive:

\n
Code
$ wget https://download.osgeo.org/gdal/X.Y.Z/gdal-X.Y.Z.tar.gz\n$ tar xzf gdal-X.Y.Z.tar.gz\n$ cd gdal-X.Y.Z\n
\n

Configure, make and install:

\n
Code
$ ./configure\n$ make # Go get some coffee, this takes a while.\n$ sudo make install\n$ cd ..\n
\n\n

If you have any problems, please see the troubleshooting section below for\nsuggestions and solutions.

\n
\n

TroubleshootingLink to this heading#

\n
\n
Can’t find GDAL libraryLink to this heading#
\n

When GeoDjango can’t find the GDAL library, configure your Library environment settings\nor set GDAL_LIBRARY_PATH in your settings.

\n
\n
\n
GDAL_LIBRARY_PATHLink to this heading#
\n

If your GDAL library is in a non-standard location, or you don’t want to\nmodify the system’s library path then the GDAL_LIBRARY_PATH\nsetting may be added to your Django settings file with the full path to\nthe GDAL library. For example:

\n
Code
GDAL_LIBRARY_PATH = '/home/sue/local/lib/libgdal.so'\n
\n

Footnotes

\n\n
\n
\n
\n
","rootId":"installing-geospatial-libraries","toc":[{"title":"Building from source","anchor":"building-from-source","children":[{"title":"GEOS","anchor":"geos","children":[{"title":"Troubleshooting","anchor":"troubleshooting","children":[{"title":"Can’t find GEOS library","anchor":"can-t-find-geos-library","children":[]},{"title":"GEOS_LIBRARY_PATH","anchor":"geos-library-path","children":[]}]}]},{"title":"PROJ.4","anchor":"proj4","children":[]},{"title":"GDAL","anchor":"gdal","children":[{"title":"Troubleshooting","anchor":"gdaltrouble","children":[{"title":"Can’t find GDAL library","anchor":"can-t-find-gdal-library","children":[]},{"title":"GDAL_LIBRARY_PATH","anchor":"gdal-library-path","children":[]}]}]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/en/2.2/ref/"},{"docname":"ref/contrib/index","title":"contrib packages","url":"/en/2.2/ref/contrib/"},{"docname":"ref/contrib/gis/index","title":"GeoDjango","url":"/en/2.2/ref/contrib/gis/"},{"docname":"ref/contrib/gis/install/index","title":"GeoDjango Installation","url":"/en/2.2/ref/contrib/gis/install/"}],"prev":{"docname":"ref/contrib/gis/install/index","title":"GeoDjango Installation","url":"/en/2.2/ref/contrib/gis/install/"},"next":{"docname":"ref/contrib/gis/install/postgis","title":"Installing PostGIS","url":"/en/2.2/ref/contrib/gis/install/postgis/"},"formats":{"html":"/en/2.2/ref/contrib/gis/install/geolibs/","markdown":"/en/2.2/ref/contrib/gis/install/geolibs.md","json":"/en/2.2/ref/contrib/gis/install/geolibs.json"},"source":"https://github.com/django/django/blob/stable/2.2.x/docs/ref/contrib/gis/install/geolibs.txt","official":"https://docs.djangoproject.com/en/2.2/ref/contrib/gis/install/geolibs/","inVersions":["dev","6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9","1.8"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}