Rename GeoTIFF API to xarray conventions (#1047)#1061
Merged
brendancol merged 1 commit intomasterfrom Mar 23, 2026
Merged
Conversation
open_geotiff replaces read_geotiff, to_geotiff replaces write_geotiff. Adds .xrs.to_geotiff() accessor on DataArray and Dataset, and .xrs.open_geotiff() on Dataset for spatially-windowed reads. Includes accessor tests and user guide notebook.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
read_geotifftoopen_geotiffandwrite_geotifftoto_geotiff, matching xarray'sopen_*/to_*convention for I/O functionsopen_cog(was already deprecated).xrs.to_geotiff(path)accessor on DataArray and Dataset for chained writes.xrs.open_geotiff(path)accessor on Dataset that computes a pixel window from the Dataset's y/x coordinates and reads only the overlapping region from the file35_GeoTIFF_IO.ipynb) demonstrating round-trip I/O, accessor usage, windowed reads, and VRT mosaicsCloses #1047
Test plan