09079091ae
* 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
2.4 KiB
moon-cycle
Maps any JavaScript Date to the correct NASA moon phase image filename. Two algorithms: synodic-cycle mapping (708 images) and calendar-year mapping (8,760 images).
Not published to npm. The image dataset (~438 MB of hourly WebP photos from NASA's Scientific Visualization Studio) lives in this repository. Use CDN or clone.
Install
# Clone to get code and images together
git clone https://github.com/acamarata/moon-cycle.git
# Or add the code-only package via git
pnpm add github:acamarata/moon-cycle
Quick Start
import { cycleMonth, cdnUrl } from 'moon-cycle';
const filename = cycleMonth(); // e.g. "354.webp"
const url = cdnUrl(filename, 'mm', 256, 75);
// => 'https://cdn.jsdelivr.net/gh/acamarata/moon-cycle@main/mm-256-75/354.webp'
CommonJS:
const { cycleMonth, cdnUrl } = require('moon-cycle');
Documentation
Full reference: GitHub Wiki
Related
- nrel-spa: Pure JS NREL Solar Position Algorithm
- pray-calc: Islamic prayer times
- moon-sighting: Lunar crescent visibility
Acknowledgments
Moon phase imagery from NASA's Scientific Visualization Studio:
Ernie Wright (2023). Moon Phase and Libration, 2023 [Data set]. NASA Scientific Visualization Studio. https://svs.gsfc.nasa.gov/5187
Images are in the public domain per NASA's media usage guidelines.
License
MIT. See LICENSE for the full text.
Telemetry
This package supports optional, anonymous usage telemetry via @acamarata/telemetry. It is off by default. See TELEMETRY.md for what is collected and how to enable or disable it.