mirror/astronomy
1
0
Fork 0
mirror of https://github.com/cosinekitty/astronomy.git synced 2026-05-19 06:17:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

pydown: Split classes into regular classes, enums, and errors.

Browse Source 
Will generate different Markdown for my regular classes,
enumerated types, and error types.

Found out that 'from enum import IntEnum' pulls IntEnum
into the astronomy module and causes us to try to generate
documentation for it. Just keep it in the enum module.

Removed spurious dump of JavaScript README.md when verify_clean
fails.
This commit is contained in:
Don Cross
2019-07-10 21:57:07 -04:00
parent 1834b18ca0
commit 033a2a1b53
5 changed files with 66 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
source/python/README.md
View File

@@ -1,87 +1,7 @@
---
<a name="functions"></a>
## Functions
---
<a name="ApsisKind"></a>
### class ApsisKind
---
<a name="BadVectorError"></a>
### class BadVectorError
---
<a name="Body"></a>
### class Body
---
<a name="Direction"></a>
### class Direction
---
<a name="EarthNotAllowedError"></a>
### class EarthNotAllowedError
---
<a name="Error"></a>
### class Error
---
<a name="IntEnum"></a>
### class IntEnum
---
<a name="InternalError"></a>
### class InternalError
---
<a name="InvalidBodyError"></a>
### class InvalidBodyError
---
<a name="NoConvergeError"></a>
### class NoConvergeError
<a name="classes"></a>
## Classes
---
@@ -94,14 +14,6 @@
---
<a name="Refraction"></a>
### class Refraction
---
<a name="Time"></a>
@@ -113,9 +25,19 @@
| --- | --- | --- |
| `float` | `ut` | UT1/UTC number of days since noon on January 1, 2000. See the `ut` attribute of this class for more details. |
| Type | Attribute | Description |
| --- | --- | --- |
| `float` | `ut` | The floating point number of days of Universal Time since noon UTC January 1, 2000. Astronomy Engine approximates UTC and UT1 as being the same thing, although they are not exactly equivalent; UTC and UT1 can disagree by up to 0.9 seconds. This approximation is sufficient for the accuracy requirements of Astronomy Engine. Universal Time Coordinate (UTC) is the international standard for legal and civil timekeeping and replaces the older Greenwich Mean Time (GMT) standard. UTC is kept in sync with unpredictable observed changes in the Earth's rotation by occasionally adding leap seconds as needed. UT1 is an idealized time scale based on observed rotation of the Earth, which gradually slows down in an unpredictable way over time, due to tidal drag by the Moon and Sun, large scale weather events like hurricanes, and internal seismic and convection effects. Conceptually, UT1 drifts from atomic time continuously and erratically, whereas UTC is adjusted by a scheduled whole number of leap seconds as needed. The value in `ut` is appropriate for any calculation involving the Earth's rotation, such as calculating rise/set times, culumination, and anything involving apparent sidereal time. Before the era of atomic timekeeping, days based on the Earth's rotation were often known as *mean solar days*. |
| `float` | `tt` | Terrestrial Time days since noon on January 1, 2000. Terrestrial Time is an atomic time scale defined as a number of days since noon on January 1, 2000. In this system, days are not based on Earth rotations, but instead by the number of elapsed [SI seconds](https://physics.nist.gov/cuu/Units/second.html) divided by 86400. Unlike `ut`, `tt` increases uniformly without adjustments for changes in the Earth's rotation. The value in `tt` is used for calculations of movements not involving the Earth's rotation, such as the orbits of planets around the Sun, or the Moon around the Earth. Historically, Terrestrial Time has also been known by the term *Ephemeris Time* (ET). |
---
<a name="functions"></a>
## Functions
---
<a name="BodyCode"></a>
@@ -143,11 +65,3 @@
---
<a name="unique"></a>
### unique(enumeration)

18
source/python/astronomy.py
View File

@@ -33,7 +33,7 @@ https://github.com/cosinekitty/astronomy
import math
import datetime
from enum import IntEnum, unique
import enum
_PI2 = 2.0 * math.pi
_EPOCH = datetime.datetime(2000, 1, 1, 12)
@@ -83,8 +83,8 @@ class Vector:
def Length(self):
return math.sqrt(self.x**2 + self.y**2 + self.z**2)
@unique
class Body(IntEnum):
@enum.unique
class Body(enum.IntEnum):
Invalid = -1
"""A placeholder value for an unknown, undefined, or invalid body."""
@@ -3077,8 +3077,8 @@ def Equator(body, time, observer, ofdate, aberration):
datevect = _nutation(time, 0, temp)
return _vector2radec(datevect)
@unique
class Refraction(IntEnum):
@enum.unique
class Refraction(enum.IntEnum):
Airless = 0
Normal = 1
JplHorizons = 2
@@ -3705,8 +3705,8 @@ def SearchHourAngle(body, observer, hourAngle, startTime):
delta_days = (delta_sidereal_hours / 24.0) * _SOLAR_DAYS_PER_SIDEREAL_DAY
time = time.AddDays(delta_days)
@unique
class Direction(IntEnum):
@enum.unique
class Direction(enum.IntEnum):
Rise = +1
Set = -1
@@ -3825,8 +3825,8 @@ def _distance_slope(direction, time):
dist2 = _MoonDistance(t2)
return direction * (dist2 - dist1) / dt
@unique
class ApsisKind(IntEnum):
@enum.unique
class ApsisKind(enum.IntEnum):
Pericenter = 0
Apocenter = 1
Invalid = 2