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

brmather / pycurious

Python package for computing the Curie depth from the magnetic anomaly

https://brmather.github.io/pycurious/

GNU Lesser General Public License v3.0

38 stars 17 forks source link

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

Closed santisoler closed 5 years ago

santisoler commented 5 years ago

Part of https://github.com/openjournals/joss-reviews/issues/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 5 years ago

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 27c40d5cd2685123c5d416d860220b248a86ba5d 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!