uxarray
uxarray copied to clipboard
UXARRAY
DRAFT: User Guide & Documentation Improvements
Closes #473
Overview
- Introduces a the User Guide section to our documentation
- Updated the front page with new descriptions and references to the Contributors Guide and User Guide
Updated Front Page
@aaronzedwick
Rajeev and I are working on populating a User Guide. I've assigned two sections to you if you'd be interested in helping out with them!
We can provide some guidance & a template as well!
@aaronzedwick
Rajeev and I are working on populating a User Guide. I've assigned two sections to you if you'd be interested in helping out with them!
We can provide some guidance & a template as well!
I would love to help! Templates and any guidance would be greatly appreciated! Also some insight into what is meant by distance operations? The great circle arcs?
@aaronzedwick Rajeev and I are working on populating a User Guide. I've assigned two sections to you if you'd be interested in helping out with them! We can provide some guidance & a template as well!
I would love to help! Templates and any guidance would be greatly appreciated! Also some insight into what is meant by distance operations? The great circle arcs?
It would discuss the KDTree and BallTree data structures, including distance metrics. We could talk about the great circle arcs also (since haversine distance metric considers the lines as arcs)
Also some introduction for our constants will be helpful as well
constants intro is more of a subject for the developers guide
Also some introduction for our constants will be helpful as well
constants intro is more of a subject for the developers guide
There are still some useful constants for the users.
For example, when the users are using our package, knowing what's the smallest value for the relative error tolerance is also important.
@hongyuchen1030
We can add a section once this is merged on the accuracy of our operators, including discussions on the expected error.