Point on GCA helper function

[hongyuchen1030]

Closes#356#312

Overview

a feature that determines whether a given point lies within a great circle arc. The great circle arc should be restricted to a span of less than 180 degrees, and the implementation should handle cases where the arc crosses the antimeridian (the 0-degree meridian).

And a global error tolerance constant described in #312 is set

Expected Usage

importuxarrayasuxgcr_same_lon_cart= [
ux.utils.helpers.node_lonlat_rad_to_xyz([0.0, 1.5]),
ux.utils.helpers.node_lonlat_rad_to_xyz([0.0, -1.5])
]
pt_same_lon_in=ux.utils.helpers.node_lonlat_rad_to_xyz([0.0, 0.0])
self.assertTrue(
ux.utils.helpers.point_within_GCR(pt_same_lon_in,
gcr_same_lon_cart))
pt_same_lon_out=ux.utils.helpers.node_lonlat_rad_to_xyz(
[0.0, 1.500000000000001])
res=ux.utils.helpers.point_within_GCR(pt_same_lon_out,
gcr_same_lon_cart)
self.assertFalse(res)

PR Checklist

General

• An issue is linked created and linked
• Add appropriate labels
• Filled out Overview and Expected Usage (if applicable) sections

Testing

• Adequate tests are created if there is new functionality
• Tests cover all possible logical paths in your function
• Tests are not too basic (such as simply calling a function and nothing else)

Documentation

• Docstrings have been added to all new functions
• Docstrings have updated with any function changes
• Internal functions have a preceding underscore (_) and have been added to docs/internal_api/index.rst
• User functions have been added to docs/user_api/index.rst

[philipc2]

Hi @hongyuchen1030

Can you untrack all the files under docs/internal_api/_autosummary

[hongyuchen1030]

Hi @hongyuchen1030

Can you untrack all the files under docs/internal_api/_autosummary

You mean deleting all lines after docs/internal_api/_autosummary? I am a bit clueless about what to do

[philipc2]

Looks good!