Geodesy.jl icon indicating copy to clipboard operation
Geodesy.jl copied to clipboard

Document the output units of the distance function

Open hmwesigwa opened this issue 8 years ago • 4 comments

What are the outpu units for the function distance(a, b, [datum = wgs84])? Is there a function included to convert that distance to miles?

hmwesigwa avatar Nov 14 '16 19:11 hmwesigwa

Everything is currently implement in SI units, so you get metres.

Do you think using a seperate package for unit conversion would be suitable?

andyferris avatar Nov 14 '16 20:11 andyferris

Recall also that distance is direct Cartesian distance so far - we'd love to support geodesic distances too.

andyferris avatar Nov 14 '16 20:11 andyferris

Great thanks! A package for unit conversion would definitely be convenient. Also mentioning that everything is implemented in SI units in the readme file would also be helpful to others. Thanks for the great work!

hmwesigwa avatar Nov 14 '16 20:11 hmwesigwa

Here's 4 unit packages that I'm aware of:

  • https://github.com/ajkeller34/Unitful.jl
  • https://github.com/dhoegh/EngUnits.jl
  • https://github.com/Keno/SIUnits.jl
  • https://github.com/timholy/Units.jl

Not sure what is best for a simple conversion (most of these aim to assert correct dimensional analysis)

andyferris avatar Nov 14 '16 23:11 andyferris