# Wakusei Planets 惑星 — The Sun, planets and moons for the web

> Wakusei Planets 惑星 — The Sun, planets and moons for the web: each as a clean line drawing, a shaded realistic drawing or a painted surface map, with real sizes, axial tilt and rotation as data, and positions of the moons for any date and time. SVG for the lines, three.js (optional) for the rest.

Install with `npm install @johnmorrisdotca/wakusei-planets`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/wakusei-planets/docs/. The examples on the reference pages are run when the site is built, and what they print is shown under them.

## Guides

- [Getting started](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/getting-started.md): Put a planet on a page, tilt it, and let the reader turn it, in about five minutes.
- [In a plain HTML page, from a CDN](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/html-and-cdn.md): Add a planet to any page with one script tag from jsDelivr or unpkg, and a shaded one the same way.
- [With Vite or webpack](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/bundlers.md): Import the element in a bundled app, pick only the bodies you need, and keep three.js out of a page of line drawings.
- [Put it in your page](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/put-it-in-your-page.md): Set up a body in the demo, then copy working code for plain HTML, an ES module, React, Vue, Angular, Svelte or an iframe.
- [In React, Vue, Svelte and Angular](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/frameworks.md): A component for each framework, with the browser-only import done where a server render never reaches it.
- [Embed in an iframe](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/embed-in-an-iframe.md): Show a body in somebody else's page with one iframe and no script of your own.
- [TypeScript and Node](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/typescript-and-node.md): Draw a body as an SVG string on a server, ask where a moon is, and use the types.
- [Looks and bodies](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/looks-and-bodies.md): The looks, each body's own entry point, three.js, pictures and the budget that keeps the page light.
- [The portrait builder](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/portrait-builder.md): Put any bodies of the solar system in one picture, arrange them, light them, and take the code or a saved picture.
- [Moons and time](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/moons-and-time.md): A planet with its moons where they are on a date and time, and time that runs fast.
- [In your own three.js scene](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/in-your-own-scene.md): Put the real Sun, planets, Pluto and moons into a three.js scene you already have, lit from any direction, with chikyu-earth's space view as the example.
- [Coordinate conversions](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/coordinates.md): Pure coordinate rotations in degrees, with named frames and AU components.
- [The Sun and Moon from a place](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/suncalc.md): Position, sunrise and sunset, Moon rise, set and phase from a latitude and longitude, with suncalc 2's names and a better engine.
- [Time](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/time.md): Julian dates, calendars, time scales, sidereal time and Mars time, in a few kilobytes with no dependencies.
- [The stars you can see without a telescope](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/stars.md): 5,080 stars to magnitude 6.0 with names, positions, proper motion, distance and colour, about 100 kB gzipped and no dependencies.
- [The space view](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/space-view.md): The Earth, the Moon, the Sun and the planets in their places for any date, with the Moon's phase and the Earth's day side coming from the real Sun. Two scales, time both ways, a zoom from the Earth out to the whole solar system.
- [Riding along](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/ride-along.md): Put the camera on a moving point, a moon, a planet or anything of your own, and look at the body it goes round, straight down or at the horizon, for any body by its radius.
- [Famous spacecraft](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/spacecraft.md): Ten famous spacecraft, from Pioneer 10 to the Webb telescope: facts, the events of the voyage, and where each one is on any date, fitted to JPL Horizons. Each craft is a table of its own, 2 to 127 kB gzipped.
- [What is nearby, and when bodies come close](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/nearest.md): The bodies nearest to a body on a date, by angle in the sky or distance in space, and the moments two bodies come closest, checked against JPL Horizons to seconds of time.
- [Zoom and pan](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/zoom-and-pan.md): Every view in the package zooms and moves with a drag, a pinch, the wheel and the keys, with no controls on the page. The zoom range of each element, why each ends where it does, and how to turn the hands off or add the family's bar.
- [Data files](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/data-files.md): Download tables of bodies, orbits and spacecraft.
- [Serve it yourself](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/serve-it-yourself.md): Run a small JSON service on your own computer.
- [Why two packages](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/two-packages.md): What wakusei-planets does and what chikyu-earth does, which one to install, and how they work alone and together.
- [How it works](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/how-it-works.md): Where the numbers come from, how a body is turned toward you and why a page of them stays light.
- [Architecture](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/architecture.md): How the facts, the positions, the line drawing, the shaded look and the element fit together, and why the pure side runs anywhere.
- [Accuracy](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/accuracy.md): How far the planets' and moons' positions are from JPL Horizons, body by body, and how each was made.
- [Troubleshooting](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/troubleshooting.md): What to check when a body does not appear, looks plain or sits still.
- [Upgrading](https://johnmorrisdotca.github.io/wakusei-planets/docs/guides/upgrading.md): What changed in each version that you must act on, and what is new that you may want.

## Reference

- [@johnmorrisdotca/wakusei-planets/element](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/element/index.md): The <wakusei-body> element
- [@johnmorrisdotca/wakusei-planets/portrait](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/portrait/index.md): The <wakusei-portrait> element: many bodies in one scene
- [@johnmorrisdotca/wakusei-planets/space](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/space/index.md): Where the Sun, Moon and planets are for a date, in two scales, with the camera maths
- [@johnmorrisdotca/wakusei-planets/space/element](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/space-element/index.md): The <wakusei-space> element: the Earth, Moon, Sun and planets in their places
- [@johnmorrisdotca/wakusei-planets/time](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/time/index.md): Julian dates (and the julian package's functions), calendars, time scales, sidereal time and Mars time
- [@johnmorrisdotca/wakusei-planets/stars](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/stars/index.md): The 5,080 stars you can see without a telescope: names, positions, proper motion, distance and colour (about 100 kB gzipped)
- [@johnmorrisdotca/wakusei-planets/nearest](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/nearest/index.md): The bodies nearest to a body on a date, in the sky or in space, and when two bodies come closest: nearest, within, closestApproach and conjunctions
- [@johnmorrisdotca/wakusei-planets/spacecraft](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/spacecraft/index.md): Ten famous spacecraft (Voyager, New Horizons, Pioneer, Cassini, Galileo, Juno, Parker Solar Probe, Webb): facts, events, and where each is at any date from launch to the end of its record
- [@johnmorrisdotca/wakusei-planets/suncalc](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/suncalc/index.md): The Sun and Moon from a place: position, sunrise and sunset, Moon rise, set and phase, with suncalc 2's names and a better engine
- [@johnmorrisdotca/wakusei-planets/suncalc/legacy](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/suncalc-legacy/index.md): The same, with suncalc 1's conventions (radians, azimuth from south)
- [@johnmorrisdotca/wakusei-planets/tables](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/tables/index.md): Every dwarf planet's fitted position table (Ceres and the seven slower ones) and the moon theories for Jupiter's and Saturn's moons, so heliocentric and moonVector are as close as the accuracy guide says
- [@johnmorrisdotca/wakusei-planets/tables/ceres](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/tables-ceres/index.md): Ceres's fitted position table, 1900 to 2100 (about 14 kB gzipped)
- [@johnmorrisdotca/wakusei-planets/tables/dwarfs](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/tables-dwarfs/index.md): The fitted position tables of Orcus, Haumea, Quaoar, Makemake, Gonggong, Eris and Sedna, 1800 to 2200 (about 5 kB gzipped)
- [@johnmorrisdotca/wakusei-planets/tables/vsop](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/tables-vsop/index.md): Finer VSOP87B series for Mercury to Neptune, within 2 arc-seconds of Horizons on 60 dates from 1800 to 2200 (about 32 kB gzipped; not in ./tables)
- [@johnmorrisdotca/wakusei-planets/tables/galilean](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/tables-galilean/index.md): Io, Europa, Ganymede and Callisto from the theory L1.2 (Lainey, Duriez and Vienne), 1130 to 2760 (about 5 kB gzipped)
- [@johnmorrisdotca/wakusei-planets/tables/saturn-moons](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/tables-saturn-moons/index.md): Mimas, Enceladus, Tethys, Dione, Rhea, Titan and Iapetus from the theory TASS1.7 (Vienne and Duriez) (about 7 kB gzipped)
- [@johnmorrisdotca/wakusei-planets/look](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/look/index.md): How a body is drawn with three.js
- [@johnmorrisdotca/wakusei-planets/painter](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/painter/index.md): Bodies as objects for your own three.js scene
- [@johnmorrisdotca/wakusei-planets/all](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/all/index.md): Every body's shaded look
- [@johnmorrisdotca/wakusei-planets/sun](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/sun/index.md): The Sun's shaded look
- [@johnmorrisdotca/wakusei-planets/mercury](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/mercury/index.md): Mercury's shaded look
- [@johnmorrisdotca/wakusei-planets/venus](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/venus/index.md): Venus's shaded look
- [@johnmorrisdotca/wakusei-planets/mars](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/mars/index.md): Mars's shaded look
- [@johnmorrisdotca/wakusei-planets/jupiter](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/jupiter/index.md): Jupiter's shaded look
- [@johnmorrisdotca/wakusei-planets/saturn](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/saturn/index.md): Saturn's shaded look
- [@johnmorrisdotca/wakusei-planets/uranus](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/uranus/index.md): Uranus's shaded look
- [@johnmorrisdotca/wakusei-planets/neptune](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/neptune/index.md): Neptune's shaded look
- [@johnmorrisdotca/wakusei-planets/pluto](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/pluto/index.md): Pluto's shaded look
- [@johnmorrisdotca/wakusei-planets/dwarfs](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/dwarfs/index.md): The dwarf planets: shaded looks (Ceres, Orcus, Haumea, Quaoar, Makemake, Gonggong, Eris, Sedna)
- [@johnmorrisdotca/wakusei-planets/moons-earth](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-earth/index.md): The Moon's shaded look
- [@johnmorrisdotca/wakusei-planets/moons-mars](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-mars/index.md): Phobos and Deimos: shaded looks
- [@johnmorrisdotca/wakusei-planets/moons-jupiter](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-jupiter/index.md): The Galilean moons: shaded looks
- [@johnmorrisdotca/wakusei-planets/moons-saturn](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-saturn/index.md): Saturn's moons: shaded looks
- [@johnmorrisdotca/wakusei-planets/moons-uranus](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-uranus/index.md): Uranus's moons: shaded looks
- [@johnmorrisdotca/wakusei-planets/moons-neptune](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-neptune/index.md): Neptune's moons: shaded looks
- [@johnmorrisdotca/wakusei-planets/moons-pluto](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-pluto/index.md): Pluto's moons: shaded looks
- [@johnmorrisdotca/wakusei-planets/moons-dwarf](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/moons-dwarf/index.md): The dwarf planets' moons: shaded looks (Vanth, Hiʻiaka, Namaka, Dysnomia)
- [@johnmorrisdotca/wakusei-planets/earth](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/earth/index.md): The Earth, drawn by chikyu-earth
- [@johnmorrisdotca/wakusei-planets/coordinates](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/coordinates/index.md): Pure coordinate conversions
- [@johnmorrisdotca/wakusei-planets](https://johnmorrisdotca.github.io/wakusei-planets/docs/api/main/index.md): Facts, line drawings and positions

## Optional

- [Changelog](https://johnmorrisdotca.github.io/wakusei-planets/docs/changelog.md): every release
- [Every export, in full](https://johnmorrisdotca.github.io/wakusei-planets/llms-full.txt)
- [Source](https://github.com/johnmorrisdotca/wakusei-planets)