tutorial.txt 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782
  1. ==================
  2. GeoDjango Tutorial
  3. ==================
  4. Introduction
  5. ============
  6. GeoDjango is an included contrib module for Django that turns it into a
  7. world-class geographic Web framework. GeoDjango strives to make it as simple
  8. as possible to create geographic Web applications, like location-based services.
  9. Its features include:
  10. * Django model fields for `OGC`_ geometries and raster data.
  11. * Extensions to Django's ORM for querying and manipulating spatial data.
  12. * Loosely-coupled, high-level Python interfaces for GIS geometry and raster
  13. operations and data manipulation in different formats.
  14. * Editing geometry fields from the admin.
  15. This tutorial assumes familiarity with Django; thus, if you're brand new to
  16. Django, please read through the :doc:`regular tutorial </intro/tutorial01>` to
  17. familiarize yourself with Django first.
  18. .. note::
  19. GeoDjango has additional requirements beyond what Django requires --
  20. please consult the :doc:`installation documentation <install/index>`
  21. for more details.
  22. This tutorial will guide you through the creation of a geographic web
  23. application for viewing the `world borders`_. [#]_ Some of the code
  24. used in this tutorial is taken from and/or inspired by the `GeoDjango
  25. basic apps`_ project. [#]_
  26. .. note::
  27. Proceed through the tutorial sections sequentially for step-by-step
  28. instructions.
  29. .. _OGC: http://www.opengeospatial.org/
  30. .. _world borders: http://thematicmapping.org/downloads/world_borders.php
  31. .. _GeoDjango basic apps: https://code.google.com/p/geodjango-basic-apps/
  32. Setting Up
  33. ==========
  34. Create a Spatial Database
  35. -------------------------
  36. Typically no special setup is required, so you can create a database as you
  37. would for any other project. We provide some tips for selected databases:
  38. * :doc:`install/postgis`
  39. * :doc:`install/spatialite`
  40. Create a New Project
  41. --------------------
  42. Use the standard ``django-admin`` script to create a project called
  43. ``geodjango``:
  44. .. code-block:: console
  45. $ django-admin startproject geodjango
  46. This will initialize a new project. Now, create a ``world`` Django application
  47. within the ``geodjango`` project:
  48. .. code-block:: console
  49. $ cd geodjango
  50. $ python manage.py startapp world
  51. Configure ``settings.py``
  52. -------------------------
  53. The ``geodjango`` project settings are stored in the ``geodjango/settings.py``
  54. file. Edit the database connection settings to match your setup::
  55. DATABASES = {
  56. 'default': {
  57. 'ENGINE': 'django.contrib.gis.db.backends.postgis',
  58. 'NAME': 'geodjango',
  59. 'USER': 'geo',
  60. },
  61. }
  62. In addition, modify the :setting:`INSTALLED_APPS` setting to include
  63. :mod:`django.contrib.admin`, :mod:`django.contrib.gis`,
  64. and ``world`` (your newly created application)::
  65. INSTALLED_APPS = [
  66. 'django.contrib.admin',
  67. 'django.contrib.auth',
  68. 'django.contrib.contenttypes',
  69. 'django.contrib.sessions',
  70. 'django.contrib.messages',
  71. 'django.contrib.staticfiles',
  72. 'django.contrib.gis',
  73. 'world',
  74. ]
  75. Geographic Data
  76. ===============
  77. .. _worldborders:
  78. World Borders
  79. -------------
  80. The world borders data is available in this `zip file`__. Create a ``data``
  81. directory in the ``world`` application, download the world borders data, and
  82. unzip. On GNU/Linux platforms, use the following commands:
  83. .. code-block:: console
  84. $ mkdir world/data
  85. $ cd world/data
  86. $ wget http://thematicmapping.org/downloads/TM_WORLD_BORDERS-0.3.zip
  87. $ unzip TM_WORLD_BORDERS-0.3.zip
  88. $ cd ../..
  89. The world borders ZIP file contains a set of data files collectively known as
  90. an `ESRI Shapefile`__, one of the most popular geospatial data formats. When
  91. unzipped, the world borders dataset includes files with the following
  92. extensions:
  93. * ``.shp``: Holds the vector data for the world borders geometries.
  94. * ``.shx``: Spatial index file for geometries stored in the ``.shp``.
  95. * ``.dbf``: Database file for holding non-geometric attribute data
  96. (e.g., integer and character fields).
  97. * ``.prj``: Contains the spatial reference information for the geographic
  98. data stored in the shapefile.
  99. __ http://thematicmapping.org/downloads/TM_WORLD_BORDERS-0.3.zip
  100. __ https://en.wikipedia.org/wiki/Shapefile
  101. Use ``ogrinfo`` to examine spatial data
  102. ---------------------------------------
  103. The GDAL ``ogrinfo`` utility allows examining the metadata of shapefiles or
  104. other vector data sources:
  105. .. code-block:: console
  106. $ ogrinfo world/data/TM_WORLD_BORDERS-0.3.shp
  107. INFO: Open of `world/data/TM_WORLD_BORDERS-0.3.shp'
  108. using driver `ESRI Shapefile' successful.
  109. 1: TM_WORLD_BORDERS-0.3 (Polygon)
  110. ``ogrinfo`` tells us that the shapefile has one layer, and that this
  111. layer contains polygon data. To find out more, we'll specify the layer name
  112. and use the ``-so`` option to get only the important summary information:
  113. .. code-block:: console
  114. $ ogrinfo -so world/data/TM_WORLD_BORDERS-0.3.shp TM_WORLD_BORDERS-0.3
  115. INFO: Open of `world/data/TM_WORLD_BORDERS-0.3.shp'
  116. using driver `ESRI Shapefile' successful.
  117. Layer name: TM_WORLD_BORDERS-0.3
  118. Geometry: Polygon
  119. Feature Count: 246
  120. Extent: (-180.000000, -90.000000) - (180.000000, 83.623596)
  121. Layer SRS WKT:
  122. GEOGCS["GCS_WGS_1984",
  123. DATUM["WGS_1984",
  124. SPHEROID["WGS_1984",6378137.0,298.257223563]],
  125. PRIMEM["Greenwich",0.0],
  126. UNIT["Degree",0.0174532925199433]]
  127. FIPS: String (2.0)
  128. ISO2: String (2.0)
  129. ISO3: String (3.0)
  130. UN: Integer (3.0)
  131. NAME: String (50.0)
  132. AREA: Integer (7.0)
  133. POP2005: Integer (10.0)
  134. REGION: Integer (3.0)
  135. SUBREGION: Integer (3.0)
  136. LON: Real (8.3)
  137. LAT: Real (7.3)
  138. This detailed summary information tells us the number of features in the layer
  139. (246), the geographic bounds of the data, the spatial reference system
  140. ("SRS WKT"), as well as type information for each attribute field. For example,
  141. ``FIPS: String (2.0)`` indicates that the ``FIPS`` character field has
  142. a maximum length of 2. Similarly, ``LON: Real (8.3)`` is a floating-point
  143. field that holds a maximum of 8 digits up to three decimal places.
  144. Geographic Models
  145. =================
  146. Defining a Geographic Model
  147. ---------------------------
  148. Now that you've examined your dataset using ``ogrinfo``, create a GeoDjango
  149. model to represent this data::
  150. from django.contrib.gis.db import models
  151. class WorldBorder(models.Model):
  152. # Regular Django fields corresponding to the attributes in the
  153. # world borders shapefile.
  154. name = models.CharField(max_length=50)
  155. area = models.IntegerField()
  156. pop2005 = models.IntegerField('Population 2005')
  157. fips = models.CharField('FIPS Code', max_length=2)
  158. iso2 = models.CharField('2 Digit ISO', max_length=2)
  159. iso3 = models.CharField('3 Digit ISO', max_length=3)
  160. un = models.IntegerField('United Nations Code')
  161. region = models.IntegerField('Region Code')
  162. subregion = models.IntegerField('Sub-Region Code')
  163. lon = models.FloatField()
  164. lat = models.FloatField()
  165. # GeoDjango-specific: a geometry field (MultiPolygonField)
  166. mpoly = models.MultiPolygonField()
  167. # Returns the string representation of the model.
  168. def __str__(self):
  169. return self.name
  170. Note that the ``models`` module is imported from ``django.contrib.gis.db``.
  171. The default spatial reference system for geometry fields is WGS84 (meaning
  172. the `SRID`__ is 4326) -- in other words, the field coordinates are in
  173. longitude, latitude pairs in units of degrees. To use a different
  174. coordinate system, set the SRID of the geometry field with the ``srid``
  175. argument. Use an integer representing the coordinate system's EPSG code.
  176. __ https://en.wikipedia.org/wiki/SRID
  177. Run ``migrate``
  178. ---------------
  179. After defining your model, you need to sync it with the database. First,
  180. create a database migration:
  181. .. code-block:: console
  182. $ python manage.py makemigrations
  183. Migrations for 'world':
  184. world/migrations/0001_initial.py:
  185. - Create model WorldBorder
  186. Let's look at the SQL that will generate the table for the ``WorldBorder``
  187. model:
  188. .. code-block:: console
  189. $ python manage.py sqlmigrate world 0001
  190. This command should produce the following output:
  191. .. code-block:: sql
  192. BEGIN;
  193. --
  194. -- Create model WorldBorder
  195. --
  196. CREATE TABLE "world_worldborder" (
  197. "id" serial NOT NULL PRIMARY KEY,
  198. "name" varchar(50) NOT NULL,
  199. "area" integer NOT NULL,
  200. "pop2005" integer NOT NULL,
  201. "fips" varchar(2) NOT NULL,
  202. "iso2" varchar(2) NOT NULL,
  203. "iso3" varchar(3) NOT NULL,
  204. "un" integer NOT NULL,
  205. "region" integer NOT NULL,
  206. "subregion" integer NOT NULL,
  207. "lon" double precision NOT NULL,
  208. "lat" double precision NOT NULL
  209. "mpoly" geometry(MULTIPOLYGON,4326) NOT NULL
  210. )
  211. ;
  212. CREATE INDEX "world_worldborder_mpoly_id" ON "world_worldborder" USING GIST ( "mpoly" );
  213. COMMIT;
  214. If this looks correct, run :djadmin:`migrate` to create this table in the
  215. database:
  216. .. code-block:: console
  217. $ python manage.py migrate
  218. Operations to perform:
  219. Apply all migrations: admin, auth, contenttypes, sessions, world
  220. Running migrations:
  221. ...
  222. Applying world.0001_initial... OK
  223. Importing Spatial Data
  224. ======================
  225. This section will show you how to import the world borders shapefile into the
  226. database via GeoDjango models using the :doc:`layermapping`.
  227. There are many different ways to import data into a spatial database --
  228. besides the tools included within GeoDjango, you may also use the following:
  229. * `ogr2ogr`_: A command-line utility included with GDAL that
  230. can import many vector data formats into PostGIS, MySQL, and Oracle databases.
  231. * `shp2pgsql`_: This utility included with PostGIS imports ESRI shapefiles into
  232. PostGIS.
  233. .. _ogr2ogr: http://www.gdal.org/ogr2ogr.html
  234. .. _shp2pgsql: https://postgis.net/docs/using_postgis_dbmanagement.html#shp2pgsql_usage
  235. .. _gdalinterface:
  236. GDAL Interface
  237. --------------
  238. Earlier, you used ``ogrinfo`` to examine the contents of the world borders
  239. shapefile. GeoDjango also includes a Pythonic interface to GDAL's powerful OGR
  240. library that can work with all the vector data sources that OGR supports.
  241. First, invoke the Django shell:
  242. .. code-block:: console
  243. $ python manage.py shell
  244. If you downloaded the :ref:`worldborders` data earlier in the
  245. tutorial, then you can determine its path using Python's built-in
  246. ``os`` module::
  247. >>> import os
  248. >>> import world
  249. >>> world_shp = os.path.abspath(os.path.join(os.path.dirname(world.__file__),
  250. ... 'data', 'TM_WORLD_BORDERS-0.3.shp'))
  251. Now, open the world borders shapefile using GeoDjango's
  252. :class:`~django.contrib.gis.gdal.DataSource` interface::
  253. >>> from django.contrib.gis.gdal import DataSource
  254. >>> ds = DataSource(world_shp)
  255. >>> print(ds)
  256. / ... /geodjango/world/data/TM_WORLD_BORDERS-0.3.shp (ESRI Shapefile)
  257. Data source objects can have different layers of geospatial features; however,
  258. shapefiles are only allowed to have one layer::
  259. >>> print(len(ds))
  260. 1
  261. >>> lyr = ds[0]
  262. >>> print(lyr)
  263. TM_WORLD_BORDERS-0.3
  264. You can see the layer's geometry type and how many features it contains::
  265. >>> print(lyr.geom_type)
  266. Polygon
  267. >>> print(len(lyr))
  268. 246
  269. .. note::
  270. Unfortunately, the shapefile data format does not allow for greater
  271. specificity with regards to geometry types. This shapefile, like
  272. many others, actually includes ``MultiPolygon`` geometries, not Polygons.
  273. It's important to use a more general field type in models: a
  274. GeoDjango ``MultiPolygonField`` will accept a ``Polygon`` geometry, but a
  275. ``PolygonField`` will not accept a ``MultiPolygon`` type geometry. This
  276. is why the ``WorldBorder`` model defined above uses a ``MultiPolygonField``.
  277. The :class:`~django.contrib.gis.gdal.Layer` may also have a spatial reference
  278. system associated with it. If it does, the ``srs`` attribute will return a
  279. :class:`~django.contrib.gis.gdal.SpatialReference` object::
  280. >>> srs = lyr.srs
  281. >>> print(srs)
  282. GEOGCS["GCS_WGS_1984",
  283. DATUM["WGS_1984",
  284. SPHEROID["WGS_1984",6378137.0,298.257223563]],
  285. PRIMEM["Greenwich",0.0],
  286. UNIT["Degree",0.0174532925199433]]
  287. >>> srs.proj4 # PROJ.4 representation
  288. '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs '
  289. This shapefile is in the popular WGS84 spatial reference
  290. system -- in other words, the data uses longitude, latitude pairs in
  291. units of degrees.
  292. In addition, shapefiles also support attribute fields that may contain
  293. additional data. Here are the fields on the World Borders layer:
  294. >>> print(lyr.fields)
  295. ['FIPS', 'ISO2', 'ISO3', 'UN', 'NAME', 'AREA', 'POP2005', 'REGION', 'SUBREGION', 'LON', 'LAT']
  296. The following code will let you examine the OGR types (e.g. integer or
  297. string) associated with each of the fields:
  298. >>> [fld.__name__ for fld in lyr.field_types]
  299. ['OFTString', 'OFTString', 'OFTString', 'OFTInteger', 'OFTString', 'OFTInteger', 'OFTInteger', 'OFTInteger', 'OFTInteger', 'OFTReal', 'OFTReal']
  300. You can iterate over each feature in the layer and extract information from both
  301. the feature's geometry (accessed via the ``geom`` attribute) as well as the
  302. feature's attribute fields (whose **values** are accessed via ``get()``
  303. method)::
  304. >>> for feat in lyr:
  305. ... print(feat.get('NAME'), feat.geom.num_points)
  306. ...
  307. Guernsey 18
  308. Jersey 26
  309. South Georgia South Sandwich Islands 338
  310. Taiwan 363
  311. :class:`~django.contrib.gis.gdal.Layer` objects may be sliced::
  312. >>> lyr[0:2]
  313. [<django.contrib.gis.gdal.feature.Feature object at 0x2f47690>, <django.contrib.gis.gdal.feature.Feature object at 0x2f47650>]
  314. And individual features may be retrieved by their feature ID::
  315. >>> feat = lyr[234]
  316. >>> print(feat.get('NAME'))
  317. San Marino
  318. Boundary geometries may be exported as WKT and GeoJSON::
  319. >>> geom = feat.geom
  320. >>> print(geom.wkt)
  321. POLYGON ((12.415798 43.957954,12.450554 ...
  322. >>> print(geom.json)
  323. { "type": "Polygon", "coordinates": [ [ [ 12.415798, 43.957954 ], [ 12.450554, 43.979721 ], ...
  324. ``LayerMapping``
  325. ----------------
  326. To import the data, use a LayerMapping in a Python script.
  327. Create a file called ``load.py`` inside the ``world`` application,
  328. with the following code::
  329. import os
  330. from django.contrib.gis.utils import LayerMapping
  331. from .models import WorldBorder
  332. world_mapping = {
  333. 'fips' : 'FIPS',
  334. 'iso2' : 'ISO2',
  335. 'iso3' : 'ISO3',
  336. 'un' : 'UN',
  337. 'name' : 'NAME',
  338. 'area' : 'AREA',
  339. 'pop2005' : 'POP2005',
  340. 'region' : 'REGION',
  341. 'subregion' : 'SUBREGION',
  342. 'lon' : 'LON',
  343. 'lat' : 'LAT',
  344. 'mpoly' : 'MULTIPOLYGON',
  345. }
  346. world_shp = os.path.abspath(
  347. os.path.join(os.path.dirname(__file__), 'data', 'TM_WORLD_BORDERS-0.3.shp'),
  348. )
  349. def run(verbose=True):
  350. lm = LayerMapping(
  351. WorldBorder, world_shp, world_mapping,
  352. transform=False, encoding='iso-8859-1',
  353. )
  354. lm.save(strict=True, verbose=verbose)
  355. A few notes about what's going on:
  356. * Each key in the ``world_mapping`` dictionary corresponds to a field in the
  357. ``WorldBorder`` model. The value is the name of the shapefile field
  358. that data will be loaded from.
  359. * The key ``mpoly`` for the geometry field is ``MULTIPOLYGON``, the
  360. geometry type GeoDjango will import the field as. Even simple polygons in
  361. the shapefile will automatically be converted into collections prior to
  362. insertion into the database.
  363. * The path to the shapefile is not absolute -- in other words, if you move the
  364. ``world`` application (with ``data`` subdirectory) to a different location,
  365. the script will still work.
  366. * The ``transform`` keyword is set to ``False`` because the data in the
  367. shapefile does not need to be converted -- it's already in WGS84 (SRID=4326).
  368. * The ``encoding`` keyword is set to the character encoding of the string
  369. values in the shapefile. This ensures that string values are read and saved
  370. correctly from their original encoding system.
  371. Afterwards, invoke the Django shell from the ``geodjango`` project directory:
  372. .. code-block:: console
  373. $ python manage.py shell
  374. Next, import the ``load`` module, call the ``run`` routine, and watch
  375. ``LayerMapping`` do the work::
  376. >>> from world import load
  377. >>> load.run()
  378. .. _ogrinspect-intro:
  379. Try ``ogrinspect``
  380. ------------------
  381. Now that you've seen how to define geographic models and import data with the
  382. :doc:`layermapping`, it's possible to further automate this process with
  383. use of the :djadmin:`ogrinspect` management command. The :djadmin:`ogrinspect`
  384. command introspects a GDAL-supported vector data source (e.g., a shapefile)
  385. and generates a model definition and ``LayerMapping`` dictionary automatically.
  386. The general usage of the command goes as follows:
  387. .. code-block:: console
  388. $ python manage.py ogrinspect [options] <data_source> <model_name> [options]
  389. ``data_source`` is the path to the GDAL-supported data source and
  390. ``model_name`` is the name to use for the model. Command-line options may
  391. be used to further define how the model is generated.
  392. For example, the following command nearly reproduces the ``WorldBorder`` model
  393. and mapping dictionary created above, automatically:
  394. .. code-block:: console
  395. $ python manage.py ogrinspect world/data/TM_WORLD_BORDERS-0.3.shp WorldBorder \
  396. --srid=4326 --mapping --multi
  397. A few notes about the command-line options given above:
  398. * The ``--srid=4326`` option sets the SRID for the geographic field.
  399. * The ``--mapping`` option tells ``ogrinspect`` to also generate a
  400. mapping dictionary for use with
  401. :class:`~django.contrib.gis.utils.LayerMapping`.
  402. * The ``--multi`` option is specified so that the geographic field is a
  403. :class:`~django.contrib.gis.db.models.MultiPolygonField` instead of just a
  404. :class:`~django.contrib.gis.db.models.PolygonField`.
  405. The command produces the following output, which may be copied
  406. directly into the ``models.py`` of a GeoDjango application::
  407. # This is an auto-generated Django model module created by ogrinspect.
  408. from django.contrib.gis.db import models
  409. class WorldBorder(models.Model):
  410. fips = models.CharField(max_length=2)
  411. iso2 = models.CharField(max_length=2)
  412. iso3 = models.CharField(max_length=3)
  413. un = models.IntegerField()
  414. name = models.CharField(max_length=50)
  415. area = models.IntegerField()
  416. pop2005 = models.IntegerField()
  417. region = models.IntegerField()
  418. subregion = models.IntegerField()
  419. lon = models.FloatField()
  420. lat = models.FloatField()
  421. geom = models.MultiPolygonField(srid=4326)
  422. # Auto-generated `LayerMapping` dictionary for WorldBorder model
  423. worldborders_mapping = {
  424. 'fips' : 'FIPS',
  425. 'iso2' : 'ISO2',
  426. 'iso3' : 'ISO3',
  427. 'un' : 'UN',
  428. 'name' : 'NAME',
  429. 'area' : 'AREA',
  430. 'pop2005' : 'POP2005',
  431. 'region' : 'REGION',
  432. 'subregion' : 'SUBREGION',
  433. 'lon' : 'LON',
  434. 'lat' : 'LAT',
  435. 'geom' : 'MULTIPOLYGON',
  436. }
  437. Spatial Queries
  438. ===============
  439. Spatial Lookups
  440. ---------------
  441. GeoDjango adds spatial lookups to the Django ORM. For example, you
  442. can find the country in the ``WorldBorder`` table that contains
  443. a particular point. First, fire up the management shell:
  444. .. code-block:: console
  445. $ python manage.py shell
  446. Now, define a point of interest [#]_::
  447. >>> pnt_wkt = 'POINT(-95.3385 29.7245)'
  448. The ``pnt_wkt`` string represents the point at -95.3385 degrees longitude,
  449. 29.7245 degrees latitude. The geometry is in a format known as
  450. Well Known Text (WKT), a standard issued by the Open Geospatial
  451. Consortium (OGC). [#]_ Import the ``WorldBorder`` model, and perform
  452. a ``contains`` lookup using the ``pnt_wkt`` as the parameter::
  453. >>> from world.models import WorldBorder
  454. >>> WorldBorder.objects.filter(mpoly__contains=pnt_wkt)
  455. <QuerySet [<WorldBorder: United States>]>
  456. Here, you retrieved a ``QuerySet`` with only one model: the border of the
  457. United States (exactly what you would expect).
  458. Similarly, you may also use a :doc:`GEOS geometry object <geos>`.
  459. Here, you can combine the ``intersects`` spatial lookup with the ``get``
  460. method to retrieve only the ``WorldBorder`` instance for San Marino instead
  461. of a queryset::
  462. >>> from django.contrib.gis.geos import Point
  463. >>> pnt = Point(12.4604, 43.9420)
  464. >>> WorldBorder.objects.get(mpoly__intersects=pnt)
  465. <WorldBorder: San Marino>
  466. The ``contains`` and ``intersects`` lookups are just a subset of the
  467. available queries -- the :doc:`db-api` documentation has more.
  468. .. _automatic-spatial-transformations:
  469. Automatic Spatial Transformations
  470. ---------------------------------
  471. When doing spatial queries, GeoDjango automatically transforms
  472. geometries if they're in a different coordinate system. In the following
  473. example, coordinates will be expressed in `EPSG SRID 32140`__,
  474. a coordinate system specific to south Texas **only** and in units of
  475. **meters**, not degrees::
  476. >>> from django.contrib.gis.geos import Point, GEOSGeometry
  477. >>> pnt = Point(954158.1, 4215137.1, srid=32140)
  478. Note that ``pnt`` may also be constructed with EWKT, an "extended" form of
  479. WKT that includes the SRID::
  480. >>> pnt = GEOSGeometry('SRID=32140;POINT(954158.1 4215137.1)')
  481. GeoDjango's ORM will automatically wrap geometry values
  482. in transformation SQL, allowing the developer to work at a higher level
  483. of abstraction::
  484. >>> qs = WorldBorder.objects.filter(mpoly__intersects=pnt)
  485. >>> print(qs.query) # Generating the SQL
  486. SELECT "world_worldborder"."id", "world_worldborder"."name", "world_worldborder"."area",
  487. "world_worldborder"."pop2005", "world_worldborder"."fips", "world_worldborder"."iso2",
  488. "world_worldborder"."iso3", "world_worldborder"."un", "world_worldborder"."region",
  489. "world_worldborder"."subregion", "world_worldborder"."lon", "world_worldborder"."lat",
  490. "world_worldborder"."mpoly" FROM "world_worldborder"
  491. WHERE ST_Intersects("world_worldborder"."mpoly", ST_Transform(%s, 4326))
  492. >>> qs # printing evaluates the queryset
  493. <QuerySet [<WorldBorder: United States>]>
  494. __ http://spatialreference.org/ref/epsg/32140/
  495. .. _gis-raw-sql:
  496. .. admonition:: Raw queries
  497. When using :doc:`raw queries </topics/db/sql>`, you must wrap your geometry
  498. fields so that the field value can be recognized by GEOS::
  499. from django.db import connection
  500. # or if you're querying a non-default database:
  501. from django.db import connections
  502. connection = connections['your_gis_db_alias']
  503. City.objects.raw('SELECT id, name, %s as point from myapp_city' % (connection.ops.select % 'point'))
  504. You should only use raw queries when you know exactly what you're doing.
  505. Lazy Geometries
  506. ---------------
  507. GeoDjango loads geometries in a standardized textual representation. When the
  508. geometry field is first accessed, GeoDjango creates a
  509. :class:`~django.contrib.gis.geos.GEOSGeometry` object, exposing powerful
  510. functionality, such as serialization properties for popular geospatial
  511. formats::
  512. >>> sm = WorldBorder.objects.get(name='San Marino')
  513. >>> sm.mpoly
  514. <MultiPolygon object at 0x24c6798>
  515. >>> sm.mpoly.wkt # WKT
  516. MULTIPOLYGON (((12.4157980000000006 43.9579540000000009, 12.4505540000000003 43.9797209999999978, ...
  517. >>> sm.mpoly.wkb # WKB (as Python binary buffer)
  518. <read-only buffer for 0x1fe2c70, size -1, offset 0 at 0x2564c40>
  519. >>> sm.mpoly.geojson # GeoJSON
  520. '{ "type": "MultiPolygon", "coordinates": [ [ [ [ 12.415798, 43.957954 ], [ 12.450554, 43.979721 ], ...
  521. This includes access to all of the advanced geometric operations provided by
  522. the GEOS library::
  523. >>> pnt = Point(12.4604, 43.9420)
  524. >>> sm.mpoly.contains(pnt)
  525. True
  526. >>> pnt.contains(sm.mpoly)
  527. False
  528. Geographic annotations
  529. ----------------------
  530. GeoDjango also offers a set of geographic annotations to compute distances and
  531. several other operations (intersection, difference, etc.). See the
  532. :doc:`functions` documentation.
  533. Putting your data on the map
  534. ============================
  535. Geographic Admin
  536. ----------------
  537. GeoDjango extends :doc:`Django's admin application </ref/contrib/admin/index>`
  538. with support for editing geometry fields.
  539. Basics
  540. ~~~~~~
  541. GeoDjango also supplements the Django admin by allowing users to create
  542. and modify geometries on a JavaScript slippy map (powered by `OpenLayers`_).
  543. Let's dive right in. Create a file called ``admin.py`` inside the
  544. ``world`` application with the following code::
  545. from django.contrib.gis import admin
  546. from .models import WorldBorder
  547. admin.site.register(WorldBorder, admin.GeoModelAdmin)
  548. Next, edit your ``urls.py`` in the ``geodjango`` application folder as follows::
  549. from django.contrib.gis import admin
  550. from django.urls import path, include
  551. urlpatterns = [
  552. path('admin/', admin.site.urls),
  553. ]
  554. Create an admin user:
  555. .. code-block:: console
  556. $ python manage.py createsuperuser
  557. Next, start up the Django development server:
  558. .. code-block:: console
  559. $ python manage.py runserver
  560. Finally, browse to ``http://localhost:8000/admin/``, and log in with the user
  561. you just created. Browse to any of the ``WorldBorder`` entries -- the borders
  562. may be edited by clicking on a polygon and dragging the vertexes to the desired
  563. position.
  564. .. _OpenLayers: http://openlayers.org/
  565. .. _Open Street Map: https://www.openstreetmap.org/
  566. .. _Vector Map Level 0: http://earth-info.nga.mil/publications/vmap0.html
  567. .. _OSGeo: http://www.osgeo.org
  568. .. _osmgeoadmin-intro:
  569. ``OSMGeoAdmin``
  570. ~~~~~~~~~~~~~~~
  571. With the :class:`~django.contrib.gis.admin.OSMGeoAdmin`, GeoDjango uses
  572. a `Open Street Map`_ layer in the admin.
  573. This provides more context (including street and thoroughfare details) than
  574. available with the :class:`~django.contrib.gis.admin.GeoModelAdmin`
  575. (which uses the `Vector Map Level 0`_ WMS dataset hosted at `OSGeo`_).
  576. The PROJ.4 datum shifting files must be installed (see the :ref:`PROJ.4
  577. installation instructions <proj4>` for more details).
  578. If you meet this requirement, then just substitute the ``OSMGeoAdmin``
  579. option class in your ``admin.py`` file::
  580. admin.site.register(WorldBorder, admin.OSMGeoAdmin)
  581. .. rubric:: Footnotes
  582. .. [#] Special thanks to Bjørn Sandvik of `thematicmapping.org
  583. <http://thematicmapping.org>`_ for providing and maintaining this
  584. dataset.
  585. .. [#] GeoDjango basic apps was written by Dane Springmeyer, Josh Livni, and
  586. Christopher Schmidt.
  587. .. [#] This point is the `University of Houston Law Center
  588. <https://www.law.uh.edu/>`_.
  589. .. [#] Open Geospatial Consortium, Inc., `OpenGIS Simple Feature Specification
  590. For SQL <http://www.opengeospatial.org/standards/sfs>`_.