skymap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98d71fa1603df92409f0387d0f7d1d162de5ee8d5c332b8171ce019c2f54d684
-  data.tar.gz: 414e303a6a023f3ad4eb5d0937fd3aefbb5ad20ebb6f3bb095737cb290e17a8c
+  metadata.gz: 2a51ef1b61aec62bb35240049a14adc40f006027f59fc30178eb973791901094
+  data.tar.gz: 1f8a1488c057a526bf1eaa7f36cb24fa78fc903e0a957fd6c946a1189ddebad6
 SHA512:
-  metadata.gz: 6b00bb7e7fb4ff5d22e8948793fbd7a108fa64c56c0d5724cf9ab8cfc698fd99b5dccd14e5eb1dd6bcc3fbfd650b75574290b7a06db3b9653268f1c183325300
-  data.tar.gz: 12d6fb6e7000639230d6184a80939b1425bee1f3b4de886b19532b1bf23dbcd1b8128ce49f58012628fd1fdf49350bf9eabf9ffb62297a8a55f7b9d20414b5f8
+  metadata.gz: 3151561266fea54c8845be6747e32d511da079ff8f0616bed97d359e39cadeddcb72d46e79f9f94a3dd8bbd27f00dd7598db65ef2a008ee68366978c1993537d
+  data.tar.gz: 205fab1dc18044a3117bc7cdd291ff18aaf5c07e47cc77e72f306acbaf1166b2b34b0b0edacc8676340d6df8b6afe96e5e09f1ad6ed9d8e96966ab38a7b51ab4

data/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [0.2.0] - 2026-10-27
+
+### Added
+
+- `Skymap::Layers::ConstellationBoundaries` draws the boundaries between the
+  constellations as thin dashed lines, stopping at the horizon
+- `Skymap::Catalog::ConstellationBoundaries` gives the borders of the 88 IAU
+  constellations, in J2000 coordinates
+- `Skymap::Layers::Moon` draws the Moon with its phase, where it is in the sky,
+  from an ephemeris given with `ephem:`
+
+### Changed
+
+- The data of the constellations lives in `data/constellations/iau/`:
+  `data/constellations/iau.csv` is now `data/constellations/iau/lines.csv`
+
 ## [0.1.0] - 2026-10-05
 
 ### Added
@@ -29,6 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release to reserve the gem name on RubyGems.org
 
+[Unreleased]: https://github.com/rhannequin/skymap/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/rhannequin/skymap/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/rhannequin/skymap/compare/v0.0.1...v0.1.0
 [0.0.1]: https://github.com/rhannequin/skymap/releases/tag/v0.0.1
 [Astronoby]: https://github.com/rhannequin/astronoby

data/README.md

@@ -9,7 +9,7 @@ Skymap is a Ruby library for generating maps of the sky.
   <img
     src="https://raw.githubusercontent.com/rhannequin/skymap/main/sky_map.svg"
     width="480"
-    alt="The sky over Paris on September 24, 2026 at 22:00 UTC, with the stars and the constellation lines"
+    alt="The sky over Paris on September 24, 2026 at 22:00 UTC, with the stars, the constellation lines, the constellation boundaries and the Moon"
   >
 </p>
 
@@ -49,6 +49,9 @@ stars = Skymap::Catalog::Stars.new.to_a
 
 chart = Skymap::Chart.new(observer: observer, instant: instant, canvas: canvas)
 svg = chart.render(
+  Skymap::Layers::ConstellationBoundaries.new(
+    boundaries: Skymap::Catalog::ConstellationBoundaries.new
+  ),
   Skymap::Layers::ConstellationLines.new(
     lines: Skymap::Catalog::ConstellationLines.new,
     stars: stars
@@ -95,6 +98,16 @@ fewer stars:
 Skymap::Layers::Stars.new(stars: stars, magnitude_limit: 6)
 ```
 
+#### Constellation boundaries
+
+`Skymap::Layers::ConstellationBoundaries` draws the boundaries between the
+constellations as thin dashed lines, and stops the ones that cross the horizon
+at the edge of the sky. `Skymap::Catalog::ConstellationBoundaries` gives the
+borders of the 88 IAU constellations (see [Data sources](#data-sources)).
+
+Layers are drawn in the order they are given: put the boundaries first to draw
+them below the lines and the stars.
+
 #### Constellation lines
 
 `Skymap::Layers::ConstellationLines` draws the lines of the constellations.
@@ -120,6 +133,28 @@ end
 Skymap::Layers::ConstellationLines.new(lines: asterisms, stars: stars)
 ```
 
+#### Moon
+
+`Skymap::Layers::Moon` draws the Moon where it is in the sky, with its phase.
+The Moon is drawn upright, as the observer sees it from the ground, so a
+crescent over the western horizon is tilted as it is in the real sky. On the
+chart, this means the lit side does not always face the Sun's position.
+
+Astronoby needs an ephemeris to compute where the Moon is: download one once,
+load it and give it to the layer (see the
+[Astronoby documentation][astronoby-ephem] to pick one):
+
+```ruby
+Astronoby::Ephem.download(name: "inpop19a.bsp", target: "inpop19a.bsp")
+ephem = Astronoby::Ephem.load("inpop19a.bsp")
+
+Skymap::Layers::Moon.new(ephem: ephem)
+```
+
+The Moon is drawn larger than it is, as on most sky maps: at its true size it
+would be a dot as small as the faintest stars. Its radius is 3% of the radius
+of the sky. When the center of the Moon is below the horizon, it is left out.
+
 #### Cardinal directions
 
 `Skymap::Layers::CardinalDirections` labels the cardinal directions (N, E, S,
@@ -148,8 +183,8 @@ description of the VizieR service was published in 2000, A&AS 143, 23.
 
 ### Constellations
 
-`data/constellations/iau.csv` holds the lines of the 88 IAU constellations
-(Mensa and Microscopium have none), one row per segment:
+`data/constellations/iau/lines.csv` holds the lines of the 88 IAU
+constellations (Mensa and Microscopium have none), one row per segment:
 
 - `constellation`: the IAU abbreviation of the constellation.
 - `from_hr`, `to_hr`: the ends of the segment, as HR numbers of stars of
@@ -170,6 +205,46 @@ The file was transcribed once from the vector PDF of each map, by matching the
 ends of the lines drawn on the maps to the stars of the catalog, and checked
 against the maps. It is not regenerated by a script.
 
+### Constellation boundaries
+
+`data/constellations/iau/boundaries.csv` holds the borders between the 88 IAU
+constellations, one row per point of a border, in order:
+
+- `border`: the number of the border. Each border between two constellations
+  is listed once.
+- `constellations`: the IAU abbreviations of the two constellations the border
+  separates.
+- `right_ascension` (hours) and `declination` (degrees): the coordinates of
+  the point, in J2000. The borders of the constellations are straight lines of
+  right ascension and declination in B1875, and curves in J2000: there is a
+  point about every degree to follow them.
+
+The borders come from the [Catalogue of Constellation Boundary Data][vi49] by
+Davenhall and Leggett (VizieR VI/49), in the version of Bill J. Gray that
+lists the constellation on each side of a border. They are the boundaries
+defined by Delporte in 1930, in B1875 coordinates.
+
+> Davenhall, A. C., Leggett, S. K., 1989, _Catalogue of Constellation Boundary
+> Data_, Royal Observatory Edinburgh.
+
+The file is generated with `bin/build_boundaries`, which downloads the
+catalog from CDS, keeps each shared border once, adds the points along the
+borders and precesses them to J2000 with Astronoby.
+
+### Ephemeris of the tests
+
+The tests of the Moon use `spec/fixtures/de440s_moon_2025_2030_excerpt.bsp`, an
+excerpt of DE440s, the planetary and lunar ephemeris of the [Jet Propulsion
+Laboratory][jpl-ephemerides], distributed by [NAIF][naif]. It only keeps the
+Earth-Moon barycenter, the Sun, the Moon and the Earth, from 2025 to 2030. As
+NAIF asks for modified kernels, its comment area names this project as the
+last to modify it, and points to the original kernel. It is not part of the
+gem.
+
+> Park, R. S., Folkner, W. M., Williams, J. G., Boggs, D. H., 2021, _The JPL
+> Planetary and Lunar Ephemerides DE440 and DE441_, The Astronomical Journal,
+> 161, 105.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -212,5 +287,9 @@ rooms and mailing lists is expected to follow the
 [MIT License]: https://opensource.org/licenses/MIT
 [bsc5]: https://cdsarc.cds.unistra.fr/viz-bin/cat/V/50
 [vizier-doi]: https://doi.org/10.26093/cds/vizier
+[astronoby-ephem]: https://github.com/rhannequin/astronoby/blob/main/docs/ephem.md
 [oae-maps]: https://www.astro4edu.org/
+[vi49]: https://cdsarc.cds.unistra.fr/viz-bin/cat/VI/49
+[jpl-ephemerides]: https://ssd.jpl.nasa.gov/planets/eph_export.html
+[naif]: https://naif.jpl.nasa.gov/naif/rules.html
 [cc-by-4]: https://creativecommons.org/licenses/by/4.0/