Renamed package to IERSConventions

.github/workflows/ci.yml

@@ -59,8 +59,8 @@ jobs:
           julia --color=yes --project=docs -e '
             import Pkg; Pkg.add("Documenter")
             using Documenter: doctest
-            using IERS
-            doctest(IERS)'
+            using IERSConventions
+            doctest(IERSConventions)'
       - run: julia --project=docs --color=yes docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Project.toml

@@ -1,4 +1,4 @@
-name = "IERS"
+name = "IERSConventions"
 uuid = "4e86e20e-879b-40dc-9e12-cee74f4cd199"
 authors = ["JSMD Team"]
 version = "1.0.0"

README.md

@@ -1,12 +1,12 @@
 
-# IERS.jl
+# IERSConventions.jl
 
 _IERS Conventions made easy._
 
-[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaspacemissiondesign.github.io/IERS.jl/stable/) 
-[![Dev Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaspacemissiondesign.github.io/IERS.jl/dev/) 
-[![Build Status](https://github.com/JuliaSpaceMissionDesign/IERS.jl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/JuliaSpaceMissionDesign/IERS.jl/actions/workflows/ci.yml)
-[![codecov](https://codecov.io/gh/JuliaSpaceMissionDesign/IERS.jl/branch/main/graph/badge.svg?token=7fj9BjJhKF)](https://codecov.io/gh/JuliaSpaceMissionDesign/IERS.jl)
+[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaspacemissiondesign.github.io/IERSConventions.jl/stable/) 
+[![Dev Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaspacemissiondesign.github.io/IERSConventions.jl/dev/) 
+[![Build Status](https://github.com/JuliaSpaceMissionDesign/IERSConventions.jl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/JuliaSpaceMissionDesign/IERSConventions.jl/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/JuliaSpaceMissionDesign/IERSConventions.jl/branch/main/graph/badge.svg?token=7fj9BjJhKF)](https://codecov.io/gh/JuliaSpaceMissionDesign/IERSConventions.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 
 The aim of this package is to provide a set of standardised functions that allow the user to easily handle all the computations related to the IERS, from the earlier 1996 up to the latest 2010 conventions.
@@ -17,7 +17,7 @@ This package will soon be registered within Julia's general registry.
 
 ## Documentation 
 For further information on this package and its tutorials please refer to the 
-[stable documentation](https://juliaspacemissiondesign.github.io/IERS.jl/stable/).
+[stable documentation](https://juliaspacemissiondesign.github.io/IERSConventions.jl/stable/).
 
 ## Support
 If you found this package useful, please consider starring the repository. We also encourage you to take a look at other astrodynamical packages of the [JSMD](https://github.com/JuliaSpaceMissionDesign/) organisation.

docs/make.jl

@@ -1,12 +1,12 @@
-using Documenter, IERS
+using Documenter, IERSConventions
 using Pkg 
 
 const CI = get(ENV, "CI", "false") == "true"
 
 
 makedocs(;
     authors="Julia Space Mission Design Development Team",
-    sitename="IERS.jl",
+    sitename="IERSConventions.jl",
     modules=[IERS],
     format=Documenter.HTML(; prettyurls=CI, highlights=["yaml"], ansicolor=true),
     pages=[
@@ -26,5 +26,5 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/JuliaSpaceMissionDesign/IERS.jl", branch="gh-pages"
+    repo="github.com/JuliaSpaceMissionDesign/IERSConventions.jl", branch="gh-pages"
 )

src/IERS.jl → src/IERSConventions.jl

@@ -1,4 +1,4 @@
-module IERS
+module IERSConventions
 
     using Tempo
 
@@ -7,7 +7,7 @@ module IERS
     using StaticArrays
 
     # Basic definitions
-    include("conventions.jl")
+    include("models.jl")
     include("angles.jl")
     include("poisson.jl")
 

src/bpn.jl

@@ -2,7 +2,7 @@
 export iers_bias, iers_pb, iers_npb
 
 """
-    iers_bias(m::IERSConventions, t::Number)
+    iers_bias(m::IERSModel, t::Number)
 
 Compute the frame bias matrix, which transform vectors from the GCRF axes to the Mean 
 Equinox and Mean Equator of J2000 (MEME2000) axes. 
@@ -23,7 +23,7 @@ iers_bias
 
 
 """
-    iers_pb(m::IERSConventions, t::Number)
+    iers_pb(m::IERSModel, t::Number)
 
 Compute the precession-bias (PB) matrix, which transforms vectors from the GCRF axes to
 Mean-of-Date (MOD) axes, at time `t` expressed in `TT` Julian centuries since `J2000`, according 
@@ -43,7 +43,7 @@ iers_pb
 
 
 """
-    iers_npb(m::IERSConventions, t::Number, δΔψ=0, δΔϵ=0)
+    iers_npb(m::IERSModel, t::Number, δΔψ=0, δΔϵ=0)
 
 Compute the nutation-bias-precession (NPB) matrix, which transforms vectors from the GCRF 
 to True-of-Date (TOD) axes, at time `t` expressed in `TT` Julian centuries since `J2000`, 

src/cip.jl

@@ -2,7 +2,7 @@
 export iers_cip_motion, cip_xy, cip_xys, cip_vector
 
 """
-    iers_cip_motion(m::IERSConventions, t::Number, δX::Number=0, δY::Number=0)
+    iers_cip_motion(m::IERSModel, t::Number, δX::Number=0, δY::Number=0)
 
 Compute the GCRF-to-CIRF rotation matrix, following the IERS Conventions `m`, at time `t` 
 expressed in `TT` Julian centuries since J2000. Optional IERS EOP corrections for free-core 
@@ -14,7 +14,7 @@ nutation and time dependent effects can be provided via `δX` and `δY`
 ### See also 
 See also [`cip_xy`](@ref) and [`cip_xys`](@ref).
 """
-function iers_cip_motion(m::IERSConventions, t::Number, δX::Number=0, δY::Number=0)
+function iers_cip_motion(m::IERSModel, t::Number, δX::Number=0, δY::Number=0)
 
     # Compute CIP coordinates 
     X, Y, s = cip_xys(m, t, δX, δY)
@@ -26,7 +26,7 @@ end
 
 
 """
-    cip_xy(m::IERSConventions, t::Number)
+    cip_xy(m::IERSModel, t::Number)
 
 Compute the CIP X and Y coordinates, in radians, following the IERS Conventions `m`, at 
 time `t`, expressed in `TT` Julian centuries since J2000.
@@ -50,7 +50,7 @@ cip_xy
 
 
 """
-    cip_xys(m::IERSConventions, t::Number, δX::Number=0, δY::Number=0)
+    cip_xys(m::IERSModel, t::Number, δX::Number=0, δY::Number=0)
 
 Compute the CIP X, Y and CIO locator s coordinates, in radians, following the IERS 
 conventions `m` at time `t`, expressed in `TT`` Julian centuries since J2000. Optional EOP 
@@ -70,7 +70,7 @@ nutation corrections can be provided via the `δX` and `δY` parameters.
 ### See also 
 See also [`iers_cip_motion`](@ref) and [`cip_xy`](@ref).
 """
-function cip_xys(m::IERSConventions, t::Number, δX::Number=0, δY::Number=0)
+function cip_xys(m::IERSModel, t::Number, δX::Number=0, δY::Number=0)
 
     # Compute CIP coordinates 
     x, y = cip_xy(m, t)
@@ -88,7 +88,7 @@ end
 
 
 """
-    cip_vector(m::IERSConventions, t::Number)
+    cip_vector(m::IERSModel, t::Number)
 
 Compute the Celestial Intermediate Pole (CIP) vector, following the IERS Conventions `m` at 
 time `t`, expressed in `TT` Julian centuries since J2000.
@@ -100,14 +100,14 @@ time `t`, expressed in `TT` Julian centuries since J2000.
 ### See also 
 See also [`cip_xy`](@ref).
 """
-function cip_vector(m::IERSConventions, t::Number)
+function cip_vector(m::IERSModel, t::Number)
     xs, ys = cip_xy(m, t)
     return SA[xs, ys, sqrt(1 - xs^2 - ys^2)]
 end
 
 
 """
-    cio_locator(m::IERSConventions, t::Number, x::Number, y::Number)
+    cio_locator(m::IERSModel, t::Number, x::Number, y::Number)
 
 Compute the CIO locator `s`, in radians, following the IERS Conventions `m' at time `t`, 
 expressed in `TT` Julian centuries since J2000, given the CIP coordinates `x` and `y`.
@@ -121,7 +121,7 @@ expressed in `TT` Julian centuries since J2000, given the CIP coordinates `x` an
 ### See also 
 See also [`iers_cip_motion`](@ref), [`cip_xy`](@ref) and [`cip_xys`](@ref).
 """
-function cio_locator(m::IERSConventions, t, x, y)
+function cio_locator(m::IERSModel, t, x, y)
     _cio_locator(m, t, DelaunayArgs(m, t), PlanetaryArgs(m, t)) - x*y/2
 end
 

src/delaunay.jl

@@ -28,7 +28,7 @@ struct DelaunayArgs{T}
     Ω::T
 end
 
-function DelaunayArgs(m::IERSConventions, t::Number)
+function DelaunayArgs(m::IERSModel, t::Number)
 
     DelaunayArgs(
         delaunay_anomaly_moon(m, t), 
@@ -42,7 +42,7 @@ end
 
 
 """
-    delaunay_anomaly_moon(m::IERSConventions, t::Number)
+    delaunay_anomaly_moon(m::IERSModel, t::Number)
 
 Compute the mean anomaly of the Moon, in radians, given time `t` expressed in TDB Julian 
 centuries since J2000. 
@@ -56,7 +56,7 @@ function delaunay_anomaly_moon(::IERSAModels, t::Number)
     )
 end
 
-function delaunay_anomaly_moon(::IERSConventions, t::Number)
+function delaunay_anomaly_moon(::IERSModel, t::Number)
     arcsec2rad(mod(485868.249036 + 1717915923.2178t, 1296000))
 end
 
@@ -67,7 +67,7 @@ end
 
 
 """
-    delaunay_anomaly_sun(m::IERSConventions, t::Number)
+    delaunay_anomaly_sun(m::IERSModel, t::Number)
 
 Compute the mean anomaly of the Sun, in radians, given time `t` expressed in TDB Julian 
 centuries since J2000.
@@ -80,7 +80,7 @@ function delaunay_anomaly_sun(::IERSAModels, t::Number)
     )
 end
 
-function delaunay_anomaly_sun(::IERSConventions, t::Number)
+function delaunay_anomaly_sun(::IERSModel, t::Number)
     arcsec2rad(mod(1287104.79305 + 129596581.0481t, 1296000))
 end
 
@@ -91,7 +91,7 @@ end
 
 
 """
-    delaunay_longitude_diff(m::IERSConventions, t::Number)
+    delaunay_longitude_diff(m::IERSModel, t::Number)
 
 Compute the difference between the longitude of the Moon and the longitude of the Moon's 
 node, in radians, given time `t` expressed in TDB Julian centuries since J2000.
@@ -104,7 +104,7 @@ function delaunay_longitude_diff(::IERSAModels, t::Number)
     )
 end
 
-function delaunay_longitude_diff(::IERSConventions, t::Number)
+function delaunay_longitude_diff(::IERSModel, t::Number)
     arcsec2rad(mod(335779.526232 + 1739527262.8478t, 1296000))
 end
 
@@ -114,7 +114,7 @@ function delaunay_longitude_diff(::IERS1996, t::Number)
 end
 
 """
-    delaunay_elongation_moon(m::IERSConventions, t::Number)
+    delaunay_elongation_moon(m::IERSModel, t::Number)
 
 Compute the mean elongation of the Moon from the Sun, in radians, given time `t` expressed in 
 TDB Julian centuries since J2000.
@@ -127,7 +127,7 @@ function delaunay_elongation_moon(::IERSAModels, t::Number)
     )
 end
 
-function delaunay_elongation_moon(::IERSConventions, t::Number)
+function delaunay_elongation_moon(::IERSModel, t::Number)
     arcsec2rad(mod(1072260.70369 + 1602961601.2090t, 1296000))
 end
 
@@ -137,7 +137,7 @@ function delaunay_elongation_moon(::IERS1996, t::Number)
 end
 
 """
-    delaunay_longitude_node(m::IERSConventions, t::Number)
+    delaunay_longitude_node(m::IERSModel, t::Number)
 
 Compute the longitude of the mean ascending node of the lunar orbit on th ecliptic, 
 measured from the mean equinox of date, in radians, given time `t` expressed in TDB Julian 
@@ -151,7 +151,7 @@ function delaunay_longitude_node(::IERSAModels, t::Number)
     )
 end
 
-function delaunay_longitude_node(::IERSConventions, t::Number)
+function delaunay_longitude_node(::IERSModel, t::Number)
     arcsec2rad(mod(450160.398036 - 6962890.5431t, 1296000))
 end
 

src/eop.jl

@@ -9,7 +9,7 @@
 # =========================================
 
 """
-    eop_δΔψ(m::IERSConventions, t::Number)
+    eop_δΔψ(m::IERSModel, t::Number)
 
 Interpolate and retrieve the EOP nutation correction in longitude `δΔψ`, in radians, 
 at time `t` expressed in `TT` Julian centuries since J2000 for the IERS convention `m`.
@@ -24,11 +24,11 @@ function eop_δΔψ(m::IERS1996, t::Number)
     return 0
 end
 
-eop_δΔψ(::IERSConventions, ::Number) = 0
+eop_δΔψ(::IERSModel, ::Number) = 0
 
 
 """
-    eop_δΔϵ(m::IERSConventions, t::Number)
+    eop_δΔϵ(m::IERSModel, t::Number)
 
 Interpolate and retrieve the EOP nutation correction in obliquity `δΔϵ`, in radians, 
 at time `t` expressed in `TT` Julian centuries since J2000 for the IERS convention `m`.
@@ -43,11 +43,11 @@ function eop_δΔϵ(m::IERS1996, t::Number)
     return 0
 end
 
-eop_δΔϵ(::IERSConventions, ::Number) = 0
+eop_δΔϵ(::IERSModel, ::Number) = 0
 
 
 """
-    eop_δX(m::IERSConventions, t::Number)
+    eop_δX(m::IERSModel, t::Number)
 
 Interpolate and retrieve the CIP `δX` correction, in radians, at time `t` expressed in 
 `TT` Julian centuries since J2000 for the IERS convention `m`.
@@ -62,11 +62,11 @@ function eop_δX(m::IERS1996, t::Number)
     return 0
 end
 
-eop_δX(::IERSConventions, ::Number) = 0
+eop_δX(::IERSModel, ::Number) = 0
 
 
 """
-    eop_δY(m::IERSConventions, t::Number)
+    eop_δY(m::IERSModel, t::Number)
 
 Interpolate and retrieve the CIP `δY` correction, in radians, at time `t` expressed in 
 `TT` Julian centuries since J2000 for the IERS convention `m`.
@@ -81,16 +81,16 @@ function eop_δY(m::IERS1996, t::Number)
     return 0
 end
 
-eop_δY(::IERSConventions, ::Number) = 0
+eop_δY(::IERSModel, ::Number) = 0
 
 
 """
-    eop_xp(m::IERSConventions, t::Number)
+    eop_xp(m::IERSModel, t::Number)
 
 Interpolate and retrieve the pole `xₚ` coordinate, in radians, at time `t` expressed in 
 `TT` Julian centuries since J2000 for the IERS convention `m`.
 """
-function eop_xp(m::IERSConventions, t::Number)
+function eop_xp(m::IERSModel, t::Number)
     # TODO: complete me
     return 0
 end
@@ -99,12 +99,12 @@ eop_xp(::CPND, ::Number) = 0
 
 
 """
-    eop_yp(m::IERSConventions, t::Number)
+    eop_yp(m::IERSModel, t::Number)
 
 Interpolate and retrieve the pole `yₚ` coordinate, in radians, at time `t` expressed in 
 `TT` Julian centuries since J2000 for the IERS convention `m`.
 """
-function eop_yp(m::IERSConventions, t::Number)
+function eop_yp(m::IERSModel, t::Number)
     # TODO: complete me
     return 0
 end
@@ -140,7 +140,7 @@ end
 # =========================================
 
 # Function to convert nutation corrections to CIP corrections and viceversa
-function δnut_to_δcip(m::IERSConventions, t::Number, δΔψ::Number, δΔϵ::Number)
+function δnut_to_δcip(m::IERSModel, t::Number, δΔψ::Number, δΔϵ::Number)
 
     # Compute the precession angles 
     ϵ₀, ψₐ, _, χₐ = precession_angles_rot4(m, t)
@@ -159,7 +159,7 @@ function δnut_to_δcip(m::IERSConventions, t::Number, δΔψ::Number, δΔϵ::N
 
 end
 
-function δcip_to_δnut(m::IERSConventions, t::Number, δx::Number, δy::Number)
+function δcip_to_δnut(m::IERSModel, t::Number, δx::Number, δy::Number)
 
     # Compute the precession angles 
     ϵ₀, ψₐ, _, χₐ = precession_angles_rot4(m, t)