Kosmorro
/
lib
mirror of https://github.com/Kosmorro/lib
1
0
Fork 0
Code Issues Releases 16 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.
108 Commits
6 Branches
840 KiB
 
 
Tree: cd240ce4eb
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'cd240ce4eb'
${ noResults }
lib/kosmorrolib/ephemerides.py

311 lines
18 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. from datetime import date, datetime, timedelta

  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.     next_phase_time = None

  44.     i = 0

  45. 

  46.     # Find the current moon phase:

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

  48.         if now.utc_datetime() <= time.utc_datetime():

  49.             if time.utc_datetime() >= tomorrow.utc_datetime():

  50.                 i -= 1

  51.             break

  52. 

  53.     current_phase = MoonPhaseType(vals[i])

  54. 

  55.     if current_phase in [

  56.         MoonPhaseType.NEW_MOON,

  57.         MoonPhaseType.FIRST_QUARTER,

  58.         MoonPhaseType.FULL_MOON,

  59.         MoonPhaseType.LAST_QUARTER,

  60.     ]:

  61.         current_phase_time = translate_to_timezone(times[i].utc_datetime(), timezone)

  62.     else:

  63.         current_phase_time = None

  64. 

  65.     # Find the next moon phase

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

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

  68.             next_phase_time = translate_to_timezone(times[j].utc_datetime(), timezone)

  69.             break

  70. 

  71.     return MoonPhase(current_phase, current_phase_time, next_phase_time)

  72. 

  73. 

  74. def get_moon_phase(for_date: date = date.today(), timezone: int = 0) -> MoonPhase:

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

  76. 

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

  78. 

  79.     >>> get_moon_phase(date(2021, 3, 27))

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

  81. 

  82.     When the moon phase is a new moon, a first quarter, a full moon or a last quarter, you get the exact time

  83.     of its happening too:

  84. 

  85.     >>> get_moon_phase(datetime(2021, 3, 28))

  86.     <MoonPhase phase_type=MoonPhaseType.FULL_MOON time=2021-03-28 18:48:10.902298+00:00 next_phase_date=2021-04-04 10:02:27.393689+00:00>

  87. 

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

  89. 

  90.     >>> get_moon_phase(date(2021, 3, 27), timezone=2)

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

  92. 

  93.     Note that the moon phase can only be computed for a date range.

  94.     Asking for the moon phase with an out of range date will result in an exception:

  95. 

  96.     >>> get_moon_phase(date(1000, 1, 1))

  97.     Traceback (most recent call last):

  98.         ...

  99.     kosmorrolib.exceptions.OutOfRangeDateError: The date must be between 1899-08-09 and 2053-09-26

  100.     """

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

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

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

  104. 

  105.     def moon_phase_at(time: Time):

  106.         time._nutation_angles = get_iau2000b(time)

  107.         current_earth = earth.at(time)

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

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

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

  111. 

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

  113. 

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

  115.     start_time = get_timescale().utc(for_date.year, for_date.month, for_date.day - 10)

  116.     end_time = get_timescale().utc(for_date.year, for_date.month, for_date.day + 10)

  117. 

  118.     try:

  119.         times, phases = find_discrete(start_time, end_time, moon_phase_at)

  120.         return _get_skyfield_to_moon_phase(times, phases, today, timezone)

  121. 

  122.     except EphemerisRangeError as error:

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

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

  125. 

  126.         start = date(start.year, start.month, start.day) + timedelta(days=12)

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

  128. 

  129.         raise OutOfRangeDateError(start, end) from error

  130. 

  131. 

  132. def get_ephemerides(

  133.     position: Position, for_date: date = date.today(), timezone: int = 0

  134. ) -> [AsterEphemerides]:

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

  136. 

  137.     Compute the ephemerides for July 7th, 2022:

  138. 

  139.     >>> get_ephemerides(Position(36.6794, 4.8555), date(2022, 7, 7))

  140.     [<AsterEphemerides rise_time=2022-07-07 04:29:00 culmination_time=2022-07-07 11:46:00 set_time=2022-07-07 19:02:00 aster=<Object type=STAR name=SUN />>,

  141.     <AsterEphemerides rise_time=2022-07-07 12:16:00 culmination_time=2022-07-07 18:06:00 set_time=2022-07-07 23:54:00 aster=<Object type=SATELLITE name=MOON />>,

  142.     <AsterEphemerides rise_time=2022-07-07 03:36:00 culmination_time=2022-07-07 10:58:00 set_time=2022-07-07 18:21:00 aster=<Object type=PLANET name=MERCURY />>,

  143.     <AsterEphemerides rise_time=2022-07-07 02:30:00 culmination_time=2022-07-07 09:44:00 set_time=2022-07-07 16:58:00 aster=<Object type=PLANET name=VENUS />>,

  144.     <AsterEphemerides rise_time=2022-07-07 00:05:00 culmination_time=2022-07-07 06:39:00 set_time=2022-07-07 13:14:00 aster=<Object type=PLANET name=MARS />>,

  145.     <AsterEphemerides rise_time=2022-07-07 22:59:00 culmination_time=2022-07-07 05:11:00 set_time=2022-07-07 11:20:00 aster=<Object type=PLANET name=JUPITER />>,

  146.     <AsterEphemerides rise_time=2022-07-07 21:06:00 culmination_time=2022-07-07 02:29:00 set_time=2022-07-07 07:48:00 aster=<Object type=PLANET name=SATURN />>,

  147.     <AsterEphemerides rise_time=2022-07-07 00:47:00 culmination_time=2022-07-07 07:42:00 set_time=2022-07-07 14:38:00 aster=<Object type=PLANET name=URANUS />>,

  148.     <AsterEphemerides rise_time=2022-07-07 22:27:00 culmination_time=2022-07-07 04:25:00 set_time=2022-07-07 10:20:00 aster=<Object type=PLANET name=NEPTUNE />>,

  149.     <AsterEphemerides rise_time=2022-07-07 19:46:00 culmination_time=2022-07-07 00:41:00 set_time=2022-07-07 05:33:00 aster=<Object type=PLANET name=PLUTO />>]

  150. 

  151.     Timezone can be optionnaly set to adapt the hours to your location:

  152. 

  153.     >>> get_ephemerides(Position(36.6794, 4.8555), date(2022, 7, 7), timezone=2)

  154.     [<AsterEphemerides rise_time=2022-07-07 06:29:00 culmination_time=2022-07-07 13:46:00 set_time=2022-07-07 21:02:00 aster=<Object type=STAR name=SUN />>,

  155.     <AsterEphemerides rise_time=2022-07-07 14:16:00 culmination_time=2022-07-07 20:06:00 set_time=2022-07-07 01:27:00 aster=<Object type=SATELLITE name=MOON />>,

  156.     <AsterEphemerides rise_time=2022-07-07 05:36:00 culmination_time=2022-07-07 12:58:00 set_time=2022-07-07 20:21:00 aster=<Object type=PLANET name=MERCURY />>,

  157.     <AsterEphemerides rise_time=2022-07-07 04:30:00 culmination_time=2022-07-07 11:44:00 set_time=2022-07-07 18:58:00 aster=<Object type=PLANET name=VENUS />>,

  158.     <AsterEphemerides rise_time=2022-07-07 02:05:00 culmination_time=2022-07-07 08:39:00 set_time=2022-07-07 15:14:00 aster=<Object type=PLANET name=MARS />>,

  159.     <AsterEphemerides rise_time=2022-07-07 01:02:00 culmination_time=2022-07-07 07:11:00 set_time=2022-07-07 13:20:00 aster=<Object type=PLANET name=JUPITER />>,

  160.     <AsterEphemerides rise_time=2022-07-07 23:06:00 culmination_time=2022-07-07 04:29:00 set_time=2022-07-07 09:48:00 aster=<Object type=PLANET name=SATURN />>,

  161.     <AsterEphemerides rise_time=2022-07-07 02:47:00 culmination_time=2022-07-07 09:42:00 set_time=2022-07-07 16:38:00 aster=<Object type=PLANET name=URANUS />>,

  162.     <AsterEphemerides rise_time=2022-07-07 00:31:00 culmination_time=2022-07-07 06:25:00 set_time=2022-07-07 12:20:00 aster=<Object type=PLANET name=NEPTUNE />>,

  163.     <AsterEphemerides rise_time=2022-07-07 21:46:00 culmination_time=2022-07-07 02:41:00 set_time=2022-07-07 07:33:00 aster=<Object type=PLANET name=PLUTO />>]

  164. 

  165. 

  166.     Objects may not rise or set on the given date (e.g. they rise the previous day or set the next day).

  167.     In this case, you will get `None` values on the rise or set time.

  168. 

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

  170. 

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

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

  173.     >>> get_ephemerides(north_pole, date(2021, 6, 20))

  174.     [<AsterEphemerides rise_time=None culmination_time=2021-06-20 10:42:00 set_time=None aster=<Object type=STAR name=SUN />>,

  175.     <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 />>,

  176.     <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 />>,

  177.     <AsterEphemerides rise_time=None culmination_time=2021-06-20 12:20:00 set_time=None aster=<Object type=PLANET name=VENUS />>,

  178.     <AsterEphemerides rise_time=None culmination_time=2021-06-20 13:17:00 set_time=None aster=<Object type=PLANET name=MARS />>,

  179.     <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 />>,

  180.     <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 />>,

  181.     <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 />>,

  182.     <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 />>,

  183.     <AsterEphemerides rise_time=None culmination_time=2021-06-20 00:40:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  184. 

  185.     >>> get_ephemerides(north_pole, date(2021, 12, 21))

  186.     [<AsterEphemerides rise_time=None culmination_time=2021-12-21 10:38:00 set_time=None aster=<Object type=STAR name=SUN />>,

  187.     <AsterEphemerides rise_time=None culmination_time=2021-12-21 00:04:00 set_time=None aster=<Object type=SATELLITE name=MOON />>,

  188.     <AsterEphemerides rise_time=None culmination_time=2021-12-21 11:33:00 set_time=None aster=<Object type=PLANET name=MERCURY />>,

  189.     <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 />>,

  190.     <AsterEphemerides rise_time=None culmination_time=2021-12-21 08:54:00 set_time=None aster=<Object type=PLANET name=MARS />>,

  191.     <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 />>,

  192.     <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 />>,

  193.     <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 />>,

  194.     <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 />>,

  195.     <AsterEphemerides rise_time=None culmination_time=2021-12-21 12:31:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  196. 

  197.     >>> get_ephemerides(south_pole, date(2021, 6, 20))

  198.     [<AsterEphemerides rise_time=None culmination_time=2021-06-20 10:42:00 set_time=None aster=<Object type=STAR name=SUN />>,

  199.     <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 />>,

  200.     <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 />>,

  201.     <AsterEphemerides rise_time=None culmination_time=2021-06-20 12:20:00 set_time=None aster=<Object type=PLANET name=VENUS />>,

  202.     <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 />>,

  203.     <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 />>,

  204.     <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 />>,

  205.     <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 />>,

  206.     <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 />>,

  207.     <AsterEphemerides rise_time=None culmination_time=2021-06-20 00:40:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  208. 

  209.     >>> get_ephemerides(south_pole, date(2021, 12, 22))

  210.     [<AsterEphemerides rise_time=None culmination_time=2021-12-22 10:39:00 set_time=None aster=<Object type=STAR name=SUN />>,

  211.     <AsterEphemerides rise_time=None culmination_time=2021-12-22 01:01:00 set_time=None aster=<Object type=SATELLITE name=MOON />>,

  212.     <AsterEphemerides rise_time=None culmination_time=2021-12-22 11:35:00 set_time=None aster=<Object type=PLANET name=MERCURY />>,

  213.     <AsterEphemerides rise_time=None culmination_time=2021-12-22 12:27:00 set_time=None aster=<Object type=PLANET name=VENUS />>,

  214.     <AsterEphemerides rise_time=None culmination_time=2021-12-22 08:53:00 set_time=None aster=<Object type=PLANET name=MARS />>,

  215.     <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 />>,

  216.     <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 />>,

  217.     <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 />>,

  218.     <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 />>,

  219.     <AsterEphemerides rise_time=None culmination_time=2021-12-22 12:27:00 set_time=None aster=<Object type=PLANET name=PLUTO />>]

  220. 

  221.     Please note:

  222.     - The ephemerides can only be computed for a date range. Asking for the ephemerides with an out of range date will result in an exception:

  223. 

  224.       >>> get_ephemerides(Position(50.5824, 3.0624), date(1000, 1, 1))

  225.       Traceback (most recent call last):

  226.           ...

  227.       kosmorrolib.exceptions.OutOfRangeDateError: The date must be between 1899-07-29 and 2053-10-07

  228. 

  229.     - The date given in parameter is considered as being given from the point of view of the given timezone.

  230.       Using a timezone that does not correspond to the place's actual one can impact the returned times.

  231.     """

  232. 

  233.     def get_angle(for_aster: Object):

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

  235.             return (

  236.                 position.get_planet_topos()

  237.                 .at(time)

  238.                 .observe(for_aster.skyfield_object)

  239.                 .apparent()

  240.                 .altaz()[0]

  241.                 .degrees

  242.             )

  243. 

  244.         fun.rough_period = 1.0

  245.         return fun

  246. 

  247.     def is_risen(for_aster: Object):

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

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

  250. 

  251.         fun.rough_period = 0.5

  252.         return fun

  253. 

  254.     # The date given in argument is supposed to be given in the given timezone (more natural for a human),

  255.     # but we need it in UTC. Subtracting the timezone to get it in UTC.

  256. 

  257.     start_time = get_timescale().utc(

  258.         for_date.year, for_date.month, for_date.day, -timezone

  259.     )

  260. 

  261.     end_time = get_timescale().utc(

  262.         for_date.year, for_date.month, for_date.day + 1, -timezone

  263.     )

  264. 

  265.     ephemerides = []

  266. 

  267.     try:

  268.         for aster in ASTERS:

  269.             times, risen_info = find_discrete(start_time, end_time, is_risen(aster))

  270.             culmination_time, _ = find_maxima(start_time, end_time, get_angle(aster))

  271. 

  272.             rise_time, set_time = None, None

  273.             culmination_time = (

  274.                 culmination_time[0] if len(culmination_time) == 1 else None

  275.             )

  276. 

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

  278.                 time_dt = normalize_datetime(

  279.                     translate_to_timezone(time.utc_datetime(), to_tz=timezone)

  280.                 )

  281. 

  282.                 if time_dt is not None and time_dt.day != for_date.day:

  283.                     continue

  284. 

  285.                 if risen_info[i]:

  286.                     rise_time = time_dt

  287.                 else:

  288.                     set_time = time_dt

  289. 

  290.             if culmination_time is not None:

  291.                 culmination_time = normalize_datetime(

  292.                     translate_to_timezone(

  293.                         culmination_time.utc_datetime(),

  294.                         to_tz=timezone,

  295.                     )

  296.                 )

  297. 

  298.             ephemerides.append(

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

  300.             )

  301.     except EphemerisRangeError as error:

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

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

  304. 

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

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

  307. 

  308.         raise OutOfRangeDateError(start, end) from error

  309. 

  310.     return ephemerides