forecast.py

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# 
# https://github.com/orjanv/Planetary-K-Index-alert

import urllib.request, urllib.error, urllib.parse
import argparse
import xml.etree.ElementTree as ET
import sys

USER_AGENT = 'Python-urllib/2.1'

def kpIndex():
    ''' Get the geomagnetic indices from NOAA and report the last forecast
    '''
    url = 'http://services.swpc.noaa.gov/text/daily-geomagnetic-indices.txt'
    # Download the datafile from noaa.gov
    response = urllib.request.urlopen(url)
    everything = response.readlines()

    # We only need the last line
    last_line = everything[-1]

    # Extract the last numbers, which is the planetary K-indices
    # in three ours intervals and add to a list
    ki = last_line[-17:]
    fc = []
    for i in range(0, len(ki)):
        k = ki[i]
        if k == '-':
            break
        elif k != ' ':
            fc.append(k)

    return fc[-1]


def bzValue():
    ''' Go online and get the magnetic sensor report from NOAA 
    and extract the Bz value which we are looking at
    '''
    url = 'ftp://ftp.swpc.noaa.gov/pub/lists/ace/ace_mag_1m.txt'
    # Download the datafile from noaa.gov
    response = urllib.request.urlopen(url)
    everything = response.readlines()
    #print(everything[-1][36:37])
    # We only need the last line, but if last line has corrupt data, 
    # grab the previous, and so on..    
    data_status = 9
    line_number = -1
    while True:
        last_line = everything[line_number]
        data_status = last_line[36:37]
        # Check the status of the data (bad or corrupt)
        if data_status.decode('UTF-8') == '0':
            bz = last_line[57:61]
            break
        else:
            line_number -= 1
    return bz.decode('UTF-8')


def windSpeed():
    ''' Go online and grab the solar wind speed report from NOAA and
    grab the last line with a valid reading and pick the solar wind 
    speed
    '''
    url = 'ftp://ftp.swpc.noaa.gov/pub/lists/ace/ace_swepam_1m.txt'
    # Download the datafile from noaa.gov
    response = urllib.request.urlopen(url)
    everything = response.readlines()

    # We only need the last line, but if last line has corrupt data, 
    # grab the previous, and so on..    
    data_status = 9
    line_number = -1
    while True:
        last_line = everything[line_number]
        data_status = last_line[36:37]
        # Check the status of the data (bad or corrupt)
        if data_status.decode('UTF-8') == '0':
            # Extract the data we are interested in and stop
            speed = last_line[54:59]
            break
        else:
            line_number = line_number - 1
    return speed.decode('UTF-8')
    
    
def getWeather(region):
    ''' Get the weather data from YR weather api 2.0
    '''
    try:
        # get weather data from xml into memory
        url = "https://api.met.no/weatherapi/textforecast/2.0/?forecast=landoverview"
        response = urllib.request.urlopen(url)
        weatherdata = response.readlines()
        root = ET.fromstringlist(weatherdata)
        wyt = root.find('./time/forecasttype/location/[@name="%s"]' % (region))
        return wyt.text
    except IndexError:
        print("Please enter a region")


def main():
    ''' Main function
    '''
    regionnames = ["Østlandet, Telemark, Agder, Fjellet i Sør-Norge, \
Rogaland, Hordaland, Sogn og Fjordane, Møre og Romsdal, \
Trøndelag, Nordland, Troms, Finnmark, Spitsbergen"]

    parser = argparse.ArgumentParser()
    
    parser.add_argument("-k", "--kpindex", help="Planetary K-Index",
        action="store_true")
    parser.add_argument("-w", "--windspeed", help="Solar Wind Speed",
        action="store_true")
    parser.add_argument("-b", "--bz", help="Magnetic Bz Value",
        action="store_true")
    parser.add_argument("-y", "--yr", help="YR data for Nordland",
        action="store_true")
    parser.add_argument("region", nargs="?", default="Nordland", \
        help="region in Norway, use -r to show all. Defaults to 'Nordland'")
    parser.add_argument("-r", "--regions", help="Show all available regions, used with -y",
        action="store_true")
    parser.add_argument("-a", "--all", help="Show all data",
        action="store_true")
    parser.add_argument("-f", "--forecast", help="Evaluate the chance of aurora",
        action="store_true")
    
    args = parser.parse_args()

    if args.regions:
        for r in regionnames:
            print(r)

    if args.kpindex:
        kpi = kpIndex()
        print("KP-Index (NOAA):", kpi)

    if args.windspeed:
        wind = windSpeed()
        print("Wind speed (ACE):", wind)
        
    if args.bz:
        bz = bzValue()
        print("Bz value (ACE):", bz)    

    if args.yr:
        #region = raw_input("Enter a region: ")
        yr = getWeather(args.region)
        print("Weather data (YR) for %s: %s" % (args.region, yr)) 

    if args.all:   
        kpi = kpIndex()
        bz = bzValue()
        wind = windSpeed()
        yr = getWeather(args.region)
        print("KP-Index (NOAA):", kpi)
        print("Bz value (ACE):", bz)
        print("Wind speed (ACE):", wind)
        print("Weather data (YR) for Nordland:", yr)

    if args.forecast:
        kpi = kpIndex()
        bz = bzValue()
        wind = windSpeed()
        yr = getWeather(args.region)
        # If bz is negative and kpi >= 4, or big bz negative,
        # there is a chance of aurora
        if kpi >= 4 and float(bz) < 0.0:
            print("KP-Index (NOAA):", kpi)
            print("Bz value (ACE):", bz)
            print("Wind speed (ACE):", wind)
            #print("Weather data (YR) for Nordland:", yr)
        elif float(bz) < -2.0:
            print("KP-Index (NOAA):", kpi)
            print("Bz value (ACE):", bz)
            print("Wind speed (ACE):", wind)
            #print "Weather data (YR) for Nordland:", yr

    if len(sys.argv) == 1:
        about = ("Use this script to grab essential data from the "
            "ACE-satellite and magnetometers around the world. With "
            "this data, you can tell if there is a good change of "
            "spotting Aurora on the sky 30-45 minutes later.\n\n"
            "Using the `-f` argument will evaluate the data for "
            "you and give you an output ONLY if there is a chance of "
            "spotting auroras. Run the script with -h or --help to "
            "see all available functions.")
        print(about)

if __name__ == '__main__':
    main()