kerykeion.ephemeris_data

  1from kerykeion import AstrologicalSubject
  2from kerykeion.utilities import get_houses_list, get_available_astrological_points_list
  3from kerykeion.astrological_subject import DEFAULT_HOUSES_SYSTEM_IDENTIFIER, DEFAULT_PERSPECTIVE_TYPE, DEFAULT_ZODIAC_TYPE
  4from kerykeion.kr_types import EphemerisDictModel
  5from kerykeion.kr_types import SiderealMode, HousesSystemIdentifier, PerspectiveType, ZodiacType
  6from datetime import datetime, timedelta
  7from typing import Literal, Union
  8import logging
  9
 10
 11class EphemerisDataFactory:
 12    """
 13    This class is used to generate ephemeris data for a given date range.
 14
 15    Parameters:
 16    - start_datetime: datetime object representing the start date and time.
 17    - end_datetime: datetime object representing the end date and time.
 18    - step_type: string representing the step type. It can be "days", "hours", or "minutes". Default is "days".
 19    - step: integer representing the step value. Default is 1.
 20    - lat: float representing the latitude. Default is 51.4769 (Greenwich).
 21    - lng: float representing the longitude. Default is 0.0005 (Greenwich).
 22    - tz_str: string representing the timezone. Default is "Etc/UTC".
 23    - is_dst: boolean representing if daylight saving time is active. Default is False.
 24    - disable_chiron_and_lilith: boolean representing if Chiron and Lilith should be disabled. Default is False.
 25    - zodiac_type: ZodiacType object representing the zodiac type. Default is DEFAULT_ZODIAC_TYPE.
 26    - sidereal_mode: SiderealMode object representing the sidereal mode. Default is None.
 27    - houses_system_identifier: HousesSystemIdentifier object representing the houses system identifier. Default is DEFAULT_HOUSES_SYSTEM_IDENTIFIER.
 28    - perspective_type: PerspectiveType object representing the perspective type. Default is DEFAULT_PERSPECTIVE_TYPE.
 29    - max_days: integer representing the maximum number of days.
 30        Set it to None to disable the check. Default is 730.
 31    - max_hours: integer representing the maximum number of hours.
 32        Set it to None to disable the check. Default is 8760.
 33    - max_minutes: integer representing the maximum number of minutes.
 34        Set it to None to disable the check. Default is 525600.
 35
 36    Raises:
 37    - ValueError: if the step type is invalid.
 38    - ValueError: if the number of days, hours, or minutes is greater than the maximum allowed.
 39    """
 40
 41    def __init__(
 42        self,
 43        start_datetime: datetime,
 44        end_datetime: datetime,
 45        step_type: Literal["days", "hours", "minutes"] = "days",
 46        step: int = 1,
 47        lat: float = 51.4769,
 48        lng: float = 0.0005,
 49        tz_str: str = "Etc/UTC",
 50        is_dst: bool = False,
 51        disable_chiron_and_lilith: bool = False,
 52        zodiac_type: ZodiacType = DEFAULT_ZODIAC_TYPE,
 53        sidereal_mode: Union[SiderealMode, None] = None,
 54        houses_system_identifier: HousesSystemIdentifier = DEFAULT_HOUSES_SYSTEM_IDENTIFIER,
 55        perspective_type: PerspectiveType = DEFAULT_PERSPECTIVE_TYPE,
 56        max_days: Union[int, None] = 730,
 57        max_hours: Union[int, None] = 8760,
 58        max_minutes: Union[int, None] = 525600,
 59    ):
 60        self.start_datetime = start_datetime
 61        self.end_datetime = end_datetime
 62        self.step_type = step_type
 63        self.step = step
 64        self.lat = lat
 65        self.lng = lng
 66        self.tz_str = tz_str
 67        self.is_dst = is_dst
 68        self.disable_chiron_and_lilith = disable_chiron_and_lilith
 69        self.zodiac_type = zodiac_type
 70        self.sidereal_mode = sidereal_mode
 71        self.houses_system_identifier = houses_system_identifier
 72        self.perspective_type = perspective_type
 73        self.max_days = max_days
 74        self.max_hours = max_hours
 75        self.max_minutes = max_minutes
 76
 77        self.dates_list = []
 78        if self.step_type == "days":
 79            self.dates_list = [self.start_datetime + timedelta(days=i) for i in range((self.end_datetime - self.start_datetime).days)]
 80            if max_days and (len(self.dates_list) > max_days):
 81                raise ValueError(f"Too many days: {len(self.dates_list)} > {self.max_days}. To prevent this error, set max_days to a higher value or reduce the date range.")
 82
 83        elif self.step_type == "hours":
 84            self.dates_list = [self.start_datetime + timedelta(hours=i) for i in range((self.end_datetime - self.start_datetime).days * 24)]
 85            if max_hours and (len(self.dates_list) > max_hours):
 86                raise ValueError(f"Too many hours: {len(self.dates_list)} > {self.max_hours}. To prevent this error, set max_hours to a higher value or reduce the date range.")
 87
 88        elif self.step_type == "minutes":
 89            self.dates_list = [self.start_datetime + timedelta(minutes=i) for i in range((self.end_datetime - self.start_datetime).days * 24 * 60)]
 90            if max_minutes and (len(self.dates_list) > max_minutes):
 91                raise ValueError(f"Too many minutes: {len(self.dates_list)} > {self.max_minutes}. To prevent this error, set max_minutes to a higher value or reduce the date range.")
 92
 93        else:
 94            raise ValueError(f"Invalid step type: {self.step_type}")
 95
 96        if not self.dates_list:
 97            raise ValueError("No dates found. Check the date range and step values.")
 98
 99        if len(self.dates_list) > 1000:
100            logging.warning(f"Large number of dates: {len(self.dates_list)}. The calculation may take a while.")
101
102    def get_ephemeris_data(self, as_model: bool = False) -> list:
103        """
104        Generate ephemeris data for the specified date range.
105        The data is structured as a list of dictionaries, where each dictionary contains the date, planets, and houses data.
106        Example:
107        [
108            {
109                "date": "2020-01-01T00:00:00",
110                "planets": [{...}, {...}, ...],
111                "houses": [{...}, {...}, ...]
112            },
113            ...
114        ]
115
116        Args:
117        - as_model (bool): If True, the ephemeris data will be returned as model instances. Default is False.
118
119        Returns:
120        - list: A list of dictionaries representing the ephemeris data. If as_model is True, a list of EphemerisDictModel instances is returned.
121        """
122        ephemeris_data_list = []
123        for date in self.dates_list:
124            subject = AstrologicalSubject(
125                year=date.year,
126                month=date.month,
127                day=date.day,
128                hour=date.hour,
129                minute=date.minute,
130                lng=self.lng,
131                lat=self.lat,
132                tz_str=self.tz_str,
133                city="Placeholder",
134                nation="Placeholder",
135                online=False,
136                disable_chiron_and_lilith=self.disable_chiron_and_lilith,
137                zodiac_type=self.zodiac_type,
138                sidereal_mode=self.sidereal_mode,
139                houses_system_identifier=self.houses_system_identifier,
140                perspective_type=self.perspective_type,
141                is_dst=self.is_dst,
142            )
143
144            houses_list = get_houses_list(subject)
145            available_planets = get_available_astrological_points_list(subject)
146
147            ephemeris_data_list.append({"date": date.isoformat(), "planets": available_planets, "houses": houses_list})
148
149        if as_model:
150            return [EphemerisDictModel(**data) for data in ephemeris_data_list]
151
152        return ephemeris_data_list
153
154
155if "__main__" == __name__:
156    start_date = datetime.fromisoformat("2020-01-01")
157    end_date = datetime.fromisoformat("2020-01-03")
158
159    factory = EphemerisDataFactory(
160        start_datetime=start_date,
161        end_datetime=end_date,
162        step_type="minutes",
163        step=1,
164        lat=37.9838,
165        lng=23.7275,
166        tz_str="Europe/Athens",
167        is_dst=False,
168        max_hours=None,
169        max_minutes=None,
170        max_days=None,
171    )
172
173    ephemeris_data = factory.get_ephemeris_data(as_model=True)
174    print(ephemeris_data[0])
175    print(len(ephemeris_data))
176
177    for ephe in ephemeris_data:
178        print(ephe.planets[0]["abs_pos"])