kerykeion 4.8.1__py3-none-any.whl → 4.14.2__py3-none-any.whl

kerykeion/charts/charts_utils.py

@@ -2,6 +2,8 @@ import math
 import datetime
 from kerykeion.kr_types import KerykeionException, ChartType
 from typing import Union
+from kerykeion.kr_types.kr_models import AspectModel
+from kerykeion.kr_types.settings_models import KerykeionLanguageCelestialPointModel, KerykeionSettingsAspectModel
 
 
 def decHourJoin(inH: int, inM: int, inS: int) -> float:
@@ -126,7 +128,7 @@ def draw_zodiac_slice(
 
     Args:
         - c1 (Union[int, float]): The value of c1.
-        - chart_type (Literal["Natal", "ExternalNatal", "Synastry", "Transit"]): The type of chart.
+        - chart_type (ChartType): The type of chart.
         - seventh_house_degree_ut (Union[int, float]): The degree of the seventh house.
         - num (int): The number of the sign. Note: In OpenAstro it did refer to self.zodiac,
             which is a list of the signs in order, starting with Aries. Eg:
@@ -212,8 +214,7 @@ def convert_longitude_coordinate_to_string(coord: Union[int, float], east_label:
 def draw_aspect_line(
     r: Union[int, float],
     ar: Union[int, float],
-    degA: Union[int, float],
-    degB: Union[int, float],
+    aspect: Union[AspectModel, dict],
     color: str,
     seventh_house_degree_ut: Union[int, float],
 ) -> str:
@@ -222,8 +223,7 @@ def draw_aspect_line(
     Args:
         - r (Union[int, float]): The value of r.
         - ar (Union[int, float]): The value of ar.
-        - degA (Union[int, float]): The degree of A.
-        - degB (Union[int, float]): The degree of B.
+        - aspect_dict (dict): The aspect dictionary.
         - color (str): The color of the aspect.
         - seventh_house_degree_ut (Union[int, float]): The degree of the seventh house.
 
@@ -231,15 +231,21 @@ def draw_aspect_line(
         str: The SVG line element as a string.
     """
 
-    first_offset = (int(seventh_house_degree_ut) / -1) + int(degA)
+    if isinstance(aspect, dict):
+        aspect = AspectModel(**aspect)
+
+    first_offset = (int(seventh_house_degree_ut) / -1) + int(aspect["p1_abs_pos"])
     x1 = sliceToX(0, ar, first_offset) + (r - ar)
     y1 = sliceToY(0, ar, first_offset) + (r - ar)
 
-    second_offset = (int(seventh_house_degree_ut) / -1) + int(degB)
+    second_offset = (int(seventh_house_degree_ut) / -1) + int(aspect["p2_abs_pos"])
     x2 = sliceToX(0, ar, second_offset) + (r - ar)
     y2 = sliceToY(0, ar, second_offset) + (r - ar)
 
-    out = f'<line class="aspect" x1="{x1}" y1="{y1}" x2="{x2}" y2="{y2}" style="stroke: {color}; stroke-width: 1; stroke-opacity: .9;"/>'
+    out = ""
+    out += f'<g kr:node="Aspect" kr:aspectname="{aspect['aspect']}" kr:to="{aspect['p1_name']}" kr:tooriginaldegrees="{aspect["p1_abs_pos"]}" kr:from="{aspect["p2_name"]}" kr:fromoriginaldegrees="{aspect["p2_abs_pos"]}">'
+    out += f'<line class="aspect" x1="{x1}" y1="{y1}" x2="{x2}" y2="{y2}" style="stroke: {color}; stroke-width: 1; stroke-opacity: .9;"/>'
+    out += f"</g>"
 
     return out
 
@@ -344,19 +350,21 @@ def draw_transit_ring_degree_steps(r: Union[int, float], seventh_house_degree_ut
         y2 = sliceToY(0, r + 2, offset) - 2
         out += f'<line x1="{x1}" y1="{y1}" x2="{x2}" y2="{y2}" style="stroke: #F00; stroke-width: 1px; stroke-opacity:.9;"/>'
     out += "</g>"
-    
+
     return out
 
 
-def draw_degree_ring(r: Union[int, float], c1: Union[int, float], seventh_house_degree_ut: Union[int, float], stroke_color: str) -> str:
+def draw_degree_ring(
+    r: Union[int, float], c1: Union[int, float], seventh_house_degree_ut: Union[int, float], stroke_color: str
+) -> str:
     """Draws the degree ring.
-    
+
     Args:
         - r (Union[int, float]): The value of r.
         - c1 (Union[int, float]): The value of c1.
         - seventh_house_degree_ut (Union[int, float]): The degree of the seventh house.
         - stroke_color (str): The color of the stroke.
-        
+
     Returns:
         str: The SVG path of the degree ring.
     """
@@ -374,18 +382,19 @@ def draw_degree_ring(r: Union[int, float], c1: Union[int, float], seventh_house_
 
         out += f'<line x1="{x1}" y1="{y1}" x2="{x2}" y2="{y2}" style="stroke: {stroke_color}; stroke-width: 1px; stroke-opacity:.9;"/>'
     out += "</g>"
-    
+
     return out
 
+
 def draw_transit_ring(r: Union[int, float], paper_1_color: str, zodiac_transit_ring_3_color: str) -> str:
     """
     Draws the transit ring.
-    
+
     Args:
         - r (Union[int, float]): The value of r.
         - paper_1_color (str): The color of paper 1.
         - zodiac_transit_ring_3_color (str): The color of the zodiac transit ring
-        
+
     Returns:
         str: The SVG path of the transit ring.
     """
@@ -397,16 +406,18 @@ def draw_transit_ring(r: Union[int, float], paper_1_color: str, zodiac_transit_r
     return out
 
 
-def draw_first_circle(r: Union[int, float], stroke_color: str, chart_type: ChartType, c1: Union[int, float, None] = None) -> str:
+def draw_first_circle(
+    r: Union[int, float], stroke_color: str, chart_type: ChartType, c1: Union[int, float, None] = None
+) -> str:
     """
     Draws the first circle.
-    
+
     Args:
         - r (Union[int, float]): The value of r.
         - color (str): The color of the circle.
         - chart_type (ChartType): The type of chart.
         - c1 (Union[int, float]): The value of c1.
-        
+
     Returns:
         str: The SVG path of the first circle.
     """
@@ -416,29 +427,383 @@ def draw_first_circle(r: Union[int, float], stroke_color: str, chart_type: Chart
         if c1 is None:
             raise KerykeionException("c1 is None")
 
-        return f'<circle cx="{r}" cy="{r}" r="{r - c1}" style="fill: none; stroke: {stroke_color}; stroke-width: 1px; " />'
+        return (
+            f'<circle cx="{r}" cy="{r}" r="{r - c1}" style="fill: none; stroke: {stroke_color}; stroke-width: 1px; " />'
+        )
 
 
-def draw_second_circle(r: Union[int, float], stroke_color: str, fill_color: str, chart_type: ChartType, c2: Union[int, float, None] = None) -> str:
+def draw_second_circle(
+    r: Union[int, float], stroke_color: str, fill_color: str, chart_type: ChartType, c2: Union[int, float, None] = None
+) -> str:
     """
     Draws the second circle.
-    
+
     Args:
         - r (Union[int, float]): The value of r.
         - stroke_color (str): The color of the stroke.
         - fill_color (str): The color of the fill.
         - chart_type (ChartType): The type of chart.
         - c2 (Union[int, float]): The value of c2.
-        
+
     Returns:
         str: The SVG path of the second circle.
     """
-    
+
     if chart_type == "Synastry" or chart_type == "Transit":
         return f'<circle cx="{r}" cy="{r}" r="{r - 72}" style="fill: {fill_color}; fill-opacity:.4; stroke: {stroke_color}; stroke-opacity:.4; stroke-width: 1px" />'
-    
+
     else:
         if c2 is None:
             raise KerykeionException("c2 is None")
 
-        return f'<circle cx="{r}" cy="{r}" r="{r - c2}" style="fill: {fill_color}; fill-opacity:.2; stroke: {stroke_color}; stroke-opacity:.4; stroke-width: 1px" />'
+        return f'<circle cx="{r}" cy="{r}" r="{r - c2}" style="fill: {fill_color}; fill-opacity:.2; stroke: {stroke_color}; stroke-opacity:.4; stroke-width: 1px" />'
+
+
+def draw_third_circle(
+    radius: Union[int, float],
+    stroke_color: str,
+    fill_color: str,
+    chart_type: ChartType,
+    c3: Union[int, float, None] = None,
+) -> str:
+    """
+    Draws the third circle in an SVG chart.
+
+    Parameters:
+    - radius (Union[int, float]): The radius of the circle.
+    - stroke_color (str): The stroke color of the circle.
+    - fill_color (str): The fill color of the circle.
+    - chart_type (ChartType): The type of the chart.
+    - c3 (Union[int, float, None], optional): The radius adjustment for non-Synastry and non-Transit charts.
+
+    Returns:
+    - str: The SVG element as a string.
+    """
+    if chart_type in {"Synastry", "Transit"}:
+        # For Synastry and Transit charts, use a fixed radius adjustment of 160
+        return f'<circle cx="{radius}" cy="{radius}" r="{radius - 160}" style="fill: {fill_color}; fill-opacity:.8; stroke: {stroke_color}; stroke-width: 1px" />'
+
+    else:
+        return f'<circle cx="{radius}" cy="{radius}" r="{radius - c3}" style="fill: {fill_color}; fill-opacity:.8; stroke: {stroke_color}; stroke-width: 1px" />'
+
+
+def draw_aspect_grid(stroke_color: str, available_planets_list: list, aspects_list: list) -> str:
+    """
+    Draws the aspect grid.
+
+    Args:
+        - stroke_color (str): The color of the stroke.
+        - available_planets_list (list): List of all the planets, they will be actually filtered to so if they have
+            the "is_active" key set to True inside the function to have the correct list of just the active planets.
+        - aspects_list (list): List of aspects.
+
+    """
+
+    out = ""
+    style = f"stroke:{stroke_color}; stroke-width: 1px; stroke-opacity:.6; fill:none"
+    xindent = 380
+    yindent = 468
+    box = 14
+    counter = 0
+
+    actual_planets = []
+    for planet in available_planets_list:
+        if planet.is_active:
+            actual_planets.append(planet)
+
+    first_iteration_revers_planets = actual_planets[::-1]
+    for index, a in enumerate(first_iteration_revers_planets):
+        counter += 1
+        out += f'<rect x="{xindent}" y="{yindent}" width="{box}" height="{box}" style="{style}"/>'
+        out += f'<use transform="scale(0.4)" x="{(xindent+2)*2.5}" y="{(yindent+1)*2.5}" xlink:href="#{a["name"]}" />'
+
+        xindent = xindent + box
+        yindent = yindent - box
+
+        xorb = xindent
+        yorb = yindent + box
+
+        second_iteration_revers_planets = first_iteration_revers_planets[index + 1 :]
+        for b in second_iteration_revers_planets:
+            out += f'<rect x="{xorb}" y="{yorb}" width="{box}" height="{box}" style="{style}"/>'
+            xorb = xorb + box
+
+            for aspect in aspects_list:
+                if (aspect["p1"] == a["id"] and aspect["p2"] == b["id"]) or (
+                    aspect["p1"] == b["id"] and aspect["p2"] == a["id"]
+                ):
+                    out += f'<use  x="{xorb-box+1}" y="{yorb+1}" xlink:href="#orb{aspect["aspect_degrees"]}" />'
+
+    return out
+
+
+def draw_houses_cusps_and_text_number(
+    r: Union[int, float],
+    first_subject_houses_list_ut: list,
+    standard_house_cusp_color: str,
+    first_house_color: str,
+    tenth_house_color: str,
+    seventh_house_color: str,
+    fourth_house_color: str,
+    c1: Union[int, float],
+    c3: Union[int, float],
+    chart_type: ChartType,
+    second_subject_houses_list_ut: list = None,
+    transit_house_cusp_color: str = None,
+) -> str:
+    """
+    Draws the houses cusps and text numbers for a given chart type.
+
+    Parameters:
+    - r: Radius of the chart.
+    - first_subject_houses_list_ut: List of house cusps for the first subject.
+    - standard_house_cusp_color: Default color for house cusps.
+    - first_house_color: Color for the first house cusp.
+    - tenth_house_color: Color for the tenth house cusp.
+    - seventh_house_color: Color for the seventh house cusp.
+    - fourth_house_color: Color for the fourth house cusp.
+    - c1: Offset for the first subject.
+    - c3: Offset for the third subject.
+    - chart_type: Type of the chart (e.g., Transit, Synastry).
+    - second_subject_houses_list_ut: List of house cusps for the second subject (optional).
+    - transit_house_cusp_color: Color for transit house cusps (optional).
+
+    Returns:
+    - A string containing the SVG path for the houses cusps and text numbers.
+    """
+    if chart_type in ["Transit", "Synastry"]:
+        if second_subject_houses_list_ut is None or transit_house_cusp_color is None:
+            raise KerykeionException("second_subject_houses_list_ut or transit_house_cusp_color is None")
+
+    path = ""
+    xr = 12
+
+    for i in range(xr):
+        # Determine offsets based on chart type
+        dropin, roff, t_roff = (160, 72, 36) if chart_type in ["Transit", "Synastry"] else (c3, c1, None)
+
+        # Calculate the offset for the current house cusp
+        offset = (int(first_subject_houses_list_ut[int(xr / 2)]) / -1) + int(first_subject_houses_list_ut[i])
+
+        # Calculate the coordinates for the house cusp lines
+        x1 = sliceToX(0, (r - dropin), offset) + dropin
+        y1 = sliceToY(0, (r - dropin), offset) + dropin
+        x2 = sliceToX(0, r - roff, offset) + roff
+        y2 = sliceToY(0, r - roff, offset) + roff
+
+        # Calculate the text offset for the house number
+        next_index = (i + 1) % xr
+        text_offset = offset + int(
+            degreeDiff(first_subject_houses_list_ut[next_index], first_subject_houses_list_ut[i]) / 2
+        )
+
+        # Determine the line color based on the house index
+        linecolor = {0: first_house_color, 9: tenth_house_color, 6: seventh_house_color, 3: fourth_house_color}.get(
+            i, standard_house_cusp_color
+        )
+
+        if chart_type in ["Transit", "Synastry"]:
+            # Calculate the offset for the second subject's house cusp
+            zeropoint = 360 - first_subject_houses_list_ut[6]
+            t_offset = (zeropoint + second_subject_houses_list_ut[i]) % 360
+
+            # Calculate the coordinates for the second subject's house cusp lines
+            t_x1 = sliceToX(0, (r - t_roff), t_offset) + t_roff
+            t_y1 = sliceToY(0, (r - t_roff), t_offset) + t_roff
+            t_x2 = sliceToX(0, r, t_offset)
+            t_y2 = sliceToY(0, r, t_offset)
+
+            # Calculate the text offset for the second subject's house number
+            t_text_offset = t_offset + int(
+                degreeDiff(second_subject_houses_list_ut[next_index], second_subject_houses_list_ut[i]) / 2
+            )
+            t_linecolor = linecolor if i in [0, 9, 6, 3] else transit_house_cusp_color
+            xtext = sliceToX(0, (r - 8), t_text_offset) + 8
+            ytext = sliceToY(0, (r - 8), t_text_offset) + 8
+
+            # Add the house number text for the second subject
+            fill_opacity = "0" if chart_type == "Transit" else ".4"
+            path += f'<g kr:node="HouseNumber">'
+            path += f'<text style="fill: #00f; fill-opacity: {fill_opacity}; font-size: 14px"><tspan x="{xtext - 3}" y="{ytext + 3}">{i + 1}</tspan></text>'
+            path += f"</g>"
+
+            # Add the house cusp line for the second subject
+            stroke_opacity = "0" if chart_type == "Transit" else ".3"
+            path += f'<g kr:node="Cusp">'
+            path += f"<line x1='{t_x1}' y1='{t_y1}' x2='{t_x2}' y2='{t_y2}' style='stroke: {t_linecolor}; stroke-width: 1px; stroke-opacity:{stroke_opacity};'/>"
+            path += f"</g>"
+
+        # Adjust dropin based on chart type
+        dropin = {"Transit": 84, "Synastry": 84, "ExternalNatal": 100}.get(chart_type, 48)
+        xtext = sliceToX(0, (r - dropin), text_offset) + dropin
+        ytext = sliceToY(0, (r - dropin), text_offset) + dropin
+
+        # Add the house cusp line for the first subject
+        path += f'<g kr:node="Cusp">'
+        path += f'<line x1="{x1}" y1="{y1}" x2="{x2}" y2="{y2}" style="stroke: {linecolor}; stroke-width: 1px; stroke-dasharray:3,2; stroke-opacity:.4;"/>'
+        path += f"</g>"
+
+        # Add the house number text for the first subject
+        path += f'<g kr:node="HouseNumber">'
+        path += f'<text style="fill: #f00; fill-opacity: .6; font-size: 14px"><tspan x="{xtext - 3}" y="{ytext + 3}">{i + 1}</tspan></text>'
+        path += f"</g>"
+
+    return path
+
+
+def draw_aspect_transit_grid(
+    grid_title: str,
+    aspects_list: Union[list[AspectModel], list[dict]],
+    celestial_point_language: KerykeionLanguageCelestialPointModel,
+    aspects_settings: KerykeionSettingsAspectModel,
+) -> str:
+    """
+    Generates the SVG output for the aspect transit grid.
+
+    Parameters:
+    - grid_title: Title of the grid.
+    - aspects_list: List of aspects.
+    - planets_labels: Dictionary containing the planet labels.
+    - aspects_settings: Dictionary containing the aspect settings.
+
+    Returns:
+    - A string containing the SVG path data for the aspect transit grid.
+    """
+
+    # If not instance of AspectModel, convert to AspectModel
+    if isinstance(aspects_list[0], dict):
+        aspects_list = [AspectModel(**aspect) for aspect in aspects_list]
+
+    line = 0
+    nl = 0
+    inner_path = ""
+    scale = 1
+    for i, aspect in enumerate(aspects_list):
+        # Adjust the vertical position for every 12 aspects
+        if i == 12:
+            nl = 100
+            line = 0
+
+        elif i == 24:
+            nl = 200
+            line = 0
+
+        elif i == 36:
+            nl = 300
+            line = 0
+
+        elif i == 48:
+            nl = 400
+            # When there are more than 60 aspects, the text is moved up
+            if len(aspects_list) > 60:
+                line = -1 * (len(aspects_list) - 60) * 14
+            else:
+                line = 0
+
+        inner_path += f'<g transform="translate({nl},{line})">'
+
+        # first planet symbol
+        inner_path += f'<use transform="scale(0.4)" x="0" y="3" xlink:href="#{celestial_point_language[aspects_list[i]["p1"]]["name"]}" />'
+
+        # aspect symbol
+        inner_path += f'<use  x="15" y="0" xlink:href="#orb{aspects_settings[aspects_list[i]["aid"]]["degree"]}" />'
+
+        # second planet symbol
+        inner_path += f'<g transform="translate(30,0)">'
+        inner_path += f'<use transform="scale(0.4)" x="0" y="3" xlink:href="#{celestial_point_language[aspects_list[i]["p2"]]["name"]}" />'
+        inner_path += f"</g>"
+
+        # difference in degrees
+        inner_path += f'<text y="8" x="45" style="fill:#000000; font-size: 10px;">{convert_decimal_to_degree_string(aspects_list[i]["orbit"])}</text>'
+        # line
+        inner_path += f"</g>"
+        line = line + 14
+
+    out = f'<g style="transform: translate(47%, 61%) scale({scale})">'
+    out += f'<text y="-15" x="0" style="fill:#000000; font-size: 14px;">{grid_title}:</text>'
+    out += inner_path
+    out += "</g>"
+
+    return out
+
+
+def draw_moon_phase(
+    degrees_between_sun_and_moon: float,
+    latitude: float,
+    lunar_phase_outline_color: str = "#000000",
+    dark_color: str = "#000000",
+    light_color: str = "#ffffff",
+) -> str:
+    """
+    Draws the moon phase based on the degrees between the sun and the moon.
+
+    Parameters:
+    - degrees_between_sun_and_moon (float): The degrees between the sun and the moon.
+    - latitude (float): The latitude for rotation calculation.
+    - lunar_phase_outline_color (str): The color for the lunar phase outline.
+    - dark_color (str): The color for the dark part of the moon.
+    - light_color (str): The color for the light part of the moon.
+
+    Returns:
+    - str: The SVG element as a string.
+    """
+    deg = degrees_between_sun_and_moon
+
+    # Initialize variables for lunar phase properties
+    fill_color_foreground = None
+    fill_color_background = None
+    circle_center_x = None
+    circle_radius = None
+
+    # Determine lunar phase properties based on the degree
+    if deg < 90.0:
+        max_radius = deg
+        if deg > 80.0:
+            max_radius = max_radius * max_radius
+        circle_center_x = 20.0 + (deg / 90.0) * (max_radius + 10.0)
+        circle_radius = 10.0 + (deg / 90.0) * max_radius
+        fill_color_foreground = dark_color
+        fill_color_background = light_color
+
+    elif deg < 180.0:
+        max_radius = 180.0 - deg
+        if deg < 100.0:
+            max_radius = max_radius * max_radius
+        circle_center_x = 20.0 + ((deg - 90.0) / 90.0 * (max_radius + 10.0)) - (max_radius + 10.0)
+        circle_radius = 10.0 + max_radius - ((deg - 90.0) / 90.0 * max_radius)
+        fill_color_foreground = light_color
+        fill_color_background = dark_color
+
+    elif deg < 270.0:
+        max_radius = deg - 180.0
+        if deg > 260.0:
+            max_radius = max_radius * max_radius
+        circle_center_x = 20.0 + ((deg - 180.0) / 90.0 * (max_radius + 10.0))
+        circle_radius = 10.0 + ((deg - 180.0) / 90.0 * max_radius)
+        fill_color_foreground = light_color
+        fill_color_background = dark_color
+
+    elif deg < 361.0:
+        max_radius = 360.0 - deg
+        if deg < 280.0:
+            max_radius = max_radius * max_radius
+        circle_center_x = 20.0 + ((deg - 270.0) / 90.0 * (max_radius + 10.0)) - (max_radius + 10.0)
+        circle_radius = 10.0 + max_radius - ((deg - 270.0) / 90.0 * max_radius)
+        fill_color_foreground = dark_color
+        fill_color_background = light_color
+
+    else:
+        raise KerykeionException(f"Invalid degree value: {deg}")
+
+
+    # Calculate rotation based on latitude
+    lunar_phase_rotate = -90.0 - latitude
+
+    # Return the SVG element as a string
+    return (
+        f'<g transform="rotate({lunar_phase_rotate} 20 10)">'
+        f'    <circle cx="20" cy="10" r="10" style="fill: {fill_color_background}" />'
+        f'    <circle cx="{circle_center_x}" cy="10" r="{circle_radius}" style="fill: {fill_color_foreground}" clip-path="url(#moonPhaseCutOffCircle)" />'
+        f'    <circle cx="20" cy="10" r="10" style="fill: none; stroke: {lunar_phase_outline_color}; stroke-width: 0.5px; stroke-opacity: 0.5" />'
+        f"</g>"
+    )