odc.geo #######
|Documentation Status| |Test Status| |Test Coverage| |Conda Version| |Discord|
This library combines geometry shape classes from shapely with CRS from pyproj to provide
projection aware Geometry. It exposes all the functionality provided by shapely modules, but
will refuse operations between geometries defined in different projections. Geometries can be
brought into a common projection with Geometry.to_crs method.
Based on that foundation a number of data types and utilities useful for working with geospatial
metadata are implemented. Of particular importance is GeoBox. It is an abstraction for a
geo-registered bounded pixel plane where a linear mapping from pixel coordinates to the real world
is defined.
To make working with geo-registered raster data easier an integration with xarray is provided.
Importing odc.geo.xr enables the .odc. accessor on every xarray.Dataset and
xarray.DataArray. This exposes geospatial information of a raster loaded with Open Datacube
or rioxarray_. Methods for attaching geospatial information to xarray objects in a robust way are
also provided. Geospatial information attached in this way survives most operations you might do on
the data: basic mathematical operations, type conversions, cropping, serialization to most formats
like zarr, netcdf, GeoTIFF.
For more details see Documentation_.
|Intro Image|
This repository contains geometry related code extracted from Open Datacube_.
For details and motivation see ODC-EP-06_ enhancement proposal.
.. |Documentation Status| image:: https://readthedocs.org/projects/odc-geo/badge/?version=latest :target: https://odc-geo.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. |Test Status| image:: https://github.com/opendatacube/odc-geo/actions/workflows/main.yml/badge.svg :target: https://github.com/opendatacube/odc-geo/actions/workflows/main.yml :alt: Test Status
.. |Test Coverage| image:: https://codecov.io/gh/opendatacube/odc-geo/branch/develop/graph/badge.svg?token=Qc7isqXNGF :target: https://codecov.io/gh/opendatacube/odc-geo :alt: Test Coverage
.. |Conda Version| image:: https://anaconda.org/conda-forge/odc-geo/badges/version.svg :target: https://anaconda.org/conda-forge/odc-geo :alt: Conda Version
.. |Discord| image:: https://img.shields.io/discord/1212501566326571070?label=Discord&logo=discord&logoColor=white&color=7289DA :target: https://discord.gg/4hhBQVas5U :alt: Join Discord for support
.. |Intro Image| image:: docs/_static/intro.svg :alt: Map with GeoBoxes :width: 256
.. _rioxarray: https://corteva.github.io/rioxarray/stable/
.. _xarray: https://docs.xarray.dev/en/stable/
.. _shapely: https://shapely.readthedocs.io/en/stable/manual.html
.. pyproj: https://pyproj4.github.io/pyproj/stable/
.. Open Datacube: https://github.com/opendatacube/datacube-core
.. ODC-EP-06: https://github.com/opendatacube/datacube-core/wiki/ODC-EP-06---Extract-Geometry-Utilities-into-a-Separate-Package
.. Documentation: https://odc-geo.readthedocs.io/