starplot 0.16.1__py2.py3-none-any.whl → 0.17.0__py2.py3-none-any.whl

starplot/__init__.py

@@ -1,6 +1,6 @@
 """Star charts and maps of the sky"""
 
-__version__ = "0.16.1"
+__version__ = "0.17.0"
 
 from .base import BasePlot  # noqa: F401
 from .map import MapPlot  # noqa: F401
@@ -12,14 +12,40 @@ from .models import (
     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
 )
 from .styles import *  # noqa: F401 F403
-from .observer import Observer  # noqa: F401
 from .projections import *  # noqa: F401 F403
 from .config import settings  # noqa: F401
 
 from ibis import _  # noqa: F401 F403
+
+
+import contextlib
+
+
+@contextlib.contextmanager
+def override_settings(**kwargs):
+    original = {}
+
+    for key, value in kwargs.items():
+        original[key] = getattr(settings, key, None)
+        setattr(settings, key, value)
+
+    try:
+        yield
+
+    finally:
+        for key, value in original.items():
+            setattr(settings, key, value)

starplot/base.py

@@ -14,11 +14,13 @@ from shapely import Polygon, Point
 
 from starplot.coordinates import CoordinateSystem
 from starplot import geod, models, warnings
-from starplot.config import settings, SvgTextType
+from starplot.config import settings as StarplotSettings, SvgTextType
 from starplot.data import load, ecliptic
+from starplot.data.translations import translate
 from starplot.models.planet import PlanetName, PLANET_LABELS_DEFAULT
 from starplot.models.moon import MoonPhase
-from starplot.observer import Observer
+from starplot.models.optics import Optic, Camera
+from starplot.models.observer import Observer
 from starplot.styles import (
     AnchorPointEnum,
     PlotStyle,
@@ -47,16 +49,6 @@ LOG_FORMATTER = logging.Formatter(
 LOG_HANDLER.setFormatter(LOG_FORMATTER)
 LOGGER.addHandler(LOG_HANDLER)
 
-
-DEFAULT_FOV_STYLE = PolygonStyle(
-    fill_color=None,
-    edge_color="red",
-    line_style=[1, [2, 3]],
-    edge_width=3,
-    zorder=-1000,
-)
-"""Default style for plotting scope and bino field of view circles"""
-
 DEFAULT_STYLE = PlotStyle()
 
 DEFAULT_RESOLUTION = 4096
@@ -100,7 +92,7 @@ class BasePlot(ABC):
         *args,
         **kwargs,
     ):
-        if settings.svg_text_type == SvgTextType.PATH:
+        if StarplotSettings.svg_text_type == SvgTextType.PATH:
             plt.rcParams["svg.fonttype"] = "path"
         else:
             plt.rcParams["svg.fonttype"] = "none"
@@ -108,6 +100,8 @@ class BasePlot(ABC):
         px = 1 / DPI  # plt.rcParams["figure.dpi"]  # pixel in inches
         self.pixels_per_point = DPI / 72
 
+        self.language = StarplotSettings.language
+
         self.style = style
         self.figure_size = resolution * px
         self.resolution = resolution
@@ -383,7 +377,7 @@ class BasePlot(ABC):
 
         x, y = self._prepare_coords(ra, dec)
 
-        if settings.svg_text_type == SvgTextType.PATH:
+        if StarplotSettings.svg_text_type == SvgTextType.PATH:
             kwargs["path_effects"] = kwargs.get("path_effects", [self.text_border])
 
         remove_on_constellation_collision = kwargs.pop(
@@ -437,10 +431,12 @@ class BasePlot(ABC):
         settings: dict = None,
         **kwargs,
     ) -> None:
-        kwargs["path_effects"] = kwargs.get("path_effects", [self.text_border])
         kwargs["va"] = "center"
         kwargs["ha"] = "center"
 
+        if StarplotSettings.svg_text_type == SvgTextType.PATH:
+            kwargs["path_effects"] = kwargs.get("path_effects", [self.text_border])
+
         avoid_constellation_lines = settings.get("avoid_constellation_lines", False)
         padding = settings.get("label_padding", 3)
         settings.get("buffer", 0.1)
@@ -737,8 +733,11 @@ class BasePlot(ABC):
             self.observer.dt, self.observer.lat, self.observer.lon, self._ephemeris_name
         )
 
+        legend_label = translate(legend_label, self.language)
+
         for p in planets:
             label = labels.get(p.name)
+            label = translate(label, self.language)
 
             if self.in_bounds(p.ra, p.dec):
                 self._objects.planets.append(p)
@@ -794,6 +793,8 @@ class BasePlot(ABC):
             lon=self.observer.lon,
             ephemeris=self._ephemeris_name,
         )
+        label = translate(label, self.language)
+        legend_label = translate(legend_label, self.language)
         s.name = label or s.name
 
         if not self.in_bounds(s.ra, s.dec):
@@ -1072,6 +1073,8 @@ class BasePlot(ABC):
             lon=self.observer.lon,
             ephemeris=self._ephemeris_name,
         )
+        label = translate(label, self.language)
+        legend_label = translate(legend_label, self.language)
         m.name = label or m.name
 
         if not self.in_bounds(m.ra, m.dec):
@@ -1205,61 +1208,36 @@ class BasePlot(ABC):
             gid="moon-marker",
         )
 
-    def _fov_circle(
-        self, ra, dec, fov, magnification, style: PolygonStyle = DEFAULT_FOV_STYLE
-    ):
-        # FOV (degrees) = FOV eyepiece / magnification
-        fov_degrees = fov / magnification
-        fov_radius = fov_degrees / 2
-        self.circle(
-            (ra, dec),
-            fov_radius,
-            style=style,
-        )
-
-    @use_style(PolygonStyle)
-    def scope_fov(
-        self,
-        ra: float,
-        dec: float,
-        scope_focal_length: float,
-        eyepiece_focal_length: float,
-        eyepiece_fov: float,
-        style: PolygonStyle = DEFAULT_FOV_STYLE,
-    ):
-        """Draws a circle representing the field of view for a telescope and eyepiece.
-
-        Args:
-            ra: Right ascension of the center of view
-            dec: Declination of the center of view
-            scope_focal_length: focal length (mm) of the scope
-            eyepiece_focal_length: focal length (mm) of the eyepiece
-            eyepiece_fov: field of view (degrees) of the eyepiece
-            style: style of the polygon
-        """
-        # FOV (degrees) = FOV eyepiece / magnification
-        magnification = scope_focal_length / eyepiece_focal_length
-        self._fov_circle(ra, dec, eyepiece_fov, magnification, style)
-
-    @use_style(PolygonStyle)
-    def bino_fov(
+    @use_style(PolygonStyle, "optic_fov")
+    def optic_fov(
         self,
         ra: float,
         dec: float,
-        fov: float,
-        magnification: float,
-        style: PolygonStyle = DEFAULT_FOV_STYLE,
+        optic: Optic,
+        style: PolygonStyle = None,
     ):
-        """Draws a circle representing the field of view for binoculars.
+        """Draws a polygon representing the field of view for an optic, centered at a specific point.
 
         Args:
             ra: Right ascension of the center of view
             dec: Declination of the center of view
-            fov: field of view (degrees) of the binoculars
-            magnification: magnification of the binoculars
+            optic: Instance of an [Optic][starplot.models.Optic]
             style: style of the polygon
         """
-        self._fov_circle(ra, dec, fov, magnification, style)
+        if isinstance(optic, Camera):
+            self.rectangle(
+                center=(ra, dec),
+                height_degrees=optic.true_fov_y,
+                width_degrees=optic.true_fov_x,
+                angle=optic.rotation,
+                style=style,
+            )
+        else:
+            self.circle(
+                center=(ra, dec),
+                radius_degrees=optic.true_fov / 2,
+                style=style,
+            )
 
     @use_style(PathStyle, "ecliptic")
     def ecliptic(self, style: PathStyle = None, label: str = "ECLIPTIC"):
@@ -1273,6 +1251,8 @@ class BasePlot(ABC):
         y = []
         inbounds = []
 
+        label = translate(label, self.language)
+
         for ra, dec in ecliptic.RA_DECS:
             x0, y0 = self._prepare_coords(ra * 15, dec)
             x.append(x0)
@@ -1312,6 +1292,8 @@ class BasePlot(ABC):
 
         # TODO : handle wrapping
 
+        label = translate(label, self.language)
+
         for ra in range(25):
             x0, y0 = self._prepare_coords(ra * 15, 0)
             x.append(x0)

starplot/config.py

@@ -1,7 +1,8 @@
+import os
+
 from enum import Enum
 from pathlib import Path
-
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from dataclasses import dataclass, field
 
 
 STARPLOT_PATH = Path(__file__).resolve().parent
@@ -15,30 +16,46 @@ RAW_DATA_PATH = STARPLOT_PATH.parent.parent / "raw"
 BUILD_PATH = STARPLOT_PATH.parent.parent / "build"
 
 
+def _get_path(var_name, default) -> Path:
+    def _get():
+        value = os.environ.get(var_name, default)
+        return Path(value)
+
+    return _get
+
+
 class SvgTextType(str, Enum):
     PATH = "path"
     ELEMENT = "element"
 
 
-class Settings(BaseSettings):
-    model_config = SettingsConfigDict(env_prefix="STARPLOT_")
-    """Configuration for the Pydantic settings model. Do not change."""
-
-    download_path: Path = DATA_PATH / "downloads"
+@dataclass
+class Settings:
+    download_path: Path = field(
+        default_factory=_get_path("STARPLOT_DOWNLOAD_PATH", DATA_PATH / "downloads")
+    )
     """
     Path for downloaded data, including the Big Sky catalog, ephemeris files, etc.
     
     Default = `<starplot_source_path>/data/library/downloads/`
     """
 
-    duckdb_extension_path: Path = DATA_PATH / "duckdb-extensions"
+    duckdb_extension_path: Path = field(
+        default_factory=_get_path(
+            "STARPLOT_DUCKDB_EXTENSION_PATH", DATA_PATH / "duckdb-extensions"
+        )
+    )
     """
     Path for the DuckDB spatial extension, which is required for the data backend.
 
     Default = `<starplot_source_path>/data/library/duckdb-extensions/`
     """
 
-    svg_text_type: SvgTextType = SvgTextType.PATH
+    svg_text_type: SvgTextType = field(
+        default_factory=lambda: os.environ.get(
+            "STARPLOT_SVG_TEXT_TYPE", SvgTextType.PATH
+        )
+    )
     """
     Method for rendering text in SVG exports:
 
@@ -52,5 +69,20 @@ class Settings(BaseSettings):
     
     """
 
+    language: str = field(
+        default_factory=lambda: os.environ.get("STARPLOT_LANGUAGE", "en-US")
+    )
+    """
+    Default language for plotted labels, as an ISO-639 code. Case insensitive.
+
+    Supported values:
+
+    - `en-US` = English
+    - `fr` = French
+    - `zh-CN` = Chinese. Make sure you have a good Chinese font installed (such as [Noto Sans SC](https://fonts.google.com/noto/specimen/Noto+Sans+SC)) and you'll also need to set that as the font in your plot's style.
+
+    **🌐 Want to see another language available? Please help us add it! [Details here](https://github.com/steveberardi/starplot/tree/main/data/raw/translations).**
+    """
+
 
 settings = Settings()

starplot/data/bigsky.py

@@ -1,7 +1,6 @@
 import os
 from pathlib import Path
 
-import pandas as pd
 
 from starplot.config import settings
 from starplot.data import DataFiles, utils
@@ -46,6 +45,7 @@ def download(
 def to_parquet(source_path: str, destination_path: str):
     import pyarrow as pa
     import pyarrow.parquet as pq
+    import pandas as pd
 
     print("Preparing Big Sky Catalog for Starplot...")