README.md

+++ title = "Kosmorrolib documentation" description = "All the features of Kosmorrolib are documented right here!" template = "doc/section.html" +++

Usage

All the functions and classes listed below are accessible under the kosmorrolib module:

import kosmorrolib

# Example call:
events = kosmorrolib.get_events()

Functions

• get_ephemerides() - compute and return the ephemerides
• get_events() - calculate and return a list of events
• get_moon_phase() - calculate and return the moon phase

Model

• AsterEphemerides - an object representing ephemerides
• Event - an object representing an event
• MoonPhase - an object representing a moon phase
• Position - an object representing a position on earth
• Object - an object representing an astronomical object

Enums

• EventType - an enumeration of supported events
• LunarEclipseType - an enumeration of lunar eclipse types
• MoonPhaseType - an enumeration of Moon phase
• ObjectIdentifier - an enumeration to identify objects of the Solar system
• ObjectType - an enumeration of object types
• SeasonType - an enumeration of seasons