From 100417dbe369b35cb8b1ec528874141788cd2d24 Mon Sep 17 00:00:00 2001 From: Don Cross Date: Sun, 14 Jun 2020 15:05:01 -0400 Subject: [PATCH] Fixed #52 - Finished documenting transit functions. This completes work on eclipses and transits. --- README.md | 4 +++- csdown/csharp_prefix.md | 4 +++- hydrogen/c_prefix.md | 4 +++- jsdoc2md/js.hbs | 4 +++- pydown/py_prefix.md | 4 +++- source/c/README.md | 4 +++- source/csharp/README.md | 4 +++- source/js/README.md | 4 +++- source/python/README.md | 4 +++- 9 files changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2900a041..6943552f 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Astronomy Engine is a suite of open source libraries for calculating positions of the Sun, Moon, and planets, and for predicting interesting events like oppositions, -conjunctions, rise and set times, lunar phases, and more. +conjunctions, rise and set times, lunar phases, eclipses, transits, and more. It supports several popular programming langauges with a consistent API. Function and type names are uniform across all the supported languages. @@ -81,6 +81,8 @@ Calculations are also verified to be identical among all the supported programmi - Predicts lunar and solar eclipses. +- Predicts transits of Mercury and Venus. + - Predicts lunar apogee and perigee dates, times, and distances. - Predicts date and time of equinoxes and solstices for a given calendar year. diff --git a/csdown/csharp_prefix.md b/csdown/csharp_prefix.md index 18906842..d3549827 100644 --- a/csdown/csharp_prefix.md +++ b/csdown/csharp_prefix.md @@ -50,7 +50,7 @@ To get started quickly, here are some [examples](../../demo/csharp/). | [SearchMoonQuarter](#Astronomy.SearchMoonQuarter) | Finds the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#Astronomy.NextMoonQuarter) | Finds the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -60,6 +60,8 @@ To get started quickly, here are some [examples](../../demo/csharp/). | [NextGlobalSolarEclipse](#Astronomy.NextGlobalSolarEclipse) | Continue searching for solar eclipses visible anywhere on the Earth. | | [SearchLocalSolarEclipse](#Astronomy.SearchLocalSolarEclipse) | Search for the first solar eclipse after a given date that is visible at a particular location on the Earth. | | [NextLocalSolarEclipse](#Astronomy.NextLocalSolarEclipse) | Continue searching for solar eclipses visible at a particular location on the Earth. | +| [SearchTransit](#Astronomy.SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#Astronomy.NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/hydrogen/c_prefix.md b/hydrogen/c_prefix.md index e032a2dd..c9bf4651 100644 --- a/hydrogen/c_prefix.md +++ b/hydrogen/c_prefix.md @@ -70,7 +70,7 @@ To get started quickly, here are some [examples](../../demo/c/). | [SearchMoonQuarter](#Astronomy_SearchMoonQuarter) | Finds the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#Astronomy_NextMoonQuarter) | Finds the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -80,6 +80,8 @@ To get started quickly, here are some [examples](../../demo/c/). | [NextGlobalSolarEclipse](#Astronomy_NextGlobalSolarEclipse) | Continue searching for more global solar eclipses. | | [SearchLocalSolarEclipse](#Astronomy_SearchLocalSolarEclipse) | Search for the first solar eclipse as seen at a particular location after a given date. | | [NextLocalSolarEclipse](#Astronomy_NextLocalSolarEclipse) | Continue searching for more local solar eclipses. | +| [SearchTransit](#Astronomy_SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#Astronomy_NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/jsdoc2md/js.hbs b/jsdoc2md/js.hbs index 6a175e3b..d726ed2d 100644 --- a/jsdoc2md/js.hbs +++ b/jsdoc2md/js.hbs @@ -40,7 +40,7 @@ and some [Node.js examples](../../demo/nodejs/). | [SearchMoonQuarter](#Astronomy.SearchMoonQuarter) | Find the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#Astronomy.NextMoonQuarter) | Find the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -50,6 +50,8 @@ and some [Node.js examples](../../demo/nodejs/). | [NextGlobalSolarEclipse](#Astronomy.NextGlobalSolarEclipse) | Continue searching for solar eclipses visible anywhere on the Earth. | | [SearchLocalSolarEclipse](#Astronomy.SearchLocalSolarEclipse) | Search for the first solar eclipse after a given date that is visible at a particular location on the Earth. | | [NextLocalSolarEclipse](#Astronomy.NextLocalSolarEclipse) | Continue searching for solar eclipses visible at a particular location on the Earth. | +| [SearchTransit](#Astronomy.SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#Astronomy.NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/pydown/py_prefix.md b/pydown/py_prefix.md index d1616e36..86bbd9e4 100644 --- a/pydown/py_prefix.md +++ b/pydown/py_prefix.md @@ -52,7 +52,7 @@ To get started quickly, here are some [examples](../../demo/python/). | [SearchMoonQuarter](#SearchMoonQuarter) | Finds the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#NextMoonQuarter) | Finds the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -62,6 +62,8 @@ To get started quickly, here are some [examples](../../demo/python/). | [NextGlobalSolarEclipse](#NextGlobalSolarEclipse) | Continue searching for solar eclipses visible anywhere on the Earth. | | [SearchLocalSolarEclipse](#SearchLocalSolarEclipse) | Search for the first solar eclipse after a given date that is visible at a particular location on the Earth. | | [NextLocalSolarEclipse](#NextLocalSolarEclipse) | Continue searching for solar eclipses visible at a particular location on the Earth. | +| [SearchTransit](#SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/source/c/README.md b/source/c/README.md index 8fc0d774..e8d1cdeb 100644 --- a/source/c/README.md +++ b/source/c/README.md @@ -70,7 +70,7 @@ To get started quickly, here are some [examples](../../demo/c/). | [SearchMoonQuarter](#Astronomy_SearchMoonQuarter) | Finds the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#Astronomy_NextMoonQuarter) | Finds the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -80,6 +80,8 @@ To get started quickly, here are some [examples](../../demo/c/). | [NextGlobalSolarEclipse](#Astronomy_NextGlobalSolarEclipse) | Continue searching for more global solar eclipses. | | [SearchLocalSolarEclipse](#Astronomy_SearchLocalSolarEclipse) | Search for the first solar eclipse as seen at a particular location after a given date. | | [NextLocalSolarEclipse](#Astronomy_NextLocalSolarEclipse) | Continue searching for more local solar eclipses. | +| [SearchTransit](#Astronomy_SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#Astronomy_NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/source/csharp/README.md b/source/csharp/README.md index ecfc66e6..e86735db 100644 --- a/source/csharp/README.md +++ b/source/csharp/README.md @@ -50,7 +50,7 @@ To get started quickly, here are some [examples](../../demo/csharp/). | [SearchMoonQuarter](#Astronomy.SearchMoonQuarter) | Finds the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#Astronomy.NextMoonQuarter) | Finds the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -60,6 +60,8 @@ To get started quickly, here are some [examples](../../demo/csharp/). | [NextGlobalSolarEclipse](#Astronomy.NextGlobalSolarEclipse) | Continue searching for solar eclipses visible anywhere on the Earth. | | [SearchLocalSolarEclipse](#Astronomy.SearchLocalSolarEclipse) | Search for the first solar eclipse after a given date that is visible at a particular location on the Earth. | | [NextLocalSolarEclipse](#Astronomy.NextLocalSolarEclipse) | Continue searching for solar eclipses visible at a particular location on the Earth. | +| [SearchTransit](#Astronomy.SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#Astronomy.NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/source/js/README.md b/source/js/README.md index 094283f0..8d5a095f 100644 --- a/source/js/README.md +++ b/source/js/README.md @@ -40,7 +40,7 @@ and some [Node.js examples](../../demo/nodejs/). | [SearchMoonQuarter](#Astronomy.SearchMoonQuarter) | Find the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#Astronomy.NextMoonQuarter) | Find the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -50,6 +50,8 @@ and some [Node.js examples](../../demo/nodejs/). | [NextGlobalSolarEclipse](#Astronomy.NextGlobalSolarEclipse) | Continue searching for solar eclipses visible anywhere on the Earth. | | [SearchLocalSolarEclipse](#Astronomy.SearchLocalSolarEclipse) | Search for the first solar eclipse after a given date that is visible at a particular location on the Earth. | | [NextLocalSolarEclipse](#Astronomy.NextLocalSolarEclipse) | Continue searching for solar eclipses visible at a particular location on the Earth. | +| [SearchTransit](#Astronomy.SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#Astronomy.NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee diff --git a/source/python/README.md b/source/python/README.md index 049fc0e3..219b9e32 100644 --- a/source/python/README.md +++ b/source/python/README.md @@ -52,7 +52,7 @@ To get started quickly, here are some [examples](../../demo/python/). | [SearchMoonQuarter](#SearchMoonQuarter) | Finds the first quarter moon phase after a given date and time. | | [NextMoonQuarter](#NextMoonQuarter) | Finds the next quarter moon phase after a previous one that has been found. | -### Eclipses +### Eclipses and Transits | Function | Description | | -------- | ----------- | @@ -62,6 +62,8 @@ To get started quickly, here are some [examples](../../demo/python/). | [NextGlobalSolarEclipse](#NextGlobalSolarEclipse) | Continue searching for solar eclipses visible anywhere on the Earth. | | [SearchLocalSolarEclipse](#SearchLocalSolarEclipse) | Search for the first solar eclipse after a given date that is visible at a particular location on the Earth. | | [NextLocalSolarEclipse](#NextLocalSolarEclipse) | Continue searching for solar eclipses visible at a particular location on the Earth. | +| [SearchTransit](#SearchTransit) | Search for the next transit of Mercury or Venus. | +| [NextTransit](#NextTransit) | Continue searching for transits of Mercury or Venus. | ### Lunar perigee and apogee