Skip to content

MNT: recommend write_crs & deprecate set_crs - #793

Merged
snowman2 merged 9 commits into
corteva:masterfrom
dluks:docs/clarify-write-crs
Jul 8, 2024
Merged

MNT: recommend write_crs & deprecate set_crs#793
snowman2 merged 9 commits into
corteva:masterfrom
dluks:docs/clarify-write-crs

Conversation

@dluks

@dluksdluks commented Jul 3, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

There is some confusion around when to use write_crs versus set_crs. This adds a small note to generally prefer write_crs when CRS persistence is needed. Fixes#743

One remaining nit that I would like to clarify in the documentation as well: when exactly should people use rio.set_crs() and not rio.write_crs()?

@dluks
docs: add clarification regarding write_crs and set_crs
5007992
There is some confusion around when to use write_crs versus set_crs. This adds a small note to generally prefer write_crs when CRS persistence is needed. Fixescorteva#743
@snowman2

snowman2 commented Jul 3, 2024

Copy link
Copy Markdown
Member

Thanks! Would you also be willing to add this to the set_crs docstrings?

@snowman2

snowman2 commented Jul 3, 2024

Copy link
Copy Markdown
Member

when exactly should people use rio.set_crs() and not rio.write_crs()?

I would say never use rio.set_crs due to its instability. It was added a while a go and probably should be deprecated.

@dluks

dluks commented Jul 3, 2024

Copy link
Copy Markdown
ContributorAuthor

@snowman2 I've pushed two commits that address the set_crs definition. The first adds a warning to the docstring and the second emits an actual DeprecationWarning when using set_crs. Not sure if raising an actual warning is what you had in mind, so if not I can revert it.

@dluks
dluksforce-pushed the docs/clarify-write-crs branch from fe3222f to cd6ed20CompareJuly 3, 2024 21:49
snowman2
snowman2 reviewed Jul 5, 2024
View reviewed changes
Comment threadrioxarray/rioxarray.py Outdated
snowman2
snowman2 reviewed Jul 5, 2024
View reviewed changes
Comment threadrioxarray/rioxarray.py
snowman2
snowman2 reviewed Jul 5, 2024
View reviewed changes
Comment threaddocs/getting_started/crs_management.ipynb Outdated
snowman2
snowman2 reviewed Jul 5, 2024
View reviewed changes
Comment threadrioxarray/rioxarray.py Outdated
snowman2
snowman2 reviewed Jul 8, 2024
View reviewed changes
Comment threadrioxarray/rioxarray.py Outdated
@snowman2snowman2 added this to the 0.16.0 milestone Jul 8, 2024
@snowman2snowman2 added bug Something isn't working documentation Documentation related issue labels Jul 8, 2024
@dluks@snowman2
MNT: use single quotes over backticks in set_crs warning text
6245755
Co-authored-by: Alan D. Snow <alansnow21@gmail.com>
@snowman2snowman2 changed the title docs: add clarification regarding write_crs and set_crsMNT: recommend write_crs & deprecate set_crsJul 8, 2024
@snowman2

snowman2 commented Jul 8, 2024

Copy link
Copy Markdown
Member

Thanks @dluks 👍

@snowman2
snowman2 merged commit b877e41 into corteva:masterJul 8, 2024
weiji14 added a commit to GenericMappingTools/pygmt that referenced this pull request Jul 9, 2024
@weiji14
Replace rio.set_crs with rio.write_crs in load_tile_map function
1c5084f
Rioxarray 0.16.0 has deprecated the use of `set_crs` in favour of `write_crs`. Xref corteva/rioxarray#793
@weiji14weiji14 mentioned this pull request Jul 9, 2024
Merged
7 tasks
weiji14 added a commit to GenericMappingTools/pygmt that referenced this pull request Jul 9, 2024
@weiji14
Replace rio.set_crs with rio.write_crs in load_tile_map function (#3321)
3a32169
* Replace rio.set_crs with rio.write_crs in load_tile_map function
Rioxarray 0.16.0 has deprecated the use of `set_crs` in favour of `write_crs`. Xref corteva/rioxarray#793
* Add spatial_ref coordinate to load_tile_map's doctest output
The `write_crs` command will write an extra grid_mapping attribute to the encoding that shows up in the coordinates.
@dluks
dluks deleted the docs/clarify-write-crs branch November 29, 2024 11:03
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@snowman2snowman2snowman2 left review comments

Assignees

No one assigned

Labels

bugSomething isn't workingdocumentationDocumentation related issue

Projects

None yet

Milestone

0.16.0

Development

Successfully merging this pull request may close these issues.

Document difference between set_crs and write_crs

2 participants

@dluks@snowman2