starplot 0.18.3__py2.py3-none-any.whl → 0.19.2__py2.py3-none-any.whl

starplot/__init__.py

@@ -1,36 +1,42 @@
+# ruff: noqa: F401,F403
+
 """Star charts and maps of the sky"""
 
-__version__ = "0.18.3"
+__version__ = "0.19.2"
 
-from .base import BasePlot  # noqa: F401
-from .map import MapPlot  # noqa: F401
-from .horizon import HorizonPlot  # noqa: F401
-from .optic import OpticPlot  # noqa: F401
-from .zenith import ZenithPlot  # noqa: F401
+from .plots import (
+    MapPlot,
+    HorizonPlot,
+    OpticPlot,
+    ZenithPlot,
+)
 from .models import (
-    DSO,  # noqa: F401
-    DsoType,  # noqa: F401
-    Star,  # noqa: F401
-    Constellation,  # noqa: F401
-    Comet,  # noqa: F401
-    Planet,  # noqa: F401
-    Moon,  # noqa: F401
-    Sun,  # noqa: F401
-    ObjectList,  # noqa: F401
-    Scope,  # noqa: F401
-    Binoculars,  # noqa: F401
-    Reflector,  # noqa: F401
-    Refractor,  # noqa: F401
-    Camera,  # noqa: F401
-    Satellite,  # noqa: F401
-    Observer,  # noqa: F401
+    DSO,
+    DsoType,
+    Star,
+    Constellation,
+    ConstellationBorder,
+    Comet,
+    Planet,
+    Moon,
+    Sun,
+    ObjectList,
+    Scope,
+    Binoculars,
+    Reflector,
+    Refractor,
+    Camera,
+    Satellite,
+    Observer,
+    MilkyWay,
 )
-from .data import Catalog  # noqa: F401 F403
-from .styles import *  # noqa: F401 F403
-from .projections import *  # noqa: F401 F403
-from .config import settings  # noqa: F401
+from .data import Catalog
+from .styles import *
+from .projections import *
+from .config import settings
+from .plotters.text import CollisionHandler
 
-from ibis import _  # noqa: F401 F403
+from ibis import _
 
 
 import contextlib

starplot/config.py

@@ -13,6 +13,14 @@ def _get_path(var_name, default) -> Path:
     return _get
 
 
+def _get_boolean(var_name, default) -> bool:
+    def _get():
+        value = os.environ.get(var_name)
+        return default if not value else bool(value.lower() == "true")
+
+    return _get
+
+
 class SvgTextType(str, Enum):
     PATH = "path"
     ELEMENT = "element"
@@ -64,5 +72,8 @@ class Settings:
     **🌐 Want to see another language available? Please help us add it! [Details here](https://github.com/steveberardi/starplot/tree/main/data/raw/translations).**
     """
 
+    debug: bool = field(default_factory=_get_boolean("STARPLOT_DEBUG", False))
+    """Global setting for debug mode. When this is enabled, Starplot will log debugging information and plot polygons for debugging text issues"""
+
 
 settings = Settings()

starplot/data/__init__.py

@@ -1,9 +1,11 @@
+# ruff: noqa: F401,F403
+
 from pathlib import Path
 
 from skyfield.api import Loader
 
 from starplot.config import settings
-from .catalogs import Catalog  # noqa: F401
+from .catalogs import Catalog
 
 load = Loader(settings.data_path)  # used for loading ephemeris
 
@@ -16,9 +18,5 @@ INTERNAL_DATA_PATH = HERE / "library"
 
 class DataFiles:
     STAR_DESIGNATIONS = INTERNAL_DATA_PATH / "star_designations.parquet"
-
     CONSTELLATION_NAMES = INTERNAL_DATA_PATH / "constellation_names.parquet"
-
     DSO_NAMES = INTERNAL_DATA_PATH / "dso_names.parquet"
-
-    DATABASE = INTERNAL_DATA_PATH / "sky.db"

starplot/data/catalogs.py

@@ -290,51 +290,61 @@ class Catalog:
 # --------------------------------------------------------
 
 BIG_SKY = Catalog(
-    path=settings.data_path / "stars.bigksy.0.1.2.mag16.parquet",
-    url="https://github.com/steveberardi/starplot-bigsky/releases/download/v0.1.1/stars.bigksy.0.1.1.mag16.parquet",
+    path=settings.data_path / "stars.bigksy.0.1.3.mag16.parquet",
+    url="https://github.com/steveberardi/starplot-bigsky/releases/download/v0.1.3/stars.bigksy.0.1.3.mag16.parquet",
 )
 """
 [Big Sky Catalog](https://github.com/steveberardi/bigsky) ~ 2.5M stars
 
-This is the full version of the Big Sky Catalog, which includes 2,557,500 stars from Hipparcos, Tycho-1, and Tycho-2.
+This is the full version of the Big Sky Catalog, which includes 2,557,501 stars from Hipparcos, Tycho-1, and Tycho-2.
 """
 
 BIG_SKY_MAG11 = Catalog(
-    path=settings.data_path / "stars.bigksy.0.1.2.mag11.parquet",
-    url="https://github.com/steveberardi/starplot-bigsky/releases/download/v0.1.1/stars.bigksy.0.1.1.mag11.parquet",
+    path=settings.data_path / "stars.bigksy.0.1.3.mag11.parquet",
+    url="https://github.com/steveberardi/starplot-bigsky/releases/download/v0.1.3/stars.bigksy.0.1.3.mag11.parquet",
 )
 """
-[Big Sky Catalog](https://github.com/steveberardi/bigsky) ~ 983,822 stars with limiting magnitude 11
+[Big Sky Catalog](https://github.com/steveberardi/bigsky) ~ 983,823 stars with limiting magnitude 11
 
 This is an _abridged_ version of the Big Sky Catalog.
 """
 
 BIG_SKY_MAG9 = Catalog(
-    path=settings.data_path / "stars.bigksy.0.1.2.mag9.parquet",
-    url="https://github.com/steveberardi/starplot-bigsky/releases/download/v0.1.1/stars.bigksy.0.1.1.mag9.parquet",
+    path=settings.data_path / "stars.bigksy.0.1.3.mag9.parquet",
+    url="https://github.com/steveberardi/starplot-bigsky/releases/download/v0.1.3/stars.bigksy.0.1.3.mag9.parquet",
 )
 """
-[Big Sky Catalog](https://github.com/steveberardi/bigsky) ~ 136,125 stars with limiting magnitude 9
+[Big Sky Catalog](https://github.com/steveberardi/bigsky) ~ 136,126 stars with limiting magnitude 9
 
 This is an _abridged_ version of the Big Sky Catalog.
 """
 
 OPEN_NGC = Catalog(
     path=settings.data_path / "ongc.0.1.2.parquet",
-    url="https://github.com/steveberardi/starplot-ongc/releases/download/v0.1.1/ongc.0.1.1.parquet",
+    url="https://github.com/steveberardi/starplot-ongc/releases/download/v0.1.2/ongc.0.1.2.parquet",
 )
 """
 [OpenNGC](https://github.com/mattiaverga/OpenNGC) catalog, including nebulae outlines.
 """
 
 CONSTELLATIONS_IAU = Catalog(
-    path=settings.data_path / "constellations-iau-0.1.2.parquet",
-    url="https://github.com/steveberardi/starplot-constellations/releases/download/v0.1.1/constellations.0.1.1.parquet",
+    path=settings.data_path / "constellations.0.3.3.parquet",
+    url="https://github.com/steveberardi/starplot-constellations/releases/download/v0.3.3/constellations.0.3.3.parquet",
 )
 """
 Constellations recognized by IAU, with lines by Sky & Telescope.
 """
 
+CONSTELLATION_BORDERS = Catalog(
+    path=settings.data_path / "constellations-borders-0.3.1.parquet",
+    url="https://github.com/steveberardi/starplot-constellations/releases/download/v0.3.1/constellations-borders.0.3.1.parquet",
+)
+
+MILKY_WAY = Catalog(
+    path=settings.data_path / "milky_way-0.1.0.parquet",
+    url="https://github.com/steveberardi/starplot-milkyway/releases/download/v0.1.0/milky_way.parquet",
+)
+
 
 def download_all_catalogs(silent=False):
     BIG_SKY.download_if_not_exists(silent=silent)
@@ -342,3 +352,5 @@ def download_all_catalogs(silent=False):
     BIG_SKY_MAG11.download_if_not_exists(silent=silent)
     OPEN_NGC.download_if_not_exists(silent=silent)
     CONSTELLATIONS_IAU.download_if_not_exists(silent=silent)
+    CONSTELLATION_BORDERS.download_if_not_exists(silent=silent)
+    MILKY_WAY.download_if_not_exists(silent=silent)

starplot/data/constellations.py

@@ -43,6 +43,7 @@ def table(
 
     return c.mutate(
         boundary=_.boundary.cast("geometry"),  # cast WKB to geometry type
+        border=_.border.cast("geometry"),  # cast WKB to geometry type
         name=getattr(c, name_column),
     )
 

starplot/data/db.py

@@ -12,13 +12,7 @@ NAME_TABLES = {
 
 
 def connect():
-    connection = duckdb.connect(
-        DataFiles.DATABASE,
-        read_only=True,
-        # threads=4,
-        # memory_limit="1GB",
-    )
-
+    connection = duckdb.connect()
     path = settings.data_path / "duckdb-extensions"
     connection.raw_sql(f"SET extension_directory = '{str(path)}';")
 

starplot/geod.py

@@ -1,7 +1,7 @@
 import math
 
 import pyproj
-
+import numpy as np
 
 GEOD = pyproj.Geod("+a=6378137 +f=0.0", sphere=True)
 
@@ -70,11 +70,10 @@ def ellipse(
 
     height = distance_m(height_degrees / 2)  # b
     width = distance_m(width_degrees / 2)  # a
+    step_size = (end_angle - start_angle) / num_pts
 
     points = []
-    for angle_pt in range(
-        start_angle, end_angle + 1, int((end_angle - start_angle) / num_pts)
-    ):
+    for angle_pt in np.arange(start_angle, end_angle + step_size, step_size):
         radians = math.radians(angle_pt)
         radius_a = (height * width) / math.sqrt(
             height**2 * (math.sin(radians)) ** 2

starplot/geometry.py

@@ -2,7 +2,7 @@ import random
 import math
 from typing import Union
 
-from shapely import transform
+from shapely import transform, union_all
 from shapely.geometry import Point, Polygon, MultiPolygon
 
 from starplot import geod
@@ -96,6 +96,22 @@ def unwrap_polygon_360(polygon: Polygon) -> Polygon:
     return polygon
 
 
+def union_at_zero(a: Polygon, b: Polygon) -> Polygon:
+    """Returns union of two polygons"""
+    a_ra = list(a.exterior.coords.xy)[0]
+    b_ra = list(b.exterior.coords.xy)[0]
+
+    if max(a_ra) == 360 and min(b_ra) == 0:
+        points = list(zip(*b.exterior.coords.xy))
+        b = Polygon([[ra + 360, dec] for ra, dec in points])
+
+    elif min(a_ra) == 0 and max(b_ra) == 360:
+        points = list(zip(*a.exterior.coords.xy))
+        a = Polygon([[ra + 360, dec] for ra, dec in points])
+
+    return union_all([a, b])
+
+
 def split_polygon_at_zero(polygon: Polygon) -> list[Polygon]:
     """
     Splits a polygon at the first point of Aries (RA=0)

starplot/mixins.py

@@ -12,6 +12,17 @@ class ExtentMaskMixin:
 
         If the extent crosses equinox, then a MultiPolygon will be returned
         """
+        if self._is_global_extent():
+            return Polygon(
+                [
+                    (0, -90),
+                    (360, -90),
+                    (360, 90),
+                    (0, 90),
+                    (0, -90),
+                ]
+            )
+
         if self.ra_max <= 360:
             coords = [
                 [self.ra_min, self.dec_min],

starplot/models/__init__.py

@@ -1,5 +1,6 @@
 # ruff: noqa: F401,F403
-from .constellation import Constellation
+
+from .constellation import Constellation, ConstellationBorder
 from .comet import Comet
 from .dso import DSO, DsoType
 from .star import Star
@@ -17,3 +18,4 @@ from .optics import (
 from .objects import ObjectList
 from .satellite import Satellite
 from .observer import Observer
+from .milky_way import MilkyWay

starplot/models/constellation.py

@@ -2,7 +2,7 @@ from typing import Iterator
 from dataclasses import dataclass
 
 from ibis import _
-from shapely import Polygon, MultiPolygon
+from shapely import Polygon, MultiPolygon, LineString
 
 from starplot.models.base import SkyObject, CatalogObject
 from starplot.data.catalogs import Catalog, CONSTELLATIONS_IAU
@@ -16,7 +16,11 @@ class Constellation(CatalogObject, SkyObject):
     """
 
     boundary: Polygon | MultiPolygon
-    """Shapely Polygon of the constellation's boundary. Right ascension coordinates are in degrees (0...360)."""
+    """
+    Shapely Polygon of the constellation's boundary. Right ascension coordinates are in degrees (0...360).
+    
+    If the constellation's boundary crosses the 0-meridian, then this will be a MultiPolygon split at the meridian.
+    """
 
     star_hip_ids: list[int]
     """List of HIP ids for stars that are part of the _lines_ for this constellation."""
@@ -35,6 +39,13 @@ class Constellation(CatalogObject, SkyObject):
     Serpens Caput has the `iau_id` of `ser1` and Serpens Cauda is `ser2`
     """
 
+    border: LineString = None
+    """
+    Shapely LineString of the constellation's border. Right ascension coordinates are in degrees (0...360).
+    
+    Coordinates in this geometry may extend past RA=360, if the border crosses the 0-meridian. This makes it ready to plot with the `line` function.
+    """
+
     def __repr__(self) -> str:
         return f"Constellation(iau_id={self.iau_id}, name={self.name}, ra={self.ra}, dec={self.dec})"
 
@@ -125,10 +136,16 @@ class Constellation(CatalogObject, SkyObject):
         Returns the uppercase name of the constellation.
 
         """
-        return constellation.name.upper()
+        return constellation.name.upper().replace(" ", "\n")
 
 
 def from_tuple(c: tuple) -> Constellation:
     kwargs = {f: getattr(c, f) for f in Constellation._fields() if hasattr(c, f)}
     c = Constellation(**kwargs)
     return c
+
+
+@dataclass(slots=True, kw_only=True)
+class ConstellationBorder(CatalogObject, SkyObject):
+    geometry: LineString
+    """Shapely LineString of the border. Right ascension coordinates are in degrees (0...360)."""

starplot/models/milky_way.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+import pyarrow as pa
+from shapely import Polygon, MultiPolygon
+
+from starplot.models.base import SkyObject, CatalogObject
+
+
+@dataclass(slots=True, kw_only=True)
+class MilkyWay(CatalogObject, SkyObject):
+    """
+    Milky Way model.
+    """
+
+    geometry: Polygon | MultiPolygon
+    """Shapely Polygon of the Milky Way's extent. Right ascension coordinates are in degrees (0...360)."""
+
+    @classmethod
+    def _pyarrow_schema(cls):
+        base_schema = super(MilkyWay, cls)._pyarrow_schema()
+        extra_fields = [
+            pa.field("pk", pa.int64(), nullable=False),
+            pa.field("geometry", pa.binary(), nullable=False),
+        ]
+        return pa.schema(list(base_schema) + extra_fields)
+
+
+def from_tuple(d: tuple) -> MilkyWay:
+    kwargs = {f: getattr(d, f) for f in MilkyWay._fields() if hasattr(d, f)}
+    return MilkyWay(**kwargs)

starplot/models/moon.py

@@ -37,7 +37,7 @@ class Moon(SkyObject):
     """Date/time of moon's position"""
 
     apparent_size: float
-    """Apparent size in the sky (degrees)"""
+    """Apparent diameter in the sky (degrees)"""
 
     phase_angle: float
     """Angle of the moon from the Sun (degrees)"""

starplot/models/observer.py

@@ -6,6 +6,8 @@ from skyfield.timelib import Timescale
 
 from starplot.data import load
 
+ts = load.timescale()
+
 
 class Observer(BaseModel):
     """
@@ -19,8 +21,8 @@ class Observer(BaseModel):
         lat=33.363484,
         lon=-116.836394,
     )
-
     ```
+
     """
 
     dt: AwareDatetime = Field(default_factory=lambda: datetime.now(timezone.utc))
@@ -47,7 +49,7 @@ class Observer(BaseModel):
 
         Timescale instance of the specified datetime (used by Skyfield)
         """
-        return load.timescale().from_datetime(self.dt)
+        return ts.from_datetime(self.dt)
 
     @computed_field
     @cached_property
@@ -59,6 +61,13 @@ class Observer(BaseModel):
         """
         return float(360.0 * self.timescale.gmst / 24.0 + self.lon) % 360.0
 
+    @classmethod
+    def at_epoch(cls, epoch: float) -> "Observer":
+        """
+        Returns an Observer for the specified epoch (Julian year)
+        """
+        return Observer(dt=ts.J(epoch).utc_datetime())
+
     # @computed_field
     # @cached_property
     # def location(self):

starplot/models/planet.py

@@ -72,7 +72,7 @@ class Planet(SkyObject):
     """Date/time of planet's position"""
 
     apparent_size: float = 0
-    """Apparent size (degrees)"""
+    """Apparent diameter (degrees)"""
 
     geometry: Polygon = None
     """Shapely Polygon of the planet's extent. Right ascension coordinates are in degrees (0...360)."""

starplot/models/sun.py

@@ -22,7 +22,7 @@ class Sun(SkyObject):
     """Date/time of Sun's position"""
 
     apparent_size: float = 0
-    """Apparent size (degrees)"""
+    """Apparent diameter (degrees)"""
 
     geometry: Polygon = None
     """Shapely Polygon of the Sun's extent. Right ascension coordinates are in degrees (0...360)."""

starplot/plots/__init__.py

@@ -0,0 +1,6 @@
+# ruff: noqa: F401,F403
+
+from .map import MapPlot
+from .horizon import HorizonPlot
+from .zenith import ZenithPlot
+from .optic import OpticPlot