{"author":"Frank Warmerdam, Howard Butler, Even Rouault","author_email":"warmerdam@pobox.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","Intended Audience :: Science/Research","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: C","Programming Language :: C++","Programming Language :: Python :: 3","Topic :: Scientific/Engineering :: GIS","Topic :: Scientific/Engineering :: Information Analysis"],"description":"\nGDAL/OGR in Python\n==================\n\nThis Python package and extensions are a number of tools for programming and\nmanipulating the GDAL_ Geospatial Data Abstraction Library.\nGenerally speaking the classes and methods mostly\nmatch those of the GDAL and OGR C++ classes. There is no Python specific\nreference documentation, but the https://gdal.org/api/python_bindings.html#tutorials includes Python examples.\n\nThe GDAL Python package is built using `SWIG `__.\nThe GDAL project maintains these Python bindings for GDAL/OGR within\nthe gdal source tree.\nThe SWIG-generated files are not checked in and are not part of the\ngdal release tarballs. The bindings are also made available via PyPi\nwhere the swig-generated files are provided.\n\nBuilding from source\n--------------------\n\nTo build from source, there are multiple possible paths.\n\nDependencies\n~~~~~~~~~~~~\n\n(As usual, when a package is listed one needs the parts used to build\nprograms against it, called -devel on many systems. This is not\nspecial about gdal.)\n\n * SWIG (4 or greater).\n\n * libgdal (3.11.0 or greater).\n\n * numpy (1.0.0 or greater). This is not force-required by the build,\n but many examples and utilities will not work without it. At least\n osgeo.gdal_array requires numpy at build time; building without\n numpy and installing it later does not result in correct operation.\n apparently not and in any case it is an unwarranted leap.\n\n * setuptools (python)\n\n * wheel (python)\n\nBuilding when building the rest of GDAL\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPython bindings are generated by default when building GDAL from source.\nFor more detail, see `Python bindings options `__\n\nBuilding just the bindings, from the full tree\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAnother is to use the gdal source distribution with an\nalready-installed gdal library and headers. To do this, one must\ncreate a build directory and run cmake to generate build scripts. Then,\nrun ``cmake --build . --target python_generated_files``. Finally, in swig/python,\none can build using setup.py like any other distributed python module.\n\nBuilding from the PyPi module file\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe third is to obtain the PyPi-hosted module file, within which swig\nhas been run; this saves running cmake and generating bindings. See\nHOWTO-RELEASE for how this is created. Because swig has been run, it\nneed not be installed.\n\n\nInstallation via packging systems\n---------------------------------\n\nGeneral\n~~~~~~~\n\nMany packaging systems (on GNU/Linux, various BSDs) provide the\nbindings as a package. Specific instruction are given in cases when\nthat hint might not be sufficient.\n\npip\n~~~\n\nDue to the complex nature of GDAL and its components, different bindings may require additional packages and installation steps.\nGDAL can be installed from the `Python Package Index `__:\n\n::\n\n pip install gdal\n\n\nIn order to enable numpy-based raster support, libgdal and its development headers must be installed as well as the Python packages numpy, setuptools, and wheel.\nTo install the Python dependencies and build numpy-based raster support:\n\n\n::\n\n pip install numpy>1.0.0 wheel setuptools>=67\n pip install gdal[numpy]==\"$(gdal-config --version).*\"\n\n\nUsers can verify that numpy-based raster support has been installed with:\n\n::\n\n python3 -c 'from osgeo import gdal_array'\n\n\nIf this command raises an ImportError, numpy-based raster support has not been properly installed:\n\n::\n\n Traceback (most recent call last):\n File \"\", line 1, in \n File \"/usr/local/lib/python3.12/dist-packages/osgeo/gdal_array.py\", line 10, in \n from . import _gdal_array\n ImportError: cannot import name '_gdal_array' from 'osgeo' (/usr/local/lib/python3.12/dist-packages/osgeo/__init__.py)\n\n\nThis is most often due to pip reusing a cached GDAL installation.\nVerify that the necessary dependencies have been installed and then run the following to force a clean build:\n\n::\n\n pip install --no-cache --force-reinstall gdal[numpy]==\"$(gdal-config --version).*\"\n\n\nPotential issues with GDAL >= 3.9, Python >= 3.9 and NumPy 2.0 (pip)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe pyproject.toml file of GDAL 3.9 requires numpy >= 2.0.0rc1 (for Python >= 3.9)\nat build time to be able to build bindings that are compatible of both NumPy 1\nand NumPy 2.\nIf for some reason the numpy >= 2.0.0rc1 build dependency can not be installed,\nit is possible to manually install the build requirements, and invoke ``pip install``\nwith the ``--no-build-isolation`` flag.\n\n::\n\n pip install numpy== wheel setuptools>=67\n pip install gdal[numpy]==\"$(gdal-config --version).*\" --no-build-isolation\n\n\nConda\n~~~~~\n\nGDAL can be quite complex to build and install, particularly on Windows and MacOS.\nPre built binaries are provided for the conda system:\n\nhttps://docs.conda.io/en/latest/\n\nBy the conda-forge project:\n\nhttps://conda-forge.org/\n\nOnce you have Anaconda or Miniconda installed, you should be able to install GDAL with:\n\n``conda install -c conda-forge gdal``\n\n\n\nUsage\n-----\n\nImports\n~~~~~~~\n\nThere are five major modules that are included with the GDAL_ Python bindings.::\n\n >>> from osgeo import gdal\n >>> from osgeo import ogr\n >>> from osgeo import osr\n >>> from osgeo import gdal_array\n >>> from osgeo import gdalconst\n\nAPI\n~~~\n\nAPI documentation is available at https://gdal.org/api/python/osgeo.html\n\nNumpy\n-----\n\nOne advanced feature of the GDAL Python bindings not found in the other\nlanguage bindings is integration with the Python numerical array\nfacilities. The gdal.Dataset.ReadAsArray() method can be used to read raster\ndata as numerical arrays, ready to use with the Python numerical array\ncapabilities.\n\nTutorials\n---------\n\nSee https://gdal.org/api/python_bindings.html#tutorials\n\nGotchas\n-------\n\nAlthough GDAL's and OGR's Python bindings provide a fairly \"Pythonic\" wrapper around the underlying C++ code, there are several ways in which the Python bindings differ from typical Python libraries.\nThese differences can catch Python programmers by surprise and lead to unexpected results. These differences result from the complexity of developing a large, long-lived library while continuing to maintain\nbackward compatibility. They are being addressed over time, but until they are all gone, please review this list of https://gdal.org/api/python_gotchas.html\n\nExamples\n--------\n\n* An assortment of other samples are available in the `Python github samples directory `__\n with some description in the https://gdal.org/api/python_bindings.html#examples.\n* Several `GDAL utilities `__\n are implemented in Python and can be useful examples.\n* The majority of GDAL regression tests are written in Python. They are available at\n `https://github.com/OSGeo/gdal/tree/master/autotest `__\n\nOne example of GDAL/numpy integration is found in the `val_repl.py `__ script.\n\n.. note::\n **Performance Notes**\n\n ReadAsArray expects to make an entire copy of a raster band or dataset\n unless the data are explicitly subsetted as part of the function call. For\n large data, this approach is expected to be prohibitively memory intensive.\n\n\n.. _GDAL: https://gdal.org\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"http://www.gdal.org","keywords":"gis, raster, vector","license":"MIT","license_expression":null,"license_files":null,"maintainer":"GDAL contributors","maintainer_email":"GDAL contributors ","name":"GDAL","package_url":"https://pypi.org/project/GDAL/","platform":null,"project_url":"https://pypi.org/project/GDAL/","project_urls":{"Changelog":"https://github.com/OSGeo/gdal/blob/master/NEWS.md","Documentation":"https://gdal.org","Homepage":"https://gdal.org","Issues":"https://github.com/OSGeo/gdal/issues","Repository":"https://github.com/OSGeo/GDAL.git"},"provides_extra":null,"release_url":"https://pypi.org/project/GDAL/3.11.0/","requires_dist":["numpy>1.0.0; extra == \"numpy\""],"requires_python":">=3.8.0","summary":"GDAL: Geospatial Data Abstraction Library","version":"3.11.0","yanked":false,"yanked_reason":null}

Package search

GDAL

Release table

project_urls

Dependencies

All package metadata

Releases