Kosmorro
/
lib
mirror of https://github.com/Kosmorro/lib
1
0
Fork 0
Code Issues Releases 15 Activity
A library that computes the ephemerides.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
71 Commits
5 Branches
854 KiB
 
 
Tree: c7a4df9e1a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c7a4df9e1a'
${ noResults }
lib/kosmorrolib/ephemerides.py

253 lines
17 KiB
Raw Blame History 

  1. #!/usr/bin/env python3

  2. 

  3. #    Kosmorrolib - The Library To Compute Your Ephemerides

  4. #    Copyright (C) 2021  Jérôme Deuchnord <jerome@deuchnord.fr>

  5. #

  6. #    This program is free software: you can redistribute it and/or modify

  7. #    it under the terms of the GNU Affero General Public License as

  8. #    published by the Free Software Foundation, either version 3 of the

  9. #    License, or (at your option) any later version.

  10. #

  11. #    This program is distributed in the hope that it will be useful,

  12. #    but WITHOUT ANY WARRANTY; without even the implied warranty of

  13. #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  14. #    GNU Affero General Public License for more details.

  15. #

  16. #    You should have received a copy of the GNU Affero General Public License

  17. #    along with this program.  If not, see <https://www.gnu.org/licenses/>.

  18. 

  19. import datetime

  20. from typing import Union

  21. 

  22. from skyfield.searchlib import find_discrete, find_maxima

  23. from skyfield.timelib import Time

  24. from skyfield.constants import tau

  25. from skyfield.errors import EphemerisRangeError

  26. 

  27. from .model import Position, AsterEphemerides, MoonPhase, Object, ASTERS

  28. from .dateutil import translate_to_timezone, normalize_datetime

  29. from .core import get_skf_objects, get_timescale, get_iau2000b

  30. from .enum import MoonPhaseType

  31. from .exceptions import OutOfRangeDateError

  32. 

  33. RISEN_ANGLE = -0.8333

  34. 

  35. 

  36. def _get_skyfield_to_moon_phase(

  37.     times: [Time], vals: [int], now: Time, timezone: int

  38. ) -> Union[MoonPhase, None]:

  39.     tomorrow = get_timescale().utc(

  40.         now.utc_datetime().year, now.utc_datetime().month, now.utc_datetime().day + 1

  41.     )

  42. 

  43.     phases = list(MoonPhaseType)

  44.     current_phase = None

  45.     current_phase_time = None

  46.     next_phase_time = None

  47.     i = 0

  48. 

  49.     if len(times) == 0:

  50.         return None

  51. 

  52.     for i, time in enumerate(times):

  53.         if now.utc_iso() <= time.utc_iso():

  54.             if vals[i] in [0, 2, 4, 6]:

  55.                 if time.utc_datetime() < tomorrow.utc_datetime():

  56.                     current_phase_time = time

  57.                     current_phase = phases[vals[i]]

  58.                 else:

  59.                     i -= 1

  60.                     current_phase_time = None

  61.                     current_phase = phases[vals[i]]

  62.             else:

  63.                 current_phase = phases[vals[i]]

  64. 

  65.             break

  66. 

  67.     for j in range(i + 1, len(times)):

  68.         if vals[j] in [0, 2, 4, 6]:

  69.             next_phase_time = times[j]

  70.             break

  71. 

  72.     return MoonPhase(

  73.         current_phase,

  74.         translate_to_timezone(current_phase_time.utc_datetime(), timezone)

  75.         if current_phase_time is not None

  76.         else None,

  77.         translate_to_timezone(next_phase_time.utc_datetime(), timezone)

  78.         if next_phase_time is not None

  79.         else None,

  80.     )

  81. 

  82. 

  83. def get_moon_phase(

  84.     for_date: datetime.date = datetime.date.today(), timezone: int = 0

  85. ) -> MoonPhase:

  86.     """Calculate and return the moon phase for the given date, adjusted to the given timezone if any.

  87. 

  88.     Get the moon phase for the 27 March, 2021:

  89. 

  90.     >>> get_moon_phase(datetime.date.fromisoformat("2021-03-27"))

  91.     <MoonPhase phase_type=MoonPhaseType.WAXING_GIBBOUS time=None next_phase_date=2021-03-28 18:48:10.902298+00:00>

  92. 

  93.     Get the moon phase for the 27 March, 2021, in the UTC+2 timezone:

  94. 

  95.     >>> get_moon_phase(datetime.date.fromisoformat("2021-03-27"), timezone=2)

  96.     <MoonPhase phase_type=MoonPhaseType.WAXING_GIBBOUS time=None next_phase_date=2021-03-28 20:48:10.902298+02:00>

  97.     """

  98.     earth = get_skf_objects()["earth"]

  99.     moon = get_skf_objects()["moon"]

  100.     sun = get_skf_objects()["sun"]

  101. 

  102.     def moon_phase_at(time: Time):

  103.         time._nutation_angles = get_iau2000b(time)

  104.         current_earth = earth.at(time)

  105.         _, mlon, _ = current_earth.observe(moon).apparent().ecliptic_latlon("date")

  106.         _, slon, _ = current_earth.observe(sun).apparent().ecliptic_latlon("date")

  107.         return (((mlon.radians - slon.radians) // (tau / 8)) % 8).astype(int)

  108. 

  109.     moon_phase_at.rough_period = 7.0  # one lunar phase per week

  110. 

  111.     today = get_timescale().utc(for_date.year, for_date.month, for_date.day)

  112.     time1 = get_timescale().utc(for_date.year, for_date.month, for_date.day - 10)

  113.     time2 = get_timescale().utc(for_date.year, for_date.month, for_date.day + 10)

  114. 

  115.     try:

  116.         times, phase = find_discrete(time1, time2, moon_phase_at)

  117.     except EphemerisRangeError as error:

  118.         start = translate_to_timezone(error.start_time.utc_datetime(), timezone)

  119.         end = translate_to_timezone(error.end_time.utc_datetime(), timezone)

  120. 

  121.         start = datetime.date(start.year, start.month, start.day) + datetime.timedelta(

  122.             days=12

  123.         )

  124.         end = datetime.date(end.year, end.month, end.day) - datetime.timedelta(days=12)

  125. 

  126.         raise OutOfRangeDateError(start, end) from error

  127. 

  128.     return _get_skyfield_to_moon_phase(times, phase, today, timezone)

  129. 

  130. 

  131. def get_ephemerides(

  132.     position: Position, date: datetime.date = datetime.date.today(), timezone: int = 0

  133. ) -> [AsterEphemerides]:

  134.     """Compute and return the ephemerides for the given position and date, adjusted to the given timezone if any.

  135. 

  136.     Compute the ephemerides for June 9th, 2021:

  137. 

  138.     >>> pos = Position(50.5824, 3.0624)

  139.     >>> get_ephemerides(pos, datetime.date(2021, 6, 9))

  140.     [<AsterEphemerides rise_time=2021-06-09 03:36:00 culmination_time=2021-06-09 11:47:00 set_time=2021-06-09 19:58:00 aster=<Object type=STAR name=SUN />>, <AsterEphemerides rise_time=2021-06-09 02:59:00 culmination_time=2021-06-09 11:02:00 set_time=2021-06-09 19:16:00 aster=<Object type=SATELLITE name=MOON />>, <AsterEphemerides rise_time=2021-06-09 04:06:00 culmination_time=2021-06-09 11:58:00 set_time=2021-06-09 19:49:00 aster=<Object type=PLANET name=MERCURY />>, <AsterEphemerides rise_time=2021-06-09 04:52:00 culmination_time=2021-06-09 13:13:00 set_time=2021-06-09 21:34:00 aster=<Object type=PLANET name=VENUS />>, <AsterEphemerides rise_time=2021-06-09 06:38:00 culmination_time=2021-06-09 14:40:00 set_time=2021-06-09 22:41:00 aster=<Object type=PLANET name=MARS />>, <AsterEphemerides rise_time=2021-06-09 23:43:00 culmination_time=2021-06-09 04:54:00 set_time=2021-06-09 10:01:00 aster=<Object type=PLANET name=JUPITER />>, <AsterEphemerides rise_time=2021-06-09 23:02:00 culmination_time=2021-06-09 03:41:00 set_time=2021-06-09 08:16:00 aster=<Object type=PLANET name=SATURN />>, <AsterEphemerides rise_time=2021-06-09 01:56:00 culmination_time=2021-06-09 09:18:00 set_time=2021-06-09 16:40:00 aster=<Object type=PLANET name=URANUS />>, <AsterEphemerides rise_time=2021-06-09 00:27:00 culmination_time=2021-06-09 06:13:00 set_time=2021-06-09 11:59:00 aster=<Object type=PLANET name=NEPTUNE />>, <AsterEphemerides rise_time=2021-06-09 22:22:00 culmination_time=2021-06-09 02:32:00 set_time=2021-06-09 06:38:00 aster=<Object type=PLANET name=PLUTO />>]

  141. 

  142.     Compute the ephemerides for June 9th, 2021:

  143. 

  144.     >>> get_ephemerides(pos, datetime.date(2021, 6, 9), timezone=2)

  145.     [<AsterEphemerides rise_time=2021-06-09 05:36:00 culmination_time=2021-06-09 13:47:00 set_time=2021-06-09 21:58:00 aster=<Object type=STAR name=SUN />>, <AsterEphemerides rise_time=2021-06-09 04:59:00 culmination_time=2021-06-09 13:02:00 set_time=2021-06-09 21:16:00 aster=<Object type=SATELLITE name=MOON />>, <AsterEphemerides rise_time=2021-06-09 06:06:00 culmination_time=2021-06-09 13:58:00 set_time=2021-06-09 21:49:00 aster=<Object type=PLANET name=MERCURY />>, <AsterEphemerides rise_time=2021-06-09 06:52:00 culmination_time=2021-06-09 15:13:00 set_time=2021-06-09 23:34:00 aster=<Object type=PLANET name=VENUS />>, <AsterEphemerides rise_time=2021-06-09 08:38:00 culmination_time=2021-06-09 16:40:00 set_time=2021-06-09 00:44:00 aster=<Object type=PLANET name=MARS />>, <AsterEphemerides rise_time=2021-06-09 01:47:00 culmination_time=2021-06-09 06:54:00 set_time=2021-06-09 12:01:00 aster=<Object type=PLANET name=JUPITER />>, <AsterEphemerides rise_time=2021-06-09 01:06:00 culmination_time=2021-06-09 05:41:00 set_time=2021-06-09 10:16:00 aster=<Object type=PLANET name=SATURN />>, <AsterEphemerides rise_time=2021-06-09 03:56:00 culmination_time=2021-06-09 11:18:00 set_time=2021-06-09 18:40:00 aster=<Object type=PLANET name=URANUS />>, <AsterEphemerides rise_time=2021-06-09 02:27:00 culmination_time=2021-06-09 08:13:00 set_time=2021-06-09 13:59:00 aster=<Object type=PLANET name=NEPTUNE />>, <AsterEphemerides rise_time=2021-06-09 00:26:00 culmination_time=2021-06-09 04:32:00 set_time=2021-06-09 08:38:00 aster=<Object type=PLANET name=PLUTO />>]

  146. 

  147.     If an objet does not rise nor set due to your latitude, then both rise and set will be `None`:

  148. 

  149.     >>> north_pole = Position(70, 20)

  150.     >>> south_pole = Position(-70, 20)

  151.     >>> get_ephemerides(north_pole, datetime.date(2021, 6, 20))

  152.     [<AsterEphemerides rise_time=None culmination_time=2021-06-20 10:42:00 set_time=None aster=<Object type=STAR name=SUN />>, <AsterEphemerides rise_time=2021-06-20 14:30:00 culmination_time=2021-06-20 18:44:00 set_time=2021-06-20 22:53:00 aster=<Object type=SATELLITE name=MOON />>, <AsterEphemerides rise_time=2021-06-20 22:56:00 culmination_time=2021-06-20 09:47:00 set_time=2021-06-20 20:34:00 aster=<Object type=PLANET name=MERCURY />>, <AsterEphemerides rise_time=None culmination_time=2021-06-20 12:20:00 set_time=None aster=<Object type=PLANET name=VENUS />>, <AsterEphemerides rise_time=None culmination_time=2021-06-20 13:17:00 set_time=None aster=<Object type=PLANET name=MARS />>, <AsterEphemerides rise_time=2021-06-20 23:06:00 culmination_time=2021-06-20 03:04:00 set_time=2021-06-20 06:58:00 aster=<Object type=PLANET name=JUPITER />>, <AsterEphemerides rise_time=2021-06-20 23:28:00 culmination_time=2021-06-20 01:48:00 set_time=2021-06-20 04:05:00 aster=<Object type=PLANET name=SATURN />>, <AsterEphemerides rise_time=2021-06-20 21:53:00 culmination_time=2021-06-20 07:29:00 set_time=2021-06-20 17:02:00 aster=<Object type=PLANET name=URANUS />>, <AsterEphemerides rise_time=2021-06-20 22:51:00 culmination_time=2021-06-20 04:22:00 set_time=2021-06-20 09:50:00 aster=<Object type=PLANET name=NEPTUNE />>, <AsterEphemerides rise_time=None culmination_time=2021-06-20 00:40:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  153. 

  154.     >>> get_ephemerides(north_pole, datetime.date(2021, 12, 21))

  155.     [<AsterEphemerides rise_time=None culmination_time=2021-12-21 10:38:00 set_time=None aster=<Object type=STAR name=SUN />>, <AsterEphemerides rise_time=None culmination_time=2021-12-21 00:04:00 set_time=None aster=<Object type=SATELLITE name=MOON />>, <AsterEphemerides rise_time=None culmination_time=2021-12-21 11:33:00 set_time=None aster=<Object type=PLANET name=MERCURY />>, <AsterEphemerides rise_time=2021-12-21 11:58:00 culmination_time=2021-12-21 12:33:00 set_time=2021-12-21 13:08:00 aster=<Object type=PLANET name=VENUS />>, <AsterEphemerides rise_time=None culmination_time=2021-12-21 08:54:00 set_time=None aster=<Object type=PLANET name=MARS />>, <AsterEphemerides rise_time=2021-12-21 11:07:00 culmination_time=2021-12-21 14:43:00 set_time=2021-12-21 18:19:00 aster=<Object type=PLANET name=JUPITER />>, <AsterEphemerides rise_time=2021-12-21 11:32:00 culmination_time=2021-12-21 13:33:00 set_time=2021-12-21 15:33:00 aster=<Object type=PLANET name=SATURN />>, <AsterEphemerides rise_time=2021-12-21 09:54:00 culmination_time=2021-12-21 19:13:00 set_time=2021-12-21 04:37:00 aster=<Object type=PLANET name=URANUS />>, <AsterEphemerides rise_time=2021-12-21 10:49:00 culmination_time=2021-12-21 16:05:00 set_time=2021-12-21 21:21:00 aster=<Object type=PLANET name=NEPTUNE />>, <AsterEphemerides rise_time=None culmination_time=2021-12-21 12:31:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  156. 

  157.     >>> get_ephemerides(south_pole, datetime.date(2021, 6, 20))

  158.     [<AsterEphemerides rise_time=None culmination_time=2021-06-20 10:42:00 set_time=None aster=<Object type=STAR name=SUN />>, <AsterEphemerides rise_time=2021-06-20 11:10:00 culmination_time=2021-06-20 19:06:00 set_time=2021-06-20 01:20:00 aster=<Object type=SATELLITE name=MOON />>, <AsterEphemerides rise_time=2021-06-20 07:47:00 culmination_time=2021-06-20 09:47:00 set_time=2021-06-20 11:48:00 aster=<Object type=PLANET name=MERCURY />>, <AsterEphemerides rise_time=None culmination_time=2021-06-20 12:20:00 set_time=None aster=<Object type=PLANET name=VENUS />>, <AsterEphemerides rise_time=2021-06-20 12:14:00 culmination_time=2021-06-20 13:17:00 set_time=2021-06-20 14:21:00 aster=<Object type=PLANET name=MARS />>, <AsterEphemerides rise_time=2021-06-20 18:32:00 culmination_time=2021-06-20 03:04:00 set_time=2021-06-20 11:32:00 aster=<Object type=PLANET name=JUPITER />>, <AsterEphemerides rise_time=2021-06-20 15:20:00 culmination_time=2021-06-20 01:48:00 set_time=2021-06-20 12:12:00 aster=<Object type=PLANET name=SATURN />>, <AsterEphemerides rise_time=2021-06-20 04:32:00 culmination_time=2021-06-20 07:29:00 set_time=2021-06-20 10:26:00 aster=<Object type=PLANET name=URANUS />>, <AsterEphemerides rise_time=2021-06-20 21:28:00 culmination_time=2021-06-20 04:22:00 set_time=2021-06-20 11:13:00 aster=<Object type=PLANET name=NEPTUNE />>, <AsterEphemerides rise_time=None culmination_time=2021-06-20 00:40:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  159. 

  160.     >>> get_ephemerides(south_pole, datetime.date(2021, 12, 22))

  161.     [<AsterEphemerides rise_time=None culmination_time=2021-12-22 10:39:00 set_time=None aster=<Object type=STAR name=SUN />>, <AsterEphemerides rise_time=None culmination_time=2021-12-22 01:01:00 set_time=None aster=<Object type=SATELLITE name=MOON />>, <AsterEphemerides rise_time=None culmination_time=2021-12-22 11:35:00 set_time=None aster=<Object type=PLANET name=MERCURY />>, <AsterEphemerides rise_time=None culmination_time=2021-12-22 12:27:00 set_time=None aster=<Object type=PLANET name=VENUS />>, <AsterEphemerides rise_time=None culmination_time=2021-12-22 08:53:00 set_time=None aster=<Object type=PLANET name=MARS />>, <AsterEphemerides rise_time=2021-12-22 05:52:00 culmination_time=2021-12-22 14:40:00 set_time=2021-12-22 23:26:00 aster=<Object type=PLANET name=JUPITER />>, <AsterEphemerides rise_time=2021-12-22 02:41:00 culmination_time=2021-12-22 13:29:00 set_time=2021-12-22 00:21:00 aster=<Object type=PLANET name=SATURN />>, <AsterEphemerides rise_time=2021-12-22 16:01:00 culmination_time=2021-12-22 19:09:00 set_time=2021-12-22 22:17:00 aster=<Object type=PLANET name=URANUS />>, <AsterEphemerides rise_time=2021-12-22 08:59:00 culmination_time=2021-12-22 16:01:00 set_time=2021-12-22 23:04:00 aster=<Object type=PLANET name=NEPTUNE />>, <AsterEphemerides rise_time=None culmination_time=2021-12-22 12:27:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  162.     """

  163.     ephemerides = []

  164. 

  165.     def get_angle(for_aster: Object):

  166.         def fun(time: Time) -> float:

  167.             return (

  168.                 position.get_planet_topos()

  169.                 .at(time)

  170.                 .observe(for_aster.get_skyfield_object())

  171.                 .apparent()

  172.                 .altaz()[0]

  173.                 .degrees

  174.             )

  175. 

  176.         fun.rough_period = 1.0

  177.         return fun

  178. 

  179.     def is_risen(for_aster: Object):

  180.         def fun(time: Time) -> bool:

  181.             return get_angle(for_aster)(time) > RISEN_ANGLE

  182. 

  183.         fun.rough_period = 0.5

  184.         return fun

  185. 

  186.     start_time = get_timescale().utc(date.year, date.month, date.day, -timezone)

  187.     end_time = get_timescale().utc(

  188.         date.year, date.month, date.day, 23 - timezone, 59, 59

  189.     )

  190. 

  191.     try:

  192.         for aster in ASTERS:

  193.             rise_times, arr = find_discrete(start_time, end_time, is_risen(aster))

  194.             try:

  195.                 culmination_time, _ = find_maxima(

  196.                     start_time,

  197.                     end_time,

  198.                     f=get_angle(aster),

  199.                     epsilon=1.0 / 3600 / 24,

  200.                     num=12,

  201.                 )

  202.                 culmination_time = (

  203.                     culmination_time[0] if len(culmination_time) > 0 else None

  204.                 )

  205.             except ValueError:

  206.                 culmination_time = None

  207. 

  208.             rise_time, set_time = None, None

  209. 

  210.             if len(rise_times) == 2:

  211.                 rise_time = rise_times[0 if arr[0] else 1]

  212.                 set_time = rise_times[1 if not arr[1] else 0]

  213.             elif len(rise_times) == 1:

  214.                 rise_time = rise_times[0] if arr[0] else None

  215.                 set_time = rise_times[0] if not arr[0] else None

  216. 

  217.             # Convert the Time instances to Python datetime objects

  218.             if rise_time is not None:

  219.                 rise_time = normalize_datetime(

  220.                     translate_to_timezone(

  221.                         rise_time.utc_datetime().replace(microsecond=0), to_tz=timezone

  222.                     )

  223.                 )

  224. 

  225.             if culmination_time is not None:

  226.                 culmination_time = normalize_datetime(

  227.                     translate_to_timezone(

  228.                         culmination_time.utc_datetime().replace(microsecond=0),

  229.                         to_tz=timezone,

  230.                     )

  231.                 )

  232. 

  233.             if set_time is not None:

  234.                 set_time = normalize_datetime(

  235.                     translate_to_timezone(

  236.                         set_time.utc_datetime().replace(microsecond=0), to_tz=timezone

  237.                     )

  238.                 )

  239. 

  240.             ephemerides.append(

  241.                 AsterEphemerides(rise_time, culmination_time, set_time, aster=aster)

  242.             )

  243.     except EphemerisRangeError as error:

  244.         start = translate_to_timezone(error.start_time.utc_datetime(), timezone)

  245.         end = translate_to_timezone(error.end_time.utc_datetime(), timezone)

  246. 

  247.         start = datetime.date(start.year, start.month, start.day + 1)

  248.         end = datetime.date(end.year, end.month, end.day - 1)

  249. 

  250.         raise OutOfRangeDateError(start, end) from error

  251. 

  252.     return ephemerides