Skip to content

Commit

Permalink
📚 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ronisbr committed Jan 1, 2025
1 parent e36a786 commit d5d8aef
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/src/man/orbit_representations.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,9 @@ only one *of date* frame, the first signature is used and the Julian Day `jd_utc
the epoch of this frame. On the other hand, if the origin and destination frame contain two
*of date* frame[^1], e.g. TOD => MOD, the second signature must be used in which the Julian
Day `jd_utco` [UTC] is the epoch of the origin frame and the Julian Day `jd_utcf` [UTC] is
the epoch of the destination frame. The algorithm might also require the Earth Orientation
Parameters (EOP) `eop` depending on the source and destination frames.
the epoch of the destination frame. If the epochs are not provided, the algorithm will use
the epoch of the orbit state vector `sv` (`sv.t`). The algorithm might also require the
Earth Orientation Parameters (EOP) `eop` depending on the source and destination frames.

The specification about the origin and destination frames, as well as the requirements for
the EOP data, are the same as described for the [`r_eci_to_eci`](@ref) function.
Expand Down
5 changes: 3 additions & 2 deletions src/orbit/sv_eci_to_eci.jl
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ only one *of date* frame, the first signature is used and the Julian Day `jd_utc
the epoch of this frame. On the other hand, if the origin and destination frame contain two
*of date* frame`¹`, e.g. TOD => MOD, the second signature must be used in which the Julian
Day `jd_utco` [UTC] is the epoch of the origin frame and the Julian Day `jd_utcf` [UTC] is
the epoch of the destination frame. The algorithm might also require the Earth Orientation
Parameters (EOP) `eop` depending on the source and destination frames.
the epoch of the destination frame. If the epochs are not provided, the algorithm will use
the epoch of the orbit state vector `sv` (`sv.t`). The algorithm might also require the
Earth Orientation Parameters (EOP) `eop` depending on the source and destination frames.
!!! note
Expand Down

0 comments on commit d5d8aef

Please sign in to comment.