Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
567692b
Add Maven project, test helpers and jniast API check
timj Nov 12, 2026
71de54b
Add converter for C probe data
timj Nov 12, 2026
d4324dc
Port AstException, status codes and C number formatting
timj Nov 12, 2026
d3e84eb
Port AstObject and the attribute layer
timj Nov 12, 2026
11dfb97
Port Channel, native serialisation and KeyMap
timj Nov 12, 2026
33c9cf1
Port Mapping, UnitMap, ShiftMap and ZoomMap
timj Nov 12, 2026
312942b
Port WinMap, MatrixMap, PermMap and CmpMap
timj Nov 12, 2026
1ea2bfc
Make shared Mappings immutable as C does
timj Nov 12, 2026
6a69495
Port the generic Mapping algorithms
timj Nov 12, 2026
25bc6ed
Add transform-oracle and serialisation gates
timj Nov 12, 2026
a294238
Port ERFA and PAL
timj Nov 12, 2026
7763a43
Port wcslib projections, WcsMap and SphMap
timj Nov 12, 2026
51b909d
Port cminpack, PolyMap and PolyTran
timj Nov 12, 2026
b7971f0
Port SlaMap and TimeMap
timj Nov 12, 2026
2f77a60
Port Units
timj Nov 12, 2026
733881b
Port Axis and Frame
timj Nov 12, 2026
3e34587
Port FrameSet
timj Nov 12, 2026
544103e
Port Frame matching and conversion
timj Nov 12, 2026
9c3707b
Port SkyAxis and SkyFrame
timj Nov 12, 2026
19faf26
Port TimeFrame
timj Nov 13, 2026
40e0125
Port CmpFrame and FrameSet AppendAxes
timj Nov 13, 2026
ed5aed7
Translate the FrameSet, attribute and serialisation tests of CmpFrame
timj Nov 13, 2026
65fd520
Add bad-input and thread-copy tests
timj Nov 13, 2026
ced6cda
Record differences between the C library and the Rust port
timj Nov 13, 2026
16dd98c
Port FitsChan cards, FitsCard, FitsCardList, FitsCardValue, FitsMatch…
timj Nov 13, 2026
2acaa9b
Port FitsChan read dispatch and FitsNativeReader
timj Nov 13, 2026
4a1590c
Port FitsSpecTrans, FitsWcsMark, FitsWcsKeywords, FitsStore, FitsWcsR…
timj Nov 13, 2026
992b929
Add JMH transform benchmarks
timj Nov 13, 2026
be9095b
Close phase 1: API gate and report
timj Nov 13, 2026
5673d6f
Add phase 1 rulings and date the phase 1 report
timj Nov 13, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 4 additions & 3 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[codespell]
builtin = clear,rare
skip = ./reference,./target,./.git,*.json
# AST abbreviations (nin = number of inputs) and tool and annotation names
# (Error Prone, JUnit @AfterAll).
ignore-words-list = nin,errorprone,afterall
# AST abbreviations (nin = number of inputs), the FITS-WCS projection code COO
# (conical orthomorphic), and tool and annotation names (Error Prone, JUnit
# @AfterAll).
ignore-words-list = nin,coo,errorprone,afterall
66 changes: 66 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Build and test

on:
push:
branches:
- main
pull_request:

permissions:
contents: read

jobs:
# Compiles with Error Prone, runs Checkstyle, PMD and the tests, and checks
# formatting, on the JDK the build needs (21 to 26, see CLAUDE.md).
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7

# The tests read the C library's fixtures; the other submodules are
# only needed to regenerate committed files.
- name: Check out the C library submodule
run: git submodule update --init reference/starlink-ast

- name: Set up JDK 21
uses: actions/setup-java@v6
with:
distribution: temurin
java-version: "21"
cache: maven

- name: Build and test
run: mvn -B verify

# Builds with JDK 21 and runs the tests on another runtime: Java 8, the
# oldest the library supports, and Java 25. Elementary functions (Math.sin
# and friends) can differ in the last bit between runtimes.
runtime:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
runtime: ["8", "25"]
steps:
- uses: actions/checkout@v7

- name: Check out the C library submodule
run: git submodule update --init reference/starlink-ast

- name: Set up the Java ${{ matrix.runtime }} runtime
id: runtime
uses: actions/setup-java@v6
with:
distribution: temurin
java-version: ${{ matrix.runtime }}

# Set up last, so JAVA_HOME (which runs Maven) is JDK 21.
- name: Set up JDK 21
uses: actions/setup-java@v6
with:
distribution: temurin
java-version: "21"
cache: maven

- name: Test on Java ${{ matrix.runtime }}
run: mvn -B test -Djvm="${{ steps.runtime.outputs.path }}/bin/java"
165 changes: 165 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# astjava

A pure-Java port of the [Starlink AST](https://github.com/Starlink/ast) library for handling world coordinate systems.
Its public API, in package `uk.ac.starlink.ast`, matches that of jniast, the JNI interface to the C library that starjava uses, so applications can use it without native libraries.
Its behaviour follows the C library.

The library runs on Java 8 and later, and has no dependencies beyond the JDK.
It is licensed under the GNU Lesser General Public License, version 3 or later (see `LICENSE`).

## Status

The first phase is in progress: reading native AST dumps and FITS-WCS headers (including SIP distortions) into FrameSets, and transforming between pixel and sky coordinates.
The design is in `docs/superpowers/specs/2026-11-02-pure-java-ast-design.md`.

## Building and testing

The build needs JDK 21 to 26 and Maven 3.9 or later; the JAR it makes runs on Java 8.

git submodule update --init reference/starlink-ast
mvn verify

`mvn verify` compiles with Error Prone and runs Checkstyle, PMD, the tests and the formatting check.
`mvn test -Dtest=ZoomMapTest` runs one test class, and `mvn spotless:apply` formats the sources.
To run the tests on another Java runtime, such as Java 8, build as usual and name the runtime:

mvn test -Djvm=/path/to/jdk8/bin/java

## Test data

The tests read the C library's language-neutral fixtures and oracle files from the `reference/starlink-ast` submodule (`ast_tester/fixtures`), pinned to the commit the Rust port pins.
Expected values come from the C library only: the oracle files directly, and the C probe tables committed in the Rust port, converted to JSON under `src/test/resources/oracle`.

## Reference sources

| Submodule | Contents |
| --- | --- |
| `reference/starlink-ast` | The C library, the final reference for behaviour, and the test fixtures |
| `reference/starlink-ast-rs` | The Rust port, from which most of this library is ported |
| `reference/starjava` | starjava, whose jniast package defines the API to match |
Loading
Loading