Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the output units of the distance function #27

Open
hmwesigwa opened this issue Nov 14, 2016 · 4 comments
Open

Document the output units of the distance function #27

hmwesigwa opened this issue Nov 14, 2016 · 4 comments

Comments

@hmwesigwa
Copy link

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

@andyferris
Copy link
Contributor

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
Copy link
Contributor

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

@hmwesigwa
Copy link
Author

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!

@andyferris
Copy link
Contributor

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

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

@andyferris andyferris changed the title What are the output units for the distance function Document what are the output units for the distance function Nov 14, 2016
@andyferris andyferris changed the title Document what are the output units for the distance function Document the output units of the distance function Nov 14, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants