Merge pull request #71 from JuliaSpaceMissionDesign/dev

v3.0

Author: andreapasquale94

Project.toml

@@ -1,7 +1,7 @@
 name = "FrameTransformations"
 uuid = "5be70612-1674-42c4-a038-c376b6dc81ed"
 authors = ["JSMD Team"]
-version = "2.1.1"
+version = "3.0.0"
 
 [deps]
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
@@ -18,16 +18,16 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Tempo = "c33777b2-e695-4fae-9135-aeae8855dd81"
 
 [weakdeps]
-CalcephEphemeris = "54e8752a-b65a-4aac-bda5-4918ee1e3cc5"
+# CalcephEphemeris = "54e8752a-b65a-4aac-bda5-4918ee1e3cc5"
 Ephemerides = "6a9c3322-c8fe-4c26-8ad6-14a6f8acd2a0"
 
 [extensions]
-CalcephEphemerisExt = ["CalcephEphemeris"]
+# CalcephEphemerisExt = ["CalcephEphemeris"]
 EphemeridesExt = ["Ephemerides"]
 
 [compat]
 Ephemerides = "1"
-CalcephEphemeris = "1"
+# CalcephEphemeris = "1"
 ForwardDiff = "0.10"
 FunctionWrappers = "1"
 FunctionWrappersWrappers = "0.1"
@@ -43,6 +43,7 @@ julia = "1.9"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 
 [targets]
-test = ["Test"]
+test = ["Test", "SafeTestsets"]

docs/generate.jl

@@ -3,7 +3,7 @@ using Dates
 
 # TODO: Remove items from `SKIPFILE` as soon as they run on the latest stable 
 ONLYSTATIC = []
-EXAMPLE_DIRS = ["Tutorials", ]
+EXAMPLE_DIRS = ["Tutorials",]
 SKIPFILE = [
     "t03_eop.jl", "t04_lighttime.jl", "t05_multithread.jl"
 ]
@@ -13,22 +13,22 @@ function update_date(content)
     return content
 end
 
-for edir in EXAMPLE_DIRS 
+for edir in EXAMPLE_DIRS
     gen_dir = joinpath(@__DIR__, "src", edir, "gen")
     example_dir = joinpath(@__DIR__, "src", edir)
     for example in filter!(x -> endswith(x, ".jl"), readdir(example_dir))
-        if example in SKIPFILE 
+        if example in SKIPFILE
             continue
         end
         input = abspath(joinpath(example_dir, example))
         script = Literate.script(input, gen_dir)
         code = strip(read(script, String))
         mdpost(str) = replace(str, "@__CODE__" => code)
         Literate.markdown(
-            input, gen_dir, 
-            preprocess = update_date,
-            postprocess = mdpost,
-            documenter = !(example in ONLYSTATIC)
+            input, gen_dir,
+            preprocess=update_date,
+            postprocess=mdpost,
+            documenter=!(example in ONLYSTATIC)
         )
     end
 end

docs/make.jl

@@ -1,10 +1,11 @@
 using Documenter, FrameTransformations
-using Pkg 
+using Pkg
 
 const CI = get(ENV, "CI", "false") == "true"
 
-if CI 
+if CI
     Pkg.add("Ephemerides")
+    Pkg.add("StaticArrays")
     Pkg.add("ReferenceFrameRotations")
     Pkg.add("JSMDUtils")
     Pkg.add("JSMDInterfaces")
@@ -26,30 +27,22 @@ makedocs(;
             "01 - Frame System" => "Tutorials/gen/t00_frames.md",
             "02 - Rotation" => "Tutorials/gen/t01_rotation.md",
             "03 - Axes" => "Tutorials/gen/t02_axes.md",
-            "04 - Points" => "Tutorials/gen/t03_points.md",
-            # "05 - Light Time Corrections" => "Tutorials/gen/t04_lighttime.md",
-            # "06 - Multi-threading" => "Tutorials/gen/t05_multithread.md"
+            "04 - Points" => "Tutorials/gen/t03_points.md"
         ],
-        # "Use Cases" => [
-        #     "CR3BP" => "Examples/gen/e01_cr3bp.md",
-        #     "High Fidelity" => "Examples/gen/e02_hifi.md",
-        #     "Custom Orbit" => "Examples/gen/e03_customorb.md"
-        # ],
-        "Benchmarks" => "benchmarks.md",
         "API" => [
             "Public API" => [
-                "Frames" => "API/frames_api.md", 
                 "Axes" => "API/axes_api.md",
                 "Points" => "API/point_api.md",
-                "Directions" => "API/dir_api.md"
-            ],         
+                "Directions" => "API/dir_api.md",
+                "Frames" => "API/frames_api.md"
+            ],
         ],
     ],
     clean=true,
     checkdocs=:none
 )
 
-if CI 
+if CI
     deploydocs(;
         repo="github.com/JuliaSpaceMissionDesign/FrameTransformations.jl", branch="gh-pages"
     )

docs/src/API/axes_api.md

@@ -5,13 +5,11 @@
 ```@docs
 add_axes!
 
-add_axes_root!
-add_axes_inertial!
-add_axes_rotating!
 add_axes_fixedoffset!
+add_axes_projected!
+add_axes_rotating!
 add_axes_alias!
-add_axes_frozen!
-add_axes_ephemeris!
+FrameTransformations.add_axes_ephemeris!
 ```
 
 ## Celestial
@@ -65,9 +63,12 @@ add_axes_topocentric!
 ## Others 
 
 ```@docs
-add_axes_twovectors!
+add_axes_twodir!
+add_axes_frozen!
+add_axes_fixed_quaternion!
+add_axes_fixed_angles!
+add_axes_fixed_angleaxis!
 ```
-
 ## Utils
 
 ### [IDs](@id frames_axesid)

docs/src/API/dir_api.md

@@ -8,5 +8,4 @@ add_direction_fixed!
 add_direction_position!
 add_direction_velocity!
 add_direction_orthogonal!
-add_direction_normalize!
 ```

docs/src/API/frames_api.md

@@ -10,31 +10,31 @@ FrameTransformations.timescale
 
 ```@docs 
 has_point
-points 
 points_graph
+points_alias
 ```
 
 ### Axes
 
 ```@docs 
 has_axes 
-FrameTransformations.axes
 axes_graph
+axes_alias
 ```
 
 ### Directions
 
 ```@docs 
 has_direction
 directions
-directions_map
 ```
 
 ## [Rotations](@id rotation_api)
 
 ```@docs 
 Rotation
 Base.inv
+Translation
 ```
 
 ## [Transformations](@id transformations_api)

docs/src/API/point_api.md

@@ -3,11 +3,10 @@
 ```@docs
 add_point!
 
-add_point_root!
 add_point_dynamical!
 add_point_fixedoffset!
 
-add_point_ephemeris!
+FrameTransformations.add_point_ephemeris!
 add_point_surface!
 
 add_point_alias!