Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onekiloparsec/SwiftAA
The most comprehensive collection of accurate astronomical algorithms in (C++, Objective-C and) Swift.
https://github.com/onekiloparsec/SwiftAA
algorithm astro astronomical-algorithms astronomy astrophysics cplusplus framework ios-sdk ios-swift macos-framework macos-swift objective-c orbital-mechanics swift swift-4
Last synced: about 1 month ago
JSON representation
The most comprehensive collection of accurate astronomical algorithms in (C++, Objective-C and) Swift.
- Host: GitHub
- URL: https://github.com/onekiloparsec/SwiftAA
- Owner: onekiloparsec
- License: mit
- Created: 2015-06-20T12:41:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-11T11:13:31.000Z (11 months ago)
- Last Synced: 2024-10-29T23:43:18.961Z (about 2 months ago)
- Topics: algorithm, astro, astronomical-algorithms, astronomy, astrophysics, cplusplus, framework, ios-sdk, ios-swift, macos-framework, macos-swift, objective-c, orbital-mechanics, swift, swift-4
- Language: C++
- Homepage: http://www.onekiloparsec.dev/
- Size: 33.9 MB
- Stars: 172
- Watchers: 16
- Forks: 31
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
SwiftAA •
aa-js •
QLFits •
FITSImporter •
ObjCFITSIO
SwiftAA
============
[](https://travis-ci.org/onekiloparsec/SwiftAA/)
[](https://codecov.io/gh/onekiloparsec/SwiftAA)
[](https://github.com/onekiloparsec/SwiftAA)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fonekiloparsec%2FSwiftAA?ref=badge_shield)
*The most comprehensive collection of accurate astronomical algorithms, in C++ and Swift, all in one place.*
*(Available through all distribution mechanisms: Swift Package Manager, Cocoapods and Carthage.)*
Other implementations: [JavaScript (aa-js)](https://github.com/onekiloparsec/aa-js), [C# (AASharp)](https://github.com/jsauve/AASharp).
Description
=======
SwiftAA provides everything you need to build our Solar System, compute length of seasons, moon phases, determine rise, transit and set times, get positions of large planetary moons, transform coordinates, determine physical details of planets, their illumination, distance etc. With a professional-grade accuracy.
**SwiftAA is already used in production apps.** In particular,
[MeteorActive](https://itunes.apple.com/us/app/meteoractive/id1205712190?mt=8), a carefully crafted iOS app to get
everything about meteors.
SwiftAA is first built with a C(++) layer atop the C++ implementation by P.J. Naughter of the reference textbook
*Astronomical Algorithms*, by Jean Meeus (2nd ed., [Amazon](https://www.amazon.com/Astronomical-Algorithms-Jean-Meeus/dp/0943396611/ref=sr_1_1?ie=UTF8&qid=1506016222&sr=8-1&keywords=astronomical+algorithms+jean+meeus)). This C++ package is called **AA+** (see below). AA+ also includes additional algorithms of the
[VSOP87](https://en.wikipedia.org/wiki/VSOP_(planets)) framework, and includes the complete support for the ELP/MPP02 theory.
Thus, SwiftAA, thanks to AA+, is the most complete and accurate collection of algorithms for all things astronomical in Swift.
But **SwiftAA provides more modern and a lot more readable APIs**, taking advantage of the expressiveness of Swift and its various syntax elements, making it fun and easy of use. In fact, you simply can't use AA+ without having the AA book. While SwiftAA is precisely made to be accessible by anyone. Additional functions and algorithms are added to improve even more the completeness and ease of use. In particular, **SwiftAA provides units safety** a lot stronger compared to C++ APIs.
Moreover, **SwiftAA has a much larger unit tests coverage** (>90% for the Swift code!). In fact, unit tests are being carefully written with data directly taken from Jean Meeus' textbook, AA+ own tests, [USNO](http://www.usno.navy.mil), [SkySafari](https://skysafariastronomy.com) and [Xephem](http://www.clearskyinstitute.com/xephem/) (and thus trying to achieve a probably hypothetical consistency between these sources).
Documentation
=======
The documentation generated from the code itself is available at [http://onekiloparsec.github.io/SwiftAA](http://onekiloparsec.github.io/SwiftAA).
Installation
============
Using the [Swift Package Manager](https://swift.org/package-manager/): either through Xcode > File > Swift Packages > Add Package Dependency... and enter this repo URL (including the `.git` extension), , then choose `SwiftAA` target. Or add the line `.package(url: "https://github.com/onekiloparsec/SwiftAA.git", from: "3.0.0")` in the `dependencies` section of your `Package.swift` file.
Using [Carthage](https://github.com/Carthage/Carthage): add `github "onekiloparsec/SwiftAA"` to your `Cartfile`, then run `carthage update`, and finally add the newly built `SwiftAA-macOS.framework` or `SwiftAA-iOS.framework` into your project (in `embedded binaries`).
Using [CocoaPods](http://cocoapods.org/): add `pod 'SwiftAA'` to your `Podfile` and then run `pod update`.
Notes
============
AABridge
---
The `AABridge` library is simply a bridge between the C++ codebase provided by `AA+` and the Swift code in `SwiftAA`. It's implemented entirely in C. It's recommended that you use either the `A++` C++ code directly or the `SwiftAA` Swift wrapper.
For a long time, all the C++, (Objective-)C(++) and Swift code was bundled together. But in order to distribute SwiftAA through the SPM, it was necessary to split the sources into seperate folders. Then, three different libraries were declared in the `Package.swift` file and built separatedly, each of them depending on the previous one (`AA+`, then `AABridge`, and finally `SwiftAA`).
During that evolution, we chose to create a specific `AABridge` target inside the Xcode project. The consequence is that `AABridge` must be imported in `SwiftAA` source files that need it. Not a big deal, expect for Cocoapods which doesn't understand the subtelty. Hence, we created a specific `AABridge` pod, which will follow the versioning numbers of the main package.
In summary, we have:
* Three targets available through the Swift Package Manager: `AA+`, `AABridge` and `SwiftAA`. Embed only the last level you intend to use in your project.
* Three targets available through Carthage, inside the Xcode project: `AABridge` (including `AA+`), `SwiftAA-iOS` and `SwiftAA-macOS`.
* Two pods available through Cocoapods: `AABridge` and `SwiftAA`.
AA+
---
The AA+ framework, written in C++ by PJ Naughter (Visual C++ MVP) is certainly the best and most complete implementation of the "Astronomical Algorithms", found in the reference textbook by Jean Meeus. To make the most of this code specifically, you have to have a copy of the book with you (APIs and method names are hardly understandable without knowing what they refer to).
Pull requests are accepted only about the C(++) and Swift code. The AA+ code changes must be directed (as I will personnaly do if I need to) to the original source (see the [AA+ website](http://www.naughter.com/aa.html)).
Today's version of AA+ used in SwiftAA is 2.50 (released 16 April 2023).
Caution on Coordinates
-----
The coordinates computations are key for modern astronomy. However, there is no mention to modern conventions (like ICRS) in the textbook of Jean Meeus, therefore in the AA+ code. Awaiting for such improvement, any user wanting to compute coordinates transformations should be careful. For a good example of a complete implementation of such transformations, see the
[AstroPy excellent package](http://docs.astropy.org/en/stable/coordinates/index.html).
Prefixes & Conventions
----
Needless to say how different the syntax is between C, C++, Objective-C and Swift. The main guideline in writting SwiftAA was to build a C(++) layer that follow *strictly* the methods and interfaces of the underlying C++ library. Only the name of some variables were a bit "Objective-C-fied" (to avoid prefix them with the one-letter type, 'b' for boolean etc').
As C lacks namespaces, everything must be prefixed. It is a convention to use 3-letters prefixes in Objective-C. KPC stands for "kiloparsec" and is "my" usual prefix. I chose to keep the AA prefix that belongs to the C++ library as well. Hence the (rather long) 5-letters *KPCAA* prefix of all methods.
The constraint of having an C layer first comes from the fact that no C++ code can be written directly alongside Swift code (in the same file). And Swift doesn't have the header/implementation split into different files. Hence one must write a Objective-C++/C wrapper around it, with name prefixes. Additionally, this codebase is compatible with Swift on Linux, and Objective-C is largely unavailable there - and thus the `AABridge` layer is built in C.
Branches
----
For Swift4, see the `swift4` branch. Likewise for Swift3 (unmaintained).
Author
======
Cédric Foellmi, a.k.a. **[@onekiloparsec](https://twitter.com/onekiloparsec)** ([website](https://onekiloparsec.dev)).
(Ph.D. in astrophysics, and former *support astronomer* at the [European Southern Observatory](http://www.eso.org) in Chile).
I am the author of the app iObserve (for [macOS](http://onekiloparsec.dev/iobserve) (and formerly in [iOS/iPad]) and [arcsecond.io](https://www.arcsecond.io).
Support
=======
You can help me spend more time on Open-Source software for astronomers by supporting me on Patreon!
Licence
=======
The licence of this software is the [MIT](http://opensource.org/licenses/MIT) licence, which allows you to use it freely in open-source or commercial products. But it does not apply to the AA+ Framework, which retains its own licence. Quoting the [original](http://www.naughter.com/aa.html):
**AA+ Copyright :**
* You are allowed to include the source code in any product (commercial, shareware, freeware or otherwise) when your product is released in binary form.
* You are allowed to modify the source code in any way you want except you cannot modify the copyright details at the top of each module.
* If you want to distribute source code with your application, then you are only allowed to distribute versions released by the author. This is to maintain a single distribution point for the source code.
## FOSSA
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fonekiloparsec%2FSwiftAA?ref=badge_large)