1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
CRS Compatibility Guide for Geospatial Python
==============================================
This is meant to be a guide to help you along the way of you use :class:`pyproj.crs.CRS`
with other Python Geospatial libraries.
.. note:: WKT2 is the best format for storing your CRS according to the
`PROJ FAQ <https://proj.org/faq.html#what-is-the-best-format-for-describing-coordinate-reference-systems>`__.
osgeo/gdal
----------
https://github.com/osgeo/gdal
Converting from `osgeo.osr.SpatialReference` to `pyproj.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
from osgeo.osr import SpatialReference
from pyproj.crs import CRS
osr_crs = SpatialReference()
osr_crs.ImportFromEPSG(4326)
if osgeo.version_info.major < 3:
proj_crs = CRS.from_wkt(osr_crs.ExportToWkt())
else:
proj_crs = CRS.from_wkt(osr_crs.ExportToWkt(["FORMAT=WKT2_2018"]))
Converting from `pyproj.crs.CRS` to `osgeo.osr.SpatialReference`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning:: WKT2 is only supported in GDAL 3+
.. code-block:: python
import osgeo
from osgeo.osr import SpatialReference
from pyproj.crs import CRS
from pyproj.enums import WktVersion
proj_crs = CRS.from_epsg(4326)
osr_crs = SpatialReference()
if osgeo.version_info.major < 3:
osr_crs.ImportFromWkt(proj_crs.to_wkt(WktVersion.WKT1_GDAL))
else:
osr_crs.ImportFromWkt(proj_crs.to_wkt())
rasterio
--------
https://github.com/mapbox/rasterio
Converting from `rasterio.crs.CRS` to `pyproj.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have `rasterio >= 1.0.14`, then you can pass in the `rasterio.crs.CRS`
directly::
import rasterio
import rasterio.crs
from pyproj.crs import CRS
with rasterio.Env(OSR_WKT_FORMAT="WKT2_2018"):
rio_crs = rasterio.crs.CRS.from_epsg(4326)
proj_crs = CRS.from_user_input(rio_crs)
Otherwise, you should use the `wkt` property::
import rasterio.crs
from pyproj.crs import CRS
with rasterio.Env(OSR_WKT_FORMAT="WKT2_2018"):
rio_crs = rasterio.crs.CRS.from_epsg(4326)
proj_crs = CRS.from_wkt(rio_crs.wkt)
Converting from `pyproj.crs.CRS` to `rasterio.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning:: WKT2 is only supported in GDAL 3+
If you have rasterio >= 1.0.26 and GDAL 3+, then you can pass in the `pyproj.crs.CRS`
directly::
import rasterio.crs
from pyproj.crs import CRS
proj_crs = CRS.from_epsg(4326)
rio_crs = rasterio.crs.CRS.from_user_input(proj_crs)
If you want to be compatible across GDAL/rasterio versions, you can do::
from packaging import version
import rasterio
import rasterio.crs
from pyproj.crs import CRS
from pyproj.enums import WktVersion
proj_crs = CRS.from_epsg(4326)
if version.parse(rasterio.__gdal_version__) < version.parse("3.0.0")
rio_crs = rasterio.crs.CRS.from_wkt(proj_crs.to_wkt(WktVersion.WKT1_GDAL))
else:
rio_crs = rasterio.crs.CRS.from_wkt(proj_crs.to_wkt())
fiona
------
https://github.com/Toblerity/Fiona
Converting from `fiona` CRS to `pyproj.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Fiona currently stores the CRS as a PROJ string dictionary in the `crs`
attribute. As such, it is best to use the `crs_wkt` attribute.
It is also useful to know that plans exist to add CRS class.
Related GitHub issue `here <https://github.com/Toblerity/Fiona/issues/714>`__.
Example::
import fiona
from pyproj.crs import CRS
with fiona.Env(OSR_WKT_FORMAT="WKT2_2018"), fiona.open(...) as fds:
proj_crs = CRS.from_wkt(fds.crs_wkt)
Converting from `pyproj.crs.CRS` for `fiona`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning:: WKT2 is only supported in GDAL 3+
If you want to be compatible across GDAL versions, you can do::
from packaging import version
import fiona
from pyproj.crs import CRS
proj_crs = CRS.from_epsg(4326)
if version.parse(fiona.__gdal_version__) < version.parse("3.0.0"):
fio_crs = proj_crs.to_wkt(WktVersion.WKT1_GDAL)
else:
# GDAL 3+ can use WKT2
fio_crs = dc_crs.to_wkt()
# with fiona.open(..., "w", crs_wkt=fio_crs) as fds:
# ...
geopandas
---------
https://github.com/geopandas/geopandas
Also see the `geopandas guide for upgrading to use pyproj CRS class <https://geopandas.readthedocs.io/en/latest/projections.html#upgrading-to-geopandas-0-7-with-pyproj-2-2-and-proj-6>`__
Preparing `pyproj.crs.CRS` for `geopandas`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
import fiona
import geopandas
from pyproj.crs import CRS
from pyproj.enums import WktVersion
proj_crs = CRS.from_epsg(4326)
if version.parse(geopandas.__version__) >= version.parse("0.7.0"):
# geopandas uses pyproj.crs.CRS
geo_crs = proj_crs
elif version.parse(geopandas.__version__) >= version.parse("0.6.0"):
# this version of geopandas uses always_xy=True so WKT version is safe
if version.parse(fiona.__gdal_version__) < version.parse("3.0.0"):
geo_crs = proj_crs.to_wkt(WktVersion.WKT1_GDAL)
else:
# GDAL 3+ can use WKT2
geo_crs = dc_crs.to_wkt()
else:
geo_crs = dc_crs.to_proj4()
`geopandas` to `pyproj.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:meth:`pyproj.crs.CRS.from_user_input` can handle anything across the `geopandas`
versions. The only gotcha would be if it is `None`.
.. code-block:: python
import geopandas
from pyproj.crs import CRS
gdf = geopandas.read_file(...)
proj_crs = CRS.from_user_input(gdf.crs)
cartopy
-------
https://github.com/SciTools/cartopy
.. note:: These examples require cartopy 0.20+
Preparing `pyproj.crs.CRS` for `cartopy.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning:: This only works for CRS created with WKT2,
PROJ JSON, or a spatial reference ID (i.e. EPSG)
with the area of use defined. Otherwise,
the x_limits and y_limits will not work.
.. code-block:: python
import cartopy.crs as ccrs
from pyproj.crs import CRS
# geographic
proj_crs = CRS.from_epsg(4326)
cart_crs = ccrs.CRS(proj_crs)
# projected
proj_crs = CRS.from_epsg(6933)
cart_crs = ccrs.Projection(proj_crs)
Preparing `cartopy.crs.CRS` for `pyproj.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. note:: `cartopy.crs.CRS` inherits from `pyproj.crs.CRS`,
so it should behave like a `pyproj.crs.CRS`.
.. code-block:: python
from cartopy.crs import PlateCarree
from pyproj.crs import CRS
cart_crs = PlateCarree()
proj_crs = CRS.from_user_input(cart_crs)
pycrs
-----
https://github.com/karimbahgat/PyCRS
.. warning:: Currently does not support WKT2
Preparing `pyproj.crs.CRS` for `pycrs`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
import pycrs
from pyproj.crs import CRS
proj_crs = CRS.from_epsg(4326)
py_crs = pycrs.parse.from_ogc_wkt(proj_crs.to_wkt("WKT1_GDAL"))
Preparing `pycrs` for `pyproj.crs.CRS`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
import pycrs
from pyproj.crs import CRS
py_crs = pycrs.parse.from_epsg_code(4326)
proj_crs = CRS.from_wkt(py_crs.to_ogc_wkt())
|