fix all doctests and add tests for coord transforms

Author: asinghvi17

src/utils/UnitSpherical/UnitSpherical.jl

@@ -15,5 +15,6 @@ include("cap.jl")
 
 export UnitSphericalPoint, UnitSphereFromGeographic, GeographicFromUnitSphere, 
        slerp, SphericalCap
+export spherical_distance
 
 end

src/utils/UnitSpherical/coordinate_transforms.jl

@@ -13,6 +13,8 @@ Accepts any [GeoInterface-compatible](https://github.com/JuliaGeo/GeoInterface.j
 ## Examples
 
 ```jldoctest
+julia> import GeoInterface as GI; using GeometryOps.UnitSpherical
+
 julia> UnitSphereFromGeographic()(GI.Point(45, 45))
 3-element UnitSphericalPoint{Float64} with indices SOneTo(3):
  0.5000000000000001
@@ -21,6 +23,8 @@ julia> UnitSphereFromGeographic()(GI.Point(45, 45))
 ```
 
 ```jldoctest
+julia> using GeometryOps.UnitSpherical
+
 julia> UnitSphereFromGeographic()((45, 45))
 3-element UnitSphericalPoint{Float64} with indices SOneTo(3):
  0.5000000000000001
@@ -62,10 +66,12 @@ Accepts any 3-element vector, but the input is assumed to be on the unit sphere.
 ## Examples
 
 ```jldoctest
+julia> using GeometryOps.UnitSpherical
+
 julia> GeographicFromUnitSphere()(UnitSphericalPoint(0.5, 0.5, 1/√(2)))
 (45.0, 44.99999999999999)
 ```
-(the inaccuracy is due to the precision of `atan` function)
+(the inaccuracy is due to the precision of the `atan` function)
 
 """
 struct GeographicFromUnitSphere <: CoordinateTransformations.Transformation 

src/utils/UnitSpherical/point.jl

@@ -28,8 +28,13 @@ and back again.
 ## Examples
 
 ```jldoctest
+julia> using GeometryOps.UnitSpherical
+
 julia> UnitSphericalPoint(1, 0, 0)
-UnitSphericalPoint(1.0, 0.0, 0.0)
+3-element UnitSphericalPoint{Int64} with indices SOneTo(3):
+ 1
+ 0
+ 0
 ```
 
 """
@@ -111,11 +116,15 @@ Returns a `Number`, usually Float64 but that depends on the input type.
 ## Doctests
 
 ```jldoctest
+julia> using GeometryOps.UnitSpherical
+
 julia> spherical_distance(UnitSphericalPoint(1, 0, 0), UnitSphericalPoint(0, 1, 0))
 1.5707963267948966
 ```
 
 ```jldoctest
+julia> using GeometryOps.UnitSpherical
+
 julia> spherical_distance(UnitSphericalPoint(1, 0, 0), UnitSphericalPoint(1, 0, 0))
 0.0
 ```

src/utils/UnitSpherical/slerp.jl

@@ -26,6 +26,8 @@ between 0 and 1 along the path from `a` to `b`.
 ## Examples
 
 ```jldoctest
+julia> using GeometryOps.UnitSpherical
+
 julia> slerp(UnitSphericalPoint(1, 0, 0), UnitSphericalPoint(0, 1, 0), 0.5)
 3-element UnitSphericalPoint{Float64} with indices SOneTo(3):
  0.7071067811865475

test/runtests.jl

@@ -17,6 +17,7 @@ end
 @safetestset "Utils" begin include("utils/utils.jl") end
 @safetestset "LoopStateMachine" begin include("utils/LoopStateMachine.jl") end
 @safetestset "SpatialTreeInterface" begin include("utils/SpatialTreeInterface.jl") end
+@safetestset "UnitSpherical" begin include("utils/unitspherical.jl") end
 
 # Methods
 @safetestset "Angles" begin include("methods/angles.jl") end

test/utils/unitspherical.jl

@@ -0,0 +1,80 @@
+using Test
+
+using GeometryOps.UnitSpherical
+
+import GeoInterface as GI
+
+@testset "Coordinate transforms" begin
+    @testset "UnitSphereFromGeographic" begin
+        # Test with GeoInterface Point
+        point = GI.Point(45, 45)
+        result = UnitSphereFromGeographic()(point)
+        @test result isa UnitSphericalPoint{Float64}
+        @test length(result) == 3
+        @test isapprox(result[1], 0.5, atol=1e-10)
+        @test isapprox(result[2], 0.5, atol=1e-10)
+        @test isapprox(result[3], 1/√2, atol=1e-10)
+
+        # Test with tuple
+        result = UnitSphereFromGeographic()((45, 45))
+        @test result isa UnitSphericalPoint{Float64}
+        @test length(result) == 3
+        @test isapprox(result[1], 0.5, atol=1e-10)
+        @test isapprox(result[2], 0.5, atol=1e-10)
+        @test isapprox(result[3], 1/√2, atol=1e-10)
+
+        # Test edge cases
+        # North pole
+        result = UnitSphereFromGeographic()((0, 90))
+        @test isapprox(result[1], 0.0, atol=1e-10)
+        @test isapprox(result[2], 0.0, atol=1e-10)
+        @test isapprox(result[3], 1.0, atol=1e-10)
+
+        # South pole
+        result = UnitSphereFromGeographic()((0, -90))
+        @test isapprox(result[1], 0.0, atol=1e-10)
+        @test isapprox(result[2], 0.0, atol=1e-10)
+        @test isapprox(result[3], -1.0, atol=1e-10)
+
+        # Equator
+        result = UnitSphereFromGeographic()((0, 0))
+        @test isapprox(result[1], 1.0, atol=1e-10)
+        @test isapprox(result[2], 0.0, atol=1e-10)
+        @test isapprox(result[3], 0.0, atol=1e-10)
+    end
+
+    @testset "GeographicFromUnitSphere" begin
+        # Test basic conversion
+        point = UnitSphericalPoint(0.5, 0.5, 1/√2)
+        result = GeographicFromUnitSphere()(point)
+        @test result isa Tuple{Float64,Float64}
+        @test isapprox(result[1], 45.0, atol=1e-10)  # longitude
+        @test isapprox(result[2], 45.0, atol=1e-10)  # latitude
+
+        # Test edge cases
+        # North pole
+        result = GeographicFromUnitSphere()(UnitSphericalPoint(0.0, 0.0, 1.0))
+        @test isapprox(result[1], 0.0, atol=1e-10)  # longitude (undefined at poles, convention is 0)
+        @test isapprox(result[2], 90.0, atol=1e-10)  # latitude
+
+        # South pole
+        result = GeographicFromUnitSphere()(UnitSphericalPoint(0.0, 0.0, -1.0))
+        @test isapprox(result[1], 0.0, atol=1e-10)  # longitude (undefined at poles, convention is 0)
+        @test isapprox(result[2], -90.0, atol=1e-10)  # latitude
+
+        # Equator
+        result = GeographicFromUnitSphere()(UnitSphericalPoint(1.0, 0.0, 0.0))
+        @test isapprox(result[1], 0.0, atol=1e-10)  # longitude
+        @test isapprox(result[2], 0.0, atol=1e-10)  # latitude
+
+        # Test with regular vector
+        result = GeographicFromUnitSphere()([0.5, 0.5, 1/√2])
+        @test result isa Tuple{Float64,Float64}
+        @test isapprox(result[1], 45.0, atol=1e-10)
+        @test isapprox(result[2], 45.0, atol=1e-10)
+
+        # Test error handling for non-3D vectors
+        @test_throws AssertionError GeographicFromUnitSphere()([1.0, 0.0])
+        @test_throws AssertionError GeographicFromUnitSphere()([1.0, 0.0, 0.0, 0.0])
+    end
+end