readevent.read_donki_event Namespace Reference

Classes
class	DONKIError
class	DONKIEvent

Functions
def	write_events
	Write event list in a file. More...
def	print_events
	Write event list on standard output. More...
def	read_v0
	Read Json file return by DONKI's API. More...
def	write_v0
	Write event json file with JSON_DONKICME_V0. More...

Variables
string	header = '%-4s %-28s %-16s %-16s %-10s %-5s %-5s %-10s %-8s %-15s %-15s\n'

Function Documentation

def readevent.read_donki_event.print_events

(

events

)

Write event list on standard output.

def readevent.read_donki_event.read_v0

(

filepath

)

Read Json file return by DONKI's API.

Format JSON_DONKICME_V0 is the following:
List of 1 dictionnary containing:

• activityID : an id containing the starting date Y-m-dTH:M:S-CME-XXX. Correspond to event_id.
• startTime : starting time with format Y-m-dTH:MZ. Correspond to date_begin.
• cmeAnalyses : dictionary
• cmeAnalyses[time21_5] : time at 21.5 solar radii with format Y-m-dTH:MZ. Correspond to date_end.
• cmeAnalysis[latitude] : format f.1. Correspond to latitude.
• cmeAnalysis[longitude] : format f.1. Correspond to longitude.
• cmeAnalysis[type] : C or S. Corresponds to event_class.
• catalog : SWRC_CATALOG or JANG_ET_AL_CATALOG or VALIDATION_CATALOG
• sourceLocation :
• activeRegionNum :
• link : some url
• note : some description
• instruments : list of dictionary about instrument (id,displayName,)
• linkedEvents :
• cmeAnalysis[halfAngle] :
• cmeAnalysis[speed] : speed in km/s
• cmeAnalysis[isMostAccurate] : Boolean
• cmeAnalysis[note] : some note
• cmeAnalysis[levelOfData] : 0 or ?
• cmeAnalysis[link] : some url
• cmeAnalysis[enlilList] : list of dictionary about ?

Returns

List of 1 DONKIEvent object.

def readevent.read_donki_event.write_events	(		events,
			fid
	)

Write event list in a file.

def readevent.read_donki_event.write_v0	(		events,
			filepath
	)

Write event json file with JSON_DONKICME_V0.

Parameters

[in]

events

List of 1 DONKIEvent object

Variable Documentation

string readevent.read_donki_event.header = '%-4s %-28s %-16s %-16s %-10s %-5s %-5s %-10s %-8s %-15s %-15s\n'