Initialize a GMTDataArrayAccessor by weiji14 · Pull Request #500 · GenericMappingTools/pygmt

weiji14 · 2020-06-29T11:30:32Z

Description of proposed changes

An xarray accessor for GMT specific information! Currently holds the gridline/pixel registration and cartesian/geographic type properties. Created a new 'Metadata' section in the API docs for this, and moved info and grdinfo here.

Enables functionality like this:

print(grid.gmt.registration)
1# for pixel registration

print(grid.gmt.gtype)
0# for cartesian coordinates

Will be extremely helpful for #476.

First step in fixing #499; Supersedes/Closes#494.

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If adding new functionality, add an example to docstrings or tutorials.

An xarray accessor for GMT specific information! Currently holds the gridline/pixel registration and cartesian/geographic type properties. Created a new 'Metadata' section in the API docs for this, and moved info and grdinfo here.

Using a "setter" decorator to set/change class attributes. Wrote some unit tests to ensure code coverage if up to scratch, except that we can't test Pixel Registration properly yet.

weiji14

Ready for review. The current implementation actually works on both GMT 6.0 and 6.1, and I've avoided using the earth_relief grid in the test. Once this is approved, I can continue on #476!

weiji14 · 2020-07-09T10:49:07Z

+ # logging.warning(
+ # msg="Cannot find a NetCDF source of xarray grid. "
+ # f"Will fallback to using GMT's default setting: {default_reg_and_gtype}"
+ # )


Will uncomment this after we decide on #487.

Breaks backward compatibility with GMT 6.0, but simplifies the code (at some expense of readability). Co-Authored-By: Dongdong Tian <seisman.info@gmail.com>

weiji14

@seisman, ready to re-review. I was thinking of adding a __repr__ so that users can see what '0' or '1' means when they print the registration/gtype info, but that could go in a separate PR.

There's a lot we can add to this GMTDataArrayAccessor, and I've listed some in #499 (which I'll skip closing for now). This is really just the beginning 😄

seisman · 2020-07-11T22:43:53Z

+ except KeyError:
+ self._registration = 0 # Default to Gridline registration
+ self._gtype = 0 # Default to Cartesian grid type
+ # logging.warning(


Remove the warning?

Ok, I've removed it for now, but will revisit it when we decide on #487. The intention is to not surprise users by enforcing a particular default registration/gtype (especially users used to using pixel registration/Cartesian coordinate data). The warning would ideally be surpressed by setting e.g. grid.gmt.registration = 1, but I haven't quite worked out how to do so.

seisman · 2020-07-11T22:49:26Z

+
+ @registration.setter
+ def registration(self, value):
+ if value in (0, 1):


It may be more user friendly if we can also set the properties by grid.gmt.registration = "pixel" and grid.gmt.gtype = "geographic", but I'm OK with the current boolean values, 0 and 1.

Good idea. Let's leave it for now, but introduce this once we work out how to do the __repr__ as mentioned in #500 (review).

seisman

Good to me.

seisman · 2020-07-11T23:16:22Z

Please change to a better title before merging.

weiji14 · 2020-07-11T23:21:04Z

Oops sorry, missed your comment.

seisman · 2020-07-11T23:23:12Z

Never mind. You can still change the draft release information directly. The title is not descriptive to me.

weiji14 · 2020-07-11T23:24:54Z

Yep, will do that in the release notes. I think the draft one will be overwritten every time a PR is merged.

Initialize a GMTDataArrayAccessor
8a539b5
An xarray accessor for GMT specific information! Currently holds the gridline/pixel registration and cartesian/geographic type properties. Created a new 'Metadata' section in the API docs for this, and moved info and grdinfo here.

weiji14 added the feature Brand new feature label Jun 29, 2020

vercelBottemporarily deployed to Preview June 29, 2020 11:31 Inactive

weiji14 marked this pull request as draft June 29, 2020 11:36

weiji14 changed the title ~~Initialize a GMTDataArrayAccessor~~WIP: Initialize a GMTDataArrayAccessorJun 29, 2020

Add more tests and allow for overriding registration and coordinate type
0ab88cd
Using a "setter" decorator to set/change class attributes. Wrote some unit tests to ensure code coverage if up to scratch, except that we can't test Pixel Registration properly yet.

vercelBottemporarily deployed to Preview June 30, 2020 03:30 Inactive

weiji14 mentioned this pull request Jul 2, 2020
Release PyGMT 0.1.2 #501
Closed
10 tasks

seisman mentioned this pull request Jul 8, 2020
Bump the required minimum GMT version to 6.1.0 #507
Merged
5 tasks

Merge branch 'master' into gmt-xr-accessor
49fabb3

vercelBottemporarily deployed to Preview July 9, 2020 09:59 Inactive

vercelBottemporarily deployed to Preview July 9, 2020 10:19 Inactive

weiji14 changed the title ~~WIP: Initialize a GMTDataArrayAccessor~~Initialize a GMTDataArrayAccessorJul 9, 2020

weiji14 marked this pull request as ready for review July 9, 2020 10:38

weiji14 commented Jul 9, 2020
View reviewed changes

weiji14 commented Jul 10, 2020
View reviewed changes

Comment threadpygmt/modules.py Outdated

weiji14 added 2 commits July 11, 2020 11:26

Merge branch 'master' into gmt-xr-accessor
8db355a

Fix some typos in the GMTDataArrayAccessor docstring
e33c5eb

vercelBottemporarily deployed to Preview July 10, 2020 23:32 Inactive

Get registration and gtype using grdinfo -C
896ed59
Breaks backward compatibility with GMT 6.0, but simplifies the code (at some expense of readability). Co-Authored-By: Dongdong Tian <seisman.info@gmail.com>

vercelBottemporarily deployed to Preview July 10, 2020 23:51 Inactive

Merge branch 'master' into gmt-xr-accessor
99dbd1f

vercelBottemporarily deployed to Preview July 11, 2020 08:15 Inactive

Update tests now that GMT 6.1 is out, check pixel/gridline/cartesia/geo
f0ac444

vercelBottemporarily deployed to Preview July 11, 2020 22:04 Inactive

weiji14 commented Jul 11, 2020
View reviewed changes

seisman reviewed Jul 11, 2020
View reviewed changes

Add inline comments to describe code and remove commented out warning
b567eac

vercelBottemporarily deployed to Preview July 11, 2020 22:59 Inactive

seisman approved these changes Jul 11, 2020
View reviewed changes

seisman added this to the 0.2.x milestone Jul 11, 2020

weiji14 merged commit b3aa16d into masterJul 11, 2020

weiji14 deleted the gmt-xr-accessor branch July 11, 2020 23:19

This was referenced Jul 11, 2020
More informative metadata when loading earth_relief grids #494
Closed
Properly allow for either pixel or gridline registered grids #476
Merged
Improve Figure.show for displaying previews in Jupyter notebooks and external viewers #529
Merged

weiji14 mentioned this pull request Nov 21, 2022
Infer grid registration (gridline vs pixel) and grid type (geographic or Cartesian) for xarray.DataArray input #2194
Open

seisman mentioned this pull request Oct 3, 2024
GMTDataArrayAccessor: Simplify the codes for the grid registration and gtype during initialization #3483
Merged

Uh oh!

Conversation

weiji14 commented Jun 29, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

weiji14Jul 9, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

weiji14 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

seismanJul 11, 2020

Choose a reason for hiding this comment

Uh oh!

weiji14Jul 11, 2020

Choose a reason for hiding this comment

Uh oh!

seismanJul 11, 2020

Choose a reason for hiding this comment

Uh oh!

weiji14Jul 11, 2020

Choose a reason for hiding this comment

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

seisman commented Jul 11, 2020

Uh oh!

weiji14 commented Jul 11, 2020

Uh oh!

seisman commented Jul 11, 2020

Uh oh!

weiji14 commented Jul 11, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

weiji14 commented Jun 29, 2020•
edited
Loading

weiji14 left a comment •
edited
Loading