Wakusei Planets documentation

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

The Sun, the planets and their moons as a clean line drawing, a shaded realistic drawing or a painted surface map, with real sizes, tilt and rotation, and the moons where they are at any date and time.

Install

npm install @johnmorrisdotca/wakusei-planets

Start here

• Getting startedPut a planet on a page, tilt it, and let the reader turn it, in about five minutes.

Entry points

Guides

How-to

• In a plain HTML page, from a CDNAdd a planet to any page with one script tag from jsDelivr or unpkg, and a shaded one the same way.
• With Vite or webpackImport 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 pageSet 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 AngularA component for each framework, with the browser-only import done where a server render never reaches it.
• Embed in an iframeShow a body in somebody else's page with one iframe and no script of your own.
• TypeScript and NodeDraw a body as an SVG string on a server, ask where a moon is, and use the types.
• Looks and bodiesThe looks, each body's own entry point, three.js, pictures and the budget that keeps the page light.
• The portrait builderPut any bodies of the solar system in one picture, arrange them, light them, and take the code or a saved picture.
• Moons and timeA planet with its moons where they are on a date and time, and time that runs fast.
• In your own three.js scenePut 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 conversionsPure coordinate rotations in degrees, with named frames and AU components.
• The Sun and Moon from a placePosition, sunrise and sunset, Moon rise, set and phase from a latitude and longitude, with suncalc 2's names and a better engine.
• TimeJulian dates, calendars, time scales, sidereal time and Mars time, in a few kilobytes with no dependencies.
• The stars you can see without a telescope5,080 stars to magnitude 6.0 with names, positions, proper motion, distance and colour, about 100 kB gzipped and no dependencies.
• The space viewThe 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 alongPut 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 spacecraftTen 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 closeThe 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 panEvery 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.
• Colouring sheets for childrenPrintable colouring sheets of the Sun, the planets and the big moons, with thick lines, the real colours and three facts, on A4 or US Letter, in English and Japanese, and the ready-made PDFs.
• Data filesDownload tables of bodies, orbits and spacecraft.
• Serve it yourselfRun a small JSON service on your own computer.

Explanation

• Why two packagesWhat wakusei-planets does and what chikyu-earth does, which one to install, and how they work alone and together.
• How it worksWhere the numbers come from, how a body is turned toward you and why a page of them stays light.
• ArchitectureHow the facts, the positions, the line drawing, the shaded look and the element fit together, and why the pure side runs anywhere.
• AccuracyHow far the planets' and moons' positions are from JPL Horizons, body by body, and how each was made.

Troubleshooting & FAQ

• TroubleshootingWhat to check when a body does not appear, looks plain or sits still.

Upgrading

• UpgradingWhat changed in each version that you must act on, and what is new that you may want.

• ChangelogMade from the source of @johnmorrisdotca/wakusei-planets 0.24.0.
• Every export on one pageapi.html
• The docs for language modelsllms.txt · llms-full.txt