Astral v1.10

travis_status pypi_ver

Astral is a python module for calculating the times of various aspects of the sun and moon.

It calculates the following

Dawn
The time in the morning when the sun is a specific number of degrees below the horizon.
Sunrise
The time in the morning when the top of the sun breaks the horizon (asuming a location with no obscuring features.)
Solar Noon
The time when the sun is at its highest point.
Solar Midnight
The time when the sun is at its lowest point.
Sunset
The time in the evening when the sun is about to disappear below the horizon (asuming a location with no obscuring features.)
Dusk
The time in the evening when the sun is a specific number of degrees below the horizon.
Daylight
The time when the sun is up i.e. between sunrise and sunset
Night
The time between astronomical dusk of one day and astronomical dawn of the next
Twilight
The time between dawn and sunrise or between sunset and dusk
The Golden Hour
The time when the sun is between 4 degrees below the horizon and 6 degrees above.
The Blue Hour
The time when the sun is between 6 and 4 degrees below the horizon.
Time At Elevation
the time when the sun is at a specific elevation for either a rising or a setting sun.
Solar Azimuth
The number of degrees clockwise from North at which the sun can be seen
Solar Elevation
The number of degrees up from the horizon at which the sun can be seen
Rahukaalam
“Rahukaalam or the period of Rahu is a certain amount of time every day that is considered inauspicious for any new venture according to Indian Vedic astrology”.
Moon Phase
Calculates the phase of the moon for a specified date.

Examples

The following examples demonstrate the functionality available in the module

Sun

>>> import datetime
>>> from astral import Astral

>>> city_name = 'London'

>>> a = Astral()
>>> a.solar_depression = 'civil'

>>> city = a[city_name]

>>> print('Information for %s/%s\n' % (city_name, city.region))
Information for London/England

>>> timezone = city.timezone
>>> print('Timezone: %s' % timezone)
Timezone: Europe/London

>>> print('Latitude: %.02f; Longitude: %.02f\n' % \
>>>     (city.latitude, city.longitude))
Latitude: 51.60; Longitude: 0.08

>>> sun = city.sun(date=datetime.date(2009, 4, 22), local=True)
>>> print('Dawn:    %s' % str(sun['dawn']))
>>> print('Sunrise: %s' % str(sun['sunrise']))
>>> print('Noon:    %s' % str(sun['noon']))
>>> print('Sunset:  %s' % str(sun['sunset']))
>>> print('Dusk:    %s' % str(sun['dusk']))
Dawn:     2009-04-22 05:12:56+01:00
Sunrise:  2009-04-22 05:49:36+01:00
Noon:     2009-04-22 12:58:48+01:00
Sunset:   2009-04-22 20:09:07+01:00
Dusk:     2009-04-22 20:45:52+01:00

Moon

>>> import datetime
>>> from astral import Astral
>>> a = Astral()
>>> moon_phase = a.moon_phase(date=datetime.date(2018, 1, 1))
>>> print(moon_phase)
13

The moon phase method returns an number describing the phase, where the value is between 0 and 27 (27.99 if you pass float as the return type). The following lists the mapping of various vales to the description of the phase of the moon.

0 = New Moon
7 = First Quarter
14 = Full Moon
21 = Last Quarter

If for example the number returned was 27(.99) then the moon would be almost at the New Moon phase, and if it was 24 it would be half way between the Last Quarter and a New Moon.

The return value can be cast to either an int (the default) or a float by passing the type required as the rtype parameter to moon_phase()

Note

The moon phase does not depend on your location. However what the moon actually looks like to you does depend on your location. If you’re in the southern hemisphere it looks different than if you were in the northern hemisphere.

See http://moongazer.x10.mx/website/astronomy/moon-phases/ for an example.

Geocoders

Access to the current geocoder instance can be made through the Astral class:

>>> a = Astral()
>>> geo = a.geocoder
>>> london = geo['London']

AstralGeocoder

Additional Locations

If you are using AstralGeocoder you can add to the list of available locations using the add_locations() method and passing either a string with one line per location or by passing a list containing strings, lists or tuples (lists and tuples are passed directly to the Location constructor).

Custom Location

If you only need a single location that is not in the Astral geocoder then you can construct a Location and fill in the values, either with a tuple on initialization:

l = Location(('name', 'region',
              0.1, 1.2, 'timezone/name', 0))
l.sun()

or set the attributes after initialization:

l = Location()
l.name = 'name'
l.region = 'region'
l.latitude = 0.1
l.longitude = 1.2
l.timezone = 'US/Central'
l.elevation = 0
l.sun()

Note

name and region can be anything you like.

Timezone Groups

Timezone groups such as Europe can be accessed via attributes on the AstralGeocoder:

>>> geo = AstralGeocoder()
>>> europe = geo.europe.locations
>>> europe.sort()
>>> europe
['Aberdeen', 'Amsterdam', 'Andorra la Vella', 'Ankara', 'Athens', ...]

GoogleGeocoder

The GoogleGeocoder class can be used by passing GoogleGeocoder as the geocoder parameter to the Astral class and by passing an API key with the api_key paramater:

a = Astral(geocoder=GoogleGeocoder, api_key="<Insert API key here>")

Effect of Elevation

An attempt has been made to allow for the effect of elevation on the times for the sun. Higher elevations cause the sun to rise earlier and to set later for the observer.

This is performed by calculating the angle α in the image below and adding this to the depression angle for the sun calculations.

_images/elevation.svg

Warning

This may not be the correct calculation for the angle. Please raise an issue if you know how it should be calculated.

Note on Localized Timezones

When creating a datetime object in a specific timezone do not use the tzinfo parameter to the datetime constructor. Instead please use the localize() method on the correct pytz timezone:

dt = datetime.datetime(2015, 1, 1, 9, 0, 0)
dt = pytz.timezone('Europe/London').localize(dt)

License

This module is licensed under the terms of the Apache V2.0 license.

Dependencies

Astral has one required external Python dependency on ‘pytz’. If you want to use the GoogleGeocoder then the ‘requests’ package is also required.

Installation

To install Astral you should use the pip tool:

pip install astral

Cities

The module includes location and time zone data for the following cities. The list includes all capital cities plus some from the UK. The list also includes the US state capitals and some other US cities.

Aberdeen, Abu Dhabi, Abu Dhabi, Abuja, Accra, Addis Ababa, Adelaide, Al Jubail, Albany, Albuquerque, Algiers, Amman, Amsterdam, Anchorage, Andorra la Vella, Ankara, Annapolis, Antananarivo, Apia, Ashgabat, Asmara, Astana, Asuncion, Athens, Atlanta, Augusta, Austin, Avarua, Baghdad, Baku, Baltimore, Bamako, Bandar Seri Begawan, Bangkok, Bangui, Banjul, Barrow-In-Furness, Basse-Terre, Basseterre, Baton Rouge, Beijing, Beirut, Belfast, Belgrade, Belmopan, Berlin, Bern, Billings, Birmingham, Birmingham, Bishkek, Bismarck, Bissau, Bloemfontein, Bogota, Boise, Bolton, Boston, Bradford, Brasilia, Bratislava, Brazzaville, Bridgeport, Bridgetown, Brisbane, Bristol, Brussels, Bucharest, Bucuresti, Budapest, Buenos Aires, Buffalo, Bujumbura, Burlington, Cairo, Canberra, Cape Town, Caracas, Cardiff, Carson City, Castries, Cayenne, Charleston, Charlotte, Charlotte Amalie, Cheyenne, Chicago, Chisinau, Cleveland, Columbia, Columbus, Conakry, Concord, Copenhagen, Cotonou, Crawley, Dakar, Dallas, Damascus, Dammam, Denver, Des Moines, Detroit, Dhaka, Dili, Djibouti, Dodoma, Doha, Douglas, Dover, Dublin, Dushanbe, Edinburgh, El Aaiun, Fargo, Fort-de-France, Frankfort, Freetown, Funafuti, Gaborone, George Town, Georgetown, Gibraltar, Glasgow, Greenwich, Guatemala, Hanoi, Harare, Harrisburg, Hartford, Havana, Helena, Helsinki, Hobart, Hong Kong, Honiara, Honolulu, Houston, Indianapolis, Islamabad, Jackson, Jacksonville, Jakarta, Jefferson City, Jerusalem, Juba, Jubail, Juneau, Kabul, Kampala, Kansas City, Kathmandu, Khartoum, Kiev, Kigali, Kingston, Kingston, Kingstown, Kinshasa, Koror, Kuala Lumpur, Kuwait, La Paz, Lansing, Las Vegas, Leeds, Leicester, Libreville, Lilongwe, Lima, Lincoln, Lisbon, Little Rock, Liverpool, Ljubljana, Lome, London, Los Angeles, Louisville, Luanda, Lusaka, Luxembourg, Macau, Madinah, Madison, Madrid, Majuro, Makkah, Malabo, Male, Mamoudzou, Managua, Manama, Manchester, Manchester, Manila, Maputo, Maseru, Masqat, Mbabane, Mecca, Medina, Memphis, Mexico, Miami, Milwaukee, Minneapolis, Minsk, Mogadishu, Monaco, Monrovia, Montevideo, Montgomery, Montpelier, Moroni, Moscow, Moskva, Mumbai, Muscat, N’Djamena, Nairobi, Nashville, Nassau, Naypyidaw, New Delhi, New Orleans, New York, Newark, Newcastle, Newcastle Upon Tyne, Ngerulmud, Niamey, Nicosia, Norwich, Nouakchott, Noumea, Nuku’alofa, Nuuk, Oklahoma City, Olympia, Omaha, Oranjestad, Orlando, Oslo, Ottawa, Ouagadougou, Oxford, P’yongyang, Pago Pago, Palikir, Panama, Papeete, Paramaribo, Paris, Perth, Philadelphia, Phnom Penh, Phoenix, Pierre, Plymouth, Podgorica, Port Louis, Port Moresby, Port of Spain, Port-Vila, Port-au-Prince, Portland, Portland, Porto-Novo, Portsmouth, Prague, Praia, Pretoria, Pristina, Providence, Quito, Rabat, Raleigh, Reading, Reykjavik, Richmond, Riga, Riyadh, Road Town, Rome, Roseau, Sacramento, Saint Helier, Saint Paul, Saint Pierre, Saipan, Salem, Salt Lake City, San Diego, San Francisco, San Jose, San Juan, San Marino, San Salvador, Sana, Sana’a, Santa Fe, Santiago, Santo Domingo, Sao Tome, Sarajevo, Seattle, Seoul, Sheffield, Singapore, Sioux Falls, Skopje, Sofia, Southampton, Springfield, Sri Jayawardenapura Kotte, St. George’s, St. John’s, St. Peter Port, Stanley, Stockholm, Sucre, Suva, Swansea, Swindon, Sydney, T’bilisi, Taipei, Tallahassee, Tallinn, Tarawa, Tashkent, Tbilisi, Tegucigalpa, Tehran, Thimphu, Tirana, Tirane, Tokyo, Toledo, Topeka, Torshavn, Trenton, Tripoli, Tunis, Ulaanbaatar, Ulan Bator, Vaduz, Valletta, Vienna, Vientiane, Vilnius, Virginia Beach, W. Indies, Warsaw, Washington DC, Wellington, Wichita, Willemstad, Wilmington, Windhoek, Wolverhampton, Yamoussoukro, Yangon, Yaounde, Yaren, Yerevan, Zagreb

US Cities

Albany, Albuquerque, Anchorage, Annapolis, Atlanta, Augusta, Austin, Baltimore, Baton Rouge, Billings, Birmingham, Bismarck, Boise, Boston, Bridgeport, Buffalo, Burlington, Carson City, Charleston, Charlotte, Cheyenne, Chicago, Cleveland, Columbia, Columbus, Concord, Dallas, Denver, Des Moines, Detroit, Dover, Fargo, Frankfort, Harrisburg, Hartford, Helena, Honolulu, Houston, Indianapolis, Jackson, Jacksonville, Jefferson City, Juneau, Kansas City, Lansing, Las Vegas, Lincoln, Little Rock, Los Angeles, Louisville, Madison, Manchester, Memphis, Miami, Milwaukee, Minneapolis, Montgomery, Montpelier, Nashville, New Orleans, New York, Newark, Oklahoma City, Olympia, Omaha, Orlando, Philadelphia, Phoenix, Pierre, Portland, Portland, Providence, Raleigh, Richmond, Sacramento, Saint Paul, Salem, Salt Lake City, San Diego, San Francisco, Santa Fe, Seattle, Sioux Falls, Springfield, Tallahassee, Toledo, Topeka, Trenton, Virginia Beach, Wichita, Wilmington

Thanks

The sun calculations in this module were adapted, for Python, from the spreadsheets on the following page.

The moon phase calculation is based on some javascript code from Sky and Telescope magazine

Moon-phase calculation
Roger W. Sinnott, Sky & Telescope, June 16, 2006.

Also to Sphinx for making doc generation an easy thing (not that the writing of the docs is any easier.)

Contact

Simon Kennedy <sffjunkie+code@gmail.com>

Version History

Version Description
1.10.1 Keyword args are now passed to the geocoder class from Astral __init__ in order to allow the Google Maps API key to be passed to the GoogleGeocoder.
1.10 Added support to AstralGeocoder to add additional locations to the database.
1.9.2 1.9 broke the sun_utc method. Sun UTC calculation passed incorrect parameter to more specific methods e.g. sunrise, sunset etc.
1.9.1 Correct version number in astral.py
1.9 Now takes elevation into account.
1.8
  • Location methods now allow the timezone to be None which returns all times as UTC.
  • Added command line interface to return ‘sun’ values
1.7.1
  • Changed GoogleGeocoder test to not use raise…from as this is not valid for Python 2
1.7
  • Requests is now only needed when using GoogleGeocoder
  • GoogleGeocoder now requires the api_key parameter to be passed to the constructor as Google now require it for their API calls.
1.6.1
  • Updates for Travis CI integration / Github signed release.
1.6
  • Added api_key parameter to the GoogleGeocoder __init__() method
1.5
  • Added parameter rtype to moon_phase() to determine the return type of the method.
  • Added example for calculating the phase of the moon.
1.4.1
  • Using versioneer to manage version numbers
1.4
  • Changed to use calculations from NOAA spreadsheets
  • Changed some exception error messages for when sun does not reach a requested elevation.
  • Added more tests
1.3.4
  • Changes to project configuration files. No user facing changes.
1.3.3
  • Fixed call to twilight_utc as date and direction parameters were reversed.
1.3.2
  • Updated URL to point to gitgub.com
  • Added Apache 2.0 boilerplate to source file
1.3.1
  • Added LICENSE file to sdist
1.3
  • Corrected solar zenith to return the angle from the vertical.
  • Added solar midnight calculation.
1.2
  • Added handling for when unicode literals are used. This may possibly affect your code if you’re using Python 2 (there are tests for this but they may not catch all uses.) (Bug 1588198)
  • Changed timezone for Phoenix, AZ to America/Phoenix (Bug 1561258)
1.1
  • Added methods to calculate Twilight, the Golden Hour and the Blue Hour.
1.0
  • It’s time for a version 1.0
  • Added examples where the location you want is not in the Astral geocoder.
0.9
  • Added a method to calculate the date and time when the sun is at a specific elevation, for either a rising or a setting sun.
  • Added daylight and night methods to Location and Astral classes.
  • Rahukaalam methods now return a tuple.
0.8.2
  • Fix for moon phase calcualtions which were off by 1.
  • Use pytz.timezone().localize method instead of passing tzinfo parameter to datetime.datetime. See the pytz docs for info
0.8.1
0.8 Fix for bug 1407773: Moon phase calculation changed to remove time zone parameter (tz) as it is not required for the calculation.
0.7.5 Fix for bug 1402103: Buenos Aires incorrect timezone
0.7.4 Added Canadian cities from Yip Shing Ho
0.7.3 Fix for bug 1239387 submitted by Torbjörn Lönnemark
0.7.2 Minor bug fix in GoogleGeocoder. location name and region are now stripped of whitespace
0.7.1 Bug fix. Missed a vital return statement in the GoogleGeocoder
0.7
  • Added ability to lookup location information from Google’s mapping APIs (see GoogleGeocoder)
  • Renamed City class to Location
  • Renamed CityDB to AstralGeocoder
  • Added elevations of cities to database and property to obtain elevation from Location class
0.6.2 Added various cities to database as per https://bugs.launchpad.net/astral/+bug/1040936
0.6.1
  • Docstrings were not updated to match changes to code.
  • Other minor docstring changes made
0.6
  • Fix for bug 884716 submitted by Martin Heemskerk regarding moon phase calculations
  • Fixes for bug report 944754 submitted by Hajo Werder
    • Changed co-ordinate system so that eastern longitudes are now positive
    • Added solar_depression property to City class
0.5
  • Changed City to accept unicode name and country.
  • Moved city information into a database class CityDB
  • Added attribute access to database for timezone groups
0.4
  • Duplicate city names could not be accessed.
  • Sun calculations for some cities failed with times outside valid ranges.
  • Fixes for city data.
  • Added calculation for moon phase.
0.3
  • Changed to Apache V2.0 license.
  • Fix for bug 555508 submitted by me.
  • US state capitals and other cities added.
0.2 Fix for bug 554041 submitted by Derek_ / John Dimatos
0.1 First release