Skip to content

README.md

Latest commit

 

History

History
101 lines (75 loc) · 3.64 KB

README.md

File metadata and controls

101 lines (75 loc) · 3.64 KB
Raw

SOFA.jl

Stable Dev

Test codecov Aqua QA License: MIT

A pure Julia implementation of the IAU SOFA library for fundamental astronomy. For the wrapper of the SOFA C library, see the v1.x releases maintained on the release-1.x branches.

Description

This package provides a pure Julia implementation of the SOFA library of fundamental astronomical functions, originally developed by Paul Barrett as the SOFA submodule of Astrometry.jl. No compiled C library is required.

The SOFA C test suite is reproduced as part of the package to prove compliance and reproducibility of the core SOFA functionality.

Package Version <-> SOFA Release Correspondence

The planned package versions below correspond to the following releases of the SOFA C Library:

Package Version SOFA Release build
v2.0 2023-10-11 pure Julia
v1.5 2023-10-11 jll
v1.4 2021-05-12 jll
v1.3 2021-01-25_a jll
v1.2 2020-07-21 jll
v1.1 2019-07-22 jll
v1.0 2019-07-22 manual
v0.1 2018-01-30 manual

Notes

  1. All computed values are returned by the function call. No values are returned by reference.
  2. As of v2.0, function names follow the SOFA names without the iau prefix (e.g. cal2jd instead of iauCal2jd).

Dev docs

List available tests:

julia> using Pkg

julia> Pkg.test("SOFA"; test_args = `--list`)
Available tests:
 - spacemotion
 - ephemerides
 - astrometry
 - starcatalogs
 - gnomonic
 - galactic
 - calendars
 - precession
 - vectorops
 - rotations
 - doctest
 - equatorial
 - ecliptic
 - aqua
 - timescales
 - geocentric
 - coefficients

Run single test (partial matches supported):

julia> Pkg.test("SOFA"; test_args = `--verbose spacem`)
                  │   Test   │   Init   │ Compile │ ──────────────── CPU ──────────────── │
Test     (Worker) │ time (s) │ time (s) │   (%)   │ GC (s) │ GC % │ Alloc (MB) │ RSS (MB) │
spacemotion   (1) │        started at 2026-07-22T01:54:00.660
spacemotion   (1) │     1.86 │     3.21 │   99.70 │   0.03 │  1.6 │     217.08 │   456.26 │

Test Summary:   | Pass  Total  Time
  Overall       |    3      3  7.1s
    spacemotion |    3      3  1.8s
    SUCCESS
     Testing SOFA tests passed

Run documentation (assuming LiveServer.jl is in your global environment):

> julia --proj=docs/

julia> using LiveServer

julia> servedocs(include_dirs = ["src"])

Compliance with SOFA License

This distribution is permitted and compliant with the SOFA license. See the LICENSE for details.

This package is derived from, but is not an official product of, the International Astronomical Union SOFA collection (http://www.iausofa.org), and is not endorsed by the IAU SOFA Board.