Merge pull request #2 from JuliaSpaceMissionDesign/dev

Update to version 1.1.6

Author: MicheleCeresoli

.github/workflows/ci.yml

@@ -13,13 +13,14 @@ jobs:
       matrix:
         version:
           - '1.8'
+          - '1.9'
           - nightly
         os:
           - ubuntu-latest
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}

Project.toml

@@ -1,7 +1,7 @@
 name = "CalcephEphemeris"
 uuid = "54e8752a-b65a-4aac-bda5-4918ee1e3cc5"
 authors = ["JSMD Team"]
-version = "1.1.5"
+version = "1.1.6"
 
 [deps]
 CALCEPH = "1537fe66-4725-5aba-80f4-3a74792cecc1"
@@ -10,7 +10,7 @@ JSMDInterfaces = "6b30ee2f-618e-4a15-bf4e-7df7b496e609"
 [compat]
 CALCEPH = "1.1"
 julia = "1"
-JSMDInterfaces = "1.2"
+JSMDInterfaces = "1.3"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -15,6 +15,7 @@ This package is a lightweight wrapper around [CALCEPH.jl](https://github.com/Jul
 This package can be installed using Julia's package manager: 
 ```julia
 julia> import Pkg; 
+
 julia> Pkg.add("CalcephEphemeris.jl")
 ```
 

docs/src/index.md

@@ -2,11 +2,20 @@
 
 _A lightweight CALCEPH.jl wrapper for the JSMD ecosystem._ 
 
-This package is a lightweight wrapper around [CALCEPH.jl](https://github.com/JuliaAstro/CALCEPH.jl) 
-that implements the [JSMDInterfaces.jl](https://github.com/JuliaSpaceMissionDesign/JSMDInterfaces.jl) 
-interfaces to extract data from SPICE and INPOP ephemeris kernels. 
+This package is a lightweight wrapper around [CALCEPH.jl](https://github.com/JuliaAstro/CALCEPH.jl) that implements the [JSMDInterfaces.jl](https://github.com/JuliaSpaceMissionDesign/JSMDInterfaces.jl) interfaces to extract data from SPICE and INPOP ephemeris kernels. 
 
 The CALCEPH is a C++ library written by the research team Astronomie et systèmes dynamiques 
 (CNRS/Observatoire de Paris/IMCCE). For further information on CALCEPH visit its 
 [official website](https://www.imcce.fr/inpop/calceph) or its original 
 [Julia wrapper](https://github.com/JuliaAstro/CALCEPH.jl).
+
+
+## Installation 
+
+This package can be installed using Julia's package manager:
+
+```julia
+julia> import Pkg; 
+
+julia> Pkg.add("CalcephEphemeris.jl")
+```

src/CalcephEphemeris.jl

@@ -35,22 +35,39 @@ files specified by `files`.
 ### Example 
 ```julia-repl
 julia> eph1 = CalcephProvider("PATH_TO_KERNEL")
-CalcephProvider(CALCEPH.Ephem(Ptr{Nothing} [...]))
+1-kernel CalcephProvider
+ "PATH_TO_KERNEL"
 
 julia> eph2 = CalcephProvider(["PATH_TO_KERNEL_1", "PATH_TO_KERNEL_2"])
-CalcephProvider(CALCEPH.Ephem(Ptr{Nothing} [...]))
+2-kernel CalcephProvider:
+ "PATH_TO_KERNEL_1"
+ "PATH_TO_KERNEL_2"
 ```
 """
 struct CalcephProvider <: jEph.AbstractEphemerisProvider
     ptr::CalcephEphemHandler
+    files::Vector{String}
     function CalcephProvider(files::Vector{<:AbstractString})
-        ptr = CalcephEphemHandler(unique(files))
+        filepaths = unique(files)
+        ptr = CalcephEphemHandler(filepaths)
         prefetch(ptr)
-        return new(ptr)
+        return new(ptr, filepaths)
     end
 end
+
 CalcephProvider(file::AbstractString) = CalcephProvider([file])
 
+function Base.show(io::IO, eph::CalcephProvider)
+    print(io, "$(length(eph.files))-kernel CalcephProvider")
+end
+
+function Base.show(io::IO, ::MIME"text/plain", eph::CalcephProvider)
+    println(io, eph, ":")
+    for file in eph.files
+        println(io, " $(repr(file))")
+    end
+end
+
 jEph.load(::Type{CalcephProvider}, file::AbstractString) = CalcephProvider(file)
 
 function jEph.load(::Type{CalcephProvider}, files::Vector{<:AbstractString})
@@ -68,7 +85,7 @@ end
 """
     ephem_position_records(eph::CalcephProvider)
 
-Get an array of [`jEph.EphemPointRecord`](@ref), providing detailed informations on the 
+Get an array of `EphemPointRecord`, providing detailed informations on the 
 position content of the ephemeris file.
 """
 function jEph.ephem_position_records(eph::CalcephProvider)
@@ -95,7 +112,7 @@ end
 """
     ephem_orient_records(eph::CalcephProvider)
 
-Get an array of [`jEph.EphemAxesRecord`](@ref), providing detailed 
+Get an array of `EphemAxesRecord`, providing detailed 
 informations on the orientation content of the ephemeris file.
 """
 function jEph.ephem_orient_records(eph::CalcephProvider)
@@ -177,9 +194,6 @@ must be equal to 3*order:
 - res[10:12] contain the jerk (d³x/dt³, d³y/dt³, d³z/dt³) for order ≥ 3
 
 The values stores in `res` are always returned in km, km/s, km/s², km/s³
-
-### See also 
-See also [`ephem_orient!`](@ref)
 """
 function jEph.ephem_compute!(
     res,
@@ -229,9 +243,6 @@ The values stores in `res` are always returned in rad, rad/s, rad/s², rad/s³
 !!! note 
     The `center` argument is only requested for compatibility reasons but is neglected 
     by CALCEPH. 
-
-### See also 
-See also [`ephem_compute!`](@ref)
 """
 function jEph.ephem_orient!(
     res, eph::CalcephProvider, jd0::Number, time::Number, target::Int, ::Int, order::Int

test/runtests.jl

@@ -26,6 +26,14 @@ end;
 
     kern = jEphem.load(CalcephProvider, [path_pa421, path_de432])
 
+    # Test CalcephProvider printing
+    @test repr(de432) == "1-kernel CalcephProvider"
+    @test repr(CalcephProvider([path_de432, path_pa421])) == "2-kernel CalcephProvider"
+
+    io = IOBuffer();
+    show(IOContext(io, :limit => false), "text/plain", de432)
+    @test String(take!(io)) == "1-kernel CalcephProvider:\n \"$path_de432\"\n"
+
     points = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 199, 299, 301, 399]
     axes = [1, 31006]