Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 5.48 KB

README.md

File metadata and controls

77 lines (49 loc) · 5.48 KB
Raw

Lunar Phase Calendar

IMPORTANT: NEW DIRECTORY STRUCTURE nl will be NL/nl

Roling ICS calendars with lunar phases for three years in advance.

Ignorance is the night of the mind, but a night without moon and star. — Confucius (551 – 479 BC) Chinese philosopher and reformer

Besides calendars with all the lunar phases, there are also calendars provided with only the dates when there is a new or full moon. The calendars are generated for many country-language combinations in different file formats:

  • tab-separated format in TSV files, e.g. GB/en/moon-phases.tsv
  • MarkDown in MD files, e.g. BE/nl/new-moon.md
  • iCalendar in ICS files, e.g. AT/de/full-moon.ics

See the file countries.json for which country-language combinations are supported. Even though the moon phase is the same all over the world, time zones per country need to be taken into consideration.

The calendars are generated on a certain day for three years in advance and is published in this repository. At the time of generation, a margin is used of one month at the beginning and of two months at the end.

As lunar phases cannot be written in recurring calendar events, all the individual lunar phases need to be included in the calendar. Generating calendars for the next ten of fifty years would results in large ICS files. Hence, this approach was chosen.

The calendars will be regenerated regularly. Browse around in order to find the lunar phase calendar you are looking for. In case a calendar is lagging behind too much, more time in advance is needed, you want to contribute a translation or report a bug or feature, please create an issue.

Screenshots

Thunderbird

Android

Calendar Software

Probably, you already have software installed for using online calendars. If that is not the case, lunar phase calendars can be shown with:

Name Android iOS macOS Windows Linux Web interface
Google Calendar ✔ - - - - ✔
ICSx⁵ ✔ - - - - -
CalDAV-Sync ✔ - - - - -
iCloud Calendar - ✔ - - - -
Thunderbird - - ✔ ✔ ✔ -
Apple Calendar - - ✔ - - -
Microsoft Outlook - - - ✔ - ✔

Check marks in the table have links to the software. ICSx⁵ can also be found in the F-Droid app store. Do not use software that can only import ICS files.

Using ICS Files in Calendar Software

First, choose the ICS calendar file on GitHub you would like to add to your calendar software. Browse under Code to e.g. en and choose e.g. full-moon.ics. Then, click on the button called Raw and you will go to the URL for this calendar. For this example, https://raw.githubusercontent.com/PanderMusubi/lunar-phase-calendar/master/GB/en/full-moon.ics will be the URL.

After you have copied the URL of an ICS file, please paste this in your calendar software when adding a (read-only) online network or ICS calendar. Sometimes this is called to subscribe to a calendar. Usually you can choose how often synchronization has to be done to keep your lunar phase calendar up to date. Set this to 24 hours, because there are not that many updates. Again, do not choose the (one time) import of the ICS calendar as it will not update itself.

Emoji

Emoji support moon phases, hence the following Unicode characters are use in the output files:

  1. 🌑 U+1F311 New moon
  2. 🌒 U+1F312 Waxing crescent
  3. 🌓 U+1F313 First quarter
  4. 🌔 U+1F314 Waxing gibbous
  5. 🌕 U+1F315 Full moon
  6. 🌖 U+1F316 Waning gibbous
  7. 🌗 U+1F317 Last quarter
  8. 🌘 U+1F318 Waning crescent

Generating

Generate a new calendar by installing the required package with

pip install -Ur requirements/use.txt

and run

./generate.py

For developement purposes and before running lint.sh, do

sudo apt-get -y install devscripts
pip install -Ur requirements/dev.txt

The lunar phase data used here is from the Python package astral. Its maintainer made a in the documentation of it a reference back to this project as a showcase of it usage. Many thanks for this.