mirror of
https://github.com/acamarata/moon-sighting.git
synced 2026-07-01 11:24:24 +00:00
4fdf221d96
Some checks failed
CI / Test (Node 20) (push) Failing after 33s
CI / Test (Node 22) (push) Failing after 28s
CI / Test (Node 24) (push) Failing after 31s
CI / Lint & Format (push) Failing after 25s
CI / TypeScript (push) Failing after 38s
CI / Pack check (push) Failing after 36s
CI / Coverage (push) Failing after 2s
* add Forgejo CI mirror and telemetry disclosure Mirrors .github/workflows/ci.yml to .forgejo/workflows/ for self-hosted runner on git.ariccamarata.com. Adds failure-reporting hook stub (server registration via nself sentry ci enable is a server-side step). Adds telemetry disclosure section to README. * add opt-in telemetry via @acamarata/telemetry (off by default) * chore: update lockfile for @acamarata/telemetry devDep * chore: fix prettier formatting on telemetry import
69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
# moon-sighting
|
|
|
|
[](https://www.npmjs.com/package/moon-sighting)
|
|
[](https://github.com/acamarata/moon-sighting/actions/workflows/ci.yml)
|
|
[](LICENSE)
|
|
|
|
High-accuracy lunar crescent visibility and moon sighting calculations for Node.js and browsers. Uses the JPL DE442S ephemeris with full IERS Earth orientation for sub-arcsecond topocentric Moon and Sun positions. Implements the Yallop (NAO TN 69) and Odeh (Experimental Astronomy 2006) criteria.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install moon-sighting
|
|
```
|
|
|
|
Then download the JPL kernel (31 MB, one-time):
|
|
|
|
```bash
|
|
npx moon-sighting download-kernels
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```ts
|
|
import { initKernels, getMoonSightingReport } from 'moon-sighting'
|
|
|
|
await initKernels()
|
|
|
|
const report = await getMoonSightingReport(new Date('2025-03-29'), {
|
|
lat: 51.5074, lon: -0.1278, elevation: 10
|
|
})
|
|
|
|
console.log(report.yallop.category) // 'A' — easily visible to the naked eye
|
|
console.log(report.odeh.zone) // 'A' — visible with naked eye
|
|
console.log(report.guidance)
|
|
```
|
|
|
|
Five functions work without any kernel (Meeus approximation, ~0.3° accuracy):
|
|
|
|
```ts
|
|
import { getMoonPhase, getMoonPosition, getMoonIllumination,
|
|
getMoonVisibilityEstimate, getMoon } from 'moon-sighting'
|
|
|
|
const phase = getMoonPhase()
|
|
console.log(phase.phaseName) // 'Waxing Crescent'
|
|
console.log(phase.illumination) // 14.3 (percent)
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Full documentation on the [GitHub Wiki](https://github.com/acamarata/moon-sighting/wiki):
|
|
|
|
- [Getting Started](https://github.com/acamarata/moon-sighting/wiki/Getting-Started)
|
|
- [API Reference](https://github.com/acamarata/moon-sighting/wiki/API-Reference)
|
|
- [Architecture](https://github.com/acamarata/moon-sighting/wiki/Architecture)
|
|
- [Crescent Visibility Criteria](https://github.com/acamarata/moon-sighting/wiki/Crescent-Visibility)
|
|
- [Ephemeris and Kernel Setup](https://github.com/acamarata/moon-sighting/wiki/Ephemeris)
|
|
|
|
## Related
|
|
|
|
- [nrel-spa](https://github.com/acamarata/nrel-spa): Pure JS solar position algorithm
|
|
- [pray-calc](https://github.com/acamarata/pray-calc): Islamic prayer times with dynamic angle algorithm
|
|
|
|
## License
|
|
|
|
MIT. See [LICENSE](LICENSE).
|
|
|
|
## Telemetry
|
|
|
|
This package supports optional, anonymous usage telemetry via [`@acamarata/telemetry`](https://github.com/acamarata/telemetry). It is **off by default**. See [TELEMETRY.md](https://github.com/acamarata/telemetry/blob/main/TELEMETRY.md) for what is collected and how to enable or disable it.
|