brmather/pycurious

[REVIEW] Specify meaning for x and y when defining the grid

santisoler opened this issue · 1 comments

santisoler commented

Part of openjournals/joss-reviews#1544.

On CurieGrid docstring, would be nice to specify what x and y stands for.
Some users may be used to packages that uses y for easting and x for northing, while others may refer to a classical Cartesian axes, where x is usually assigned to the horizontal (easting) coordinate and y to the vertical one (northing).

Also, would be nice to specify the expected shape of the grid 2d-array: (ny, nx).

brmather commented

Yes, I think it should be made as clear as possible that eastings and northings should be used (not longitude / latitude!) I have updated the docstring for CurieGrid in 27c40d5 to elaborate that x and y are eastings and northings in metres. Also I've listed all the attributes available under the CurieGrid object. Thanks!

  • 👍1