PyGCPM 0.2.0__py3-none-win_amd64.whl

PyGCPM/GCPM.py

@@ -0,0 +1,73 @@
+import numpy as np
+from ._CFunctions import _Cgcpm
+import DateTimeTools as TT
+
+def GCPM(x,y,z,Date,ut,Kp=1.0,Verbose=False):
+	'''
+	Calculates the Global Core Plasma Model at some given position(s)
+	and time(s).
+	
+	Inputs
+	======
+	x : float
+		scalar or array of x_SM (Solar Magnetic coordinates) component 
+		of the position, where units are in R_E.
+	y : float
+		scalar or array of y_SM 
+	z : float
+		scalar or array of z_SM
+	Date : int
+		Date(s) in format yyyymmdd
+	ut : float
+		Time(s) in hours from beginning of day where 
+		ut = hh + mm/60.0 + ss/3600.0
+	Kp : float
+		Kp index (or indices)
+	Verbose : bool
+		If True, model calculation progress will be displayed
+		
+	Returns
+	=======
+	ne : float32
+		Array of electron densities in 1/cm^3
+	nH : float32
+		Array of proton densities in 1/cm^3
+	nHe : float32
+		Array of helium ion densities in 1/cm^3
+	nO : float 32
+		Array of Oxygen densities in 1/cm^3
+	'''
+
+	#reformat the positions
+	_x = np.array([x]).flatten().astype('float32')
+	_y = np.array([y]).flatten().astype('float32')
+	_z = np.array([z]).flatten().astype('float32')
+	_n = np.int32(_x.size)
+
+
+	#sort out the dates
+	dates = np.zeros(_n,dtype='int32') + Date
+	_years = np.int32(dates//10000)
+	_dayno = np.int32(TT.DayNo(dates))
+	
+	#times
+	_ut = np.zeros(_n,dtype='float32') + ut
+	
+	#Kp indices
+	_kp = np.zeros(_n,dtype='float32') + Kp
+	
+	#Verbose flag
+	_verb = np.int32(Verbose)
+	
+	#output arrays
+	ne = np.zeros(_n,dtype='float32')
+	nH = np.zeros(_n,dtype='float32')
+	nHe = np.zeros(_n,dtype='float32')
+	nO = np.zeros(_n,dtype='float32')
+
+	
+	#call the C wrapper
+	_Cgcpm(_x,_y,_z,_years,_dayno,_ut,_kp,_n,ne,nH,nHe,nO,_verb)
+	
+	return ne,nH,nHe,nO
+	

PyGCPM/PlotEqSlice.py

@@ -0,0 +1,118 @@
+import numpy as np
+import matplotlib.pyplot as plt
+import matplotlib.colors as colors
+from mpl_toolkits.axes_grid1 import make_axes_locatable
+from .PlotPlanet import PlotPlanetXY
+from .GCPM import GCPM
+
+def PlotEqSlice(Date,ut,Parameter='ne',Rmax=10.0,dR=0.5,Kp=1.0,fig=None,
+		maps=[1,1,0,0],zlog=True,cmap='gnuplot',scale=None,Verbose=False):
+	'''
+	Plots the GCPM model in the equatorial plane.
+	
+	Inputs
+	======
+	Date : int
+		Date(s) in format yyyymmdd
+	ut : float
+		Time(s) in hours from beginning of day where 
+		ut = hh + mm/60.0 + ss/3600.0
+	Parameter : str
+		'ne'|'nH'|'nHe'|'nO'
+	Rmax : float
+		Limits of the plot
+	dR : float
+		Size of bins on plot
+	Kp : float
+		Kp index (or indices)
+	fig : object
+		This should be either None (to create a new figure), a matplotlib.pyplot
+		object (to add a new set of axes to an existing plot) or an 
+		instance of matplotlib.pyplot.Axes in order to add to an existing
+		set of axes.
+	maps : list/tuple
+		This will determine the position of the subplot on the figure.
+	zlog : bool
+		If True - the color scale will be logarithmic
+	cmap : str
+		String to say which colormap to use.
+	scale : None or list/tuple
+		If None - scale will be generated automatically, otherwise set 
+		scale = [minimum,maximum]
+	Verbose : bool
+		If True, model calculation progress will be displayed	
+	
+	
+	
+	'''
+	
+	#create a grid of points to calculate the model at
+	nR = 2*np.int32(Rmax/dR)
+	xe = np.linspace(-Rmax,Rmax,nR+1)
+	ye = xe
+	xc = xe[:-1] + 0.5*dR
+	yc = ye[:-1] + 0.5*dR
+	xe,ye = np.meshgrid(xe,ye)
+	xc,yc = np.meshgrid(xc,yc)
+	zc = np.zeros(xc.shape)
+	
+	#calculate the model
+	m = GCPM(xc,yc,zc,Date,ut,Kp=Kp,Verbose=Verbose)
+	
+	#get the color bar label
+	inf = {	'ne' : (m[0],'$n_e$ (cm$^{-3}$)'),
+			'nH' : (m[0],'$n_H$ (cm$^{-3}$)'),
+			'nHe' : (m[0],'$n_He$ (cm$^{-3}$)'),
+			'nO' : (m[0],'$n_O$ (cm$^{-3}$)')}
+	data,zlabel = inf[Parameter]
+	data = data.reshape(xc.shape)
+
+	#get the scale limits
+	if scale is None:
+		if zlog:
+			scale = [np.nanmin(data[data > 0]),np.nanmax(data)]
+		else:
+			scale = [np.nanmin(data),np.nanmax(data)]
+
+	if zlog:
+		norm = colors.LogNorm(vmin=scale[0],vmax=scale[1])
+	else:
+		norm = colors.Normalize(vmin=scale[0],vmax=scale[1])	
+	
+	
+
+		
+	
+
+	#create the plot window
+	if fig is None:
+		fig = plt
+		fig.figure()
+	if hasattr(fig,'Axes'):
+		ax = fig.subplot2grid((maps[1],maps[0]),(maps[3],maps[2]))
+		ax.set_xlim([Rmax,-Rmax])
+		ax.set_ylim([-Rmax,Rmax])
+		ax.set_aspect(1.0)
+	else:
+		ax = fig		
+		
+	#plot the mesh
+	sm = ax.pcolormesh(ye,xe,data,cmap=cmap,norm=norm)
+
+	#plot the planet
+	PlotPlanetXY(ax)
+
+
+	#sort the axis labels
+	ax.set_ylabel('$x_{SM}$ ($R_E$)')
+	ax.set_xlabel('$y_{SM}$ ($R_E$)')	
+	
+	
+
+	#colorbar
+	divider = make_axes_locatable(ax)
+	cax = divider.append_axes("right", size="5%", pad=0.05)
+	cbar = plt.colorbar(sm,cax=cax) 
+	cbar.set_label(zlabel)
+
+	return ax

PyGCPM/PlotMLTSlice.py

@@ -0,0 +1,129 @@
+import numpy as np
+import matplotlib.pyplot as plt
+import matplotlib.colors as colors
+from mpl_toolkits.axes_grid1 import make_axes_locatable
+from .PlotPlanet import PlotPlanetXZ
+from .GCPM import GCPM
+
+def PlotMLTSlice(MLT,Date,ut,Parameter='ne',Rmax=4.0,dR=0.5,Kp=1.0,fig=None,
+		maps=[1,1,0,0],zlog=True,cmap='gnuplot',scale=None,Verbose=False):
+	'''
+	Plots the GCPM model in the equatorial plane.
+	
+	Inputs
+	======
+	MLT: float
+		local time to calculate for
+	Date : int
+		Date(s) in format yyyymmdd
+	ut : float
+		Time(s) in hours from beginning of day where 
+		ut = hh + mm/60.0 + ss/3600.0
+	Parameter : str
+		'ne'|'nH'|'nHe'|'nO'
+	Rmax : float
+		Limits of the plot
+	dR : float
+		Size of bins on plot
+	Kp : float
+		Kp index (or indices)
+	fig : object
+		This should be either None (to create a new figure), a matplotlib.pyplot
+		object (to add a new set of axes to an existing plot) or an 
+		instance of matplotlib.pyplot.Axes in order to add to an existing
+		set of axes.
+	maps : list/tuple
+		This will determine the position of the subplot on the figure.
+	zlog : bool
+		If True - the color scale will be logarithmic
+	cmap : str
+		String to say which colormap to use.
+	scale : None or list/tuple
+		If None - scale will be generated automatically, otherwise set 
+		scale = [minimum,maximum]
+	Verbose : bool
+		If True, model calculation progress will be displayed	
+	
+	
+	
+	'''
+	
+	#create a grid of points to calculate the model at
+	nR = 2*np.int32(Rmax/dR)
+	ze = np.linspace(-Rmax,Rmax,nR+1)
+	rhoe = ze
+	zc = ze[:-1] + 0.5*dR
+	rhoc = rhoe[:-1] + 0.5*dR
+	mlt = (MLT - 12.0)* np.pi/12.0
+	rhoe,ze = np.meshgrid(rhoe,ze)
+	rhoc,zc = np.meshgrid(rhoc,zc)
+
+	xc = rhoc*np.cos(mlt)
+	yc = rhoc*np.sin(mlt)
+
+	#work out which side the MLT is on the plot
+	leftlab = '{:4.1f} MLT'.format(MLT + 12.0 % 24.0)
+	rightlab = '{:4.1f} MLT'.format(MLT % 24.0)
+
+
+	#calculate the model
+	m = GCPM(xc,yc,zc,Date,ut,Kp=Kp,Verbose=Verbose)
+	
+	#get the color bar label
+	inf = {	'ne' : (m[0],'$n_e$ (cm$^{-3}$)'),
+			'nH' : (m[1],'$n_H$ (cm$^{-3}$)'),
+			'nHe' : (m[2],'$n_He$ (cm$^{-3}$)'),
+			'nO' : (m[3],'$n_O$ (cm$^{-3}$)')}
+	data,zlabel = inf[Parameter]
+	data = data.reshape(xc.shape)
+
+
+	#get the scale limits
+	if scale is None:
+		if zlog:
+			scale = [np.nanmin(data[data > 0]),np.nanmax(data)]
+		else:
+			scale = [np.nanmin(data),np.nanmax(data)]
+		
+
+	if zlog:
+		norm = colors.LogNorm(vmin=scale[0],vmax=scale[1])
+	else:
+		norm = colors.Normalize(vmin=scale[0],vmax=scale[1])
+	
+	
+
+	
+
+	#create the plot window
+	if fig is None:
+		fig = plt
+		fig.figure()
+	if hasattr(fig,'Axes'):
+		ax = fig.subplot2grid((maps[1],maps[0]),(maps[3],maps[2]))
+		ax.set_ylim([Rmax,-Rmax])
+		ax.set_xlim([-Rmax,Rmax])
+		ax.set_aspect(1.0)
+	else:
+		ax = fig		
+		
+	#plot the mesh
+	sm = ax.pcolormesh(rhoe,ze,data,cmap=cmap,norm=norm)
+
+	#plot the planet
+	PlotPlanetXZ(ax,NoBlack=True)
+
+
+	#sort the axis labels
+	ax.set_xlabel(r'$\rho_{SM}$ ($R_E$)')
+	ax.set_ylabel('$z_{SM}$ ($R_E$)')	
+	
+	
+
+	#colorbar
+	divider = make_axes_locatable(ax)
+	cax = divider.append_axes("right", size="5%", pad=0.05)
+	cbar = plt.colorbar(sm,cax=cax) 
+	cbar.set_label(zlabel)
+
+	return ax,xc,yc,zc,m

PyGCPM/PlotPlanet.py

@@ -0,0 +1,82 @@
+import numpy as np
+
+def PlotPlanetXZ(fig,R=1.0,Center=[0.0,0.0,0.0],zorder=10,NoBlack=False,NoonTop=True):
+	
+
+	a = 2*np.pi*np.arange(361,dtype='float32')/360
+	x = R*np.sin(a) + Center[0]
+	z = R*np.cos(a) + Center[2]
+	
+	if NoonTop:	
+		fig.fill(z,x,color=[1.0,1.0,1.0],zorder=zorder)
+		fig.plot(z,x,color=[0,0,0],zorder=zorder+1)
+		if NoBlack == False:
+			fig.fill(z[180:360],x[180:360],color=[0.0,0.0,0.0],zorder=zorder+1)
+	else:
+		fig.fill(x,z,color=[1.0,1.0,1.0],zorder=zorder)
+		fig.plot(x,z,color=[0,0,0],zorder=zorder+1)
+		if NoBlack == False:
+			fig.fill(x[180:360],z[180:360],color=[0.0,0.0,0.0],zorder=zorder+1)
+
+
+def PlotPlanetXY(fig,R=1.0,Center=[0.0,0.0,0.0],zorder=10,NoBlack=False,NoonTop=True):
+	a = 2*np.pi*np.arange(361,dtype='float32')/360
+	x = R*np.sin(a) + Center[0]
+	y = R*np.cos(a) + Center[1]
+	
+	if NoonTop:	
+		fig.fill(y,x,color=[1.0,1.0,1.0],zorder=zorder)
+		fig.plot(y,x,color=[0,0,0],zorder=zorder+1)
+		if NoBlack == False:
+			fig.fill(y[180:360],x[180:360],color=[0.0,0.0,0.0],zorder=zorder+1)
+	else:
+		fig.fill(x,y,color=[1.0,1.0,1.0],zorder=zorder)
+		fig.plot(x,y,color=[0,0,0],zorder=zorder+1)
+		if NoBlack == False:
+			fig.fill(x[180:360],y[180:360],color=[0.0,0.0,0.0],zorder=zorder+1)
+
+def PlotPlanetYZ(fig,R=1.0,Center=[0.0,0.0,0.0],Side='day',zorder=10,NoFill=False,Color=[0.0,0.0,0.0],linestyle='-'):
+	
+	a = 2*np.pi*np.arange(361,dtype='float32')/360
+	y = R*np.sin(a) + Center[1]
+	z = R*np.cos(a) + Center[2]
+	
+	if NoFill == False:	
+		if Side == 'day':
+			fig.fill(y,z,color=[1.0,1.0,1.0],zorder=zorder)
+		else:
+			fig.fill(y,z,color=[0.0,0.0,0.0],zorder=zorder)
+	fig.plot(y,z,color=Color,zorder=zorder+1,linestyle='-')
+
+def PlotPlanetCoreXZ(ax,R=1.0,Center=[0.0,0.0,0.0],Colors=([1.0,0.7,0.0,0.5],[1.0,0.2,0.0,0.5],[0.5,0.5,0.5,0.5]),Layers=(0.0,0.832,1.0),zorder=1.0,NoFill=False,linestyle='-',linewidth=2.0):
+	'''
+	Plots the different layers of hte planet
+	'''
+	
+	a = 2*np.pi*np.arange(361,dtype='float32')/360
+	
+	nl = len(Layers)
+	if NoFill:
+		for i in range(0,nl):
+			x = Layers[i]*R*np.sin(a) + Center[0]
+			z = Layers[i]*R*np.cos(a) + Center[2]
+			ax.plot(x,z,color=Colors[i],zorder=zorder,linestyle=linestyle,linewidth=linewidth)
+	else:
+		for i in range(0,nl-1):
+			l0 = Layers[i]
+			l1 = Layers[i+1]
+			x0 = l0*R*np.sin(a) + Center[0]
+			z0 = l0*R*np.cos(a) + Center[2]			
+			x1 = l1*R*np.sin(a) + Center[0]
+			z1 = l1*R*np.cos(a) + Center[2]			
+			
+			if l0 == 0.0:
+				ax.fill(x1,z1,color=Colors[i],zorder=zorder,linewidth=0.0)
+			else:
+				x = np.append(x0,x1[::-1])
+				z = np.append(z0,z1[::-1])
+				ax.fill(x,z,color=Colors[i],zorder=zorder,linewidth=0.0)
+
+			x = R*np.sin(a) + Center[0]
+			z = R*np.cos(a) + Center[2]			
+			ax.plot(x,z,color=Colors[-1],linestyle=linestyle,linewidth=linewidth,zorder=zorder)

PyGCPM/_CFunctions.py

@@ -0,0 +1,52 @@
+import numpy as np
+import ctypes as ct
+from pathlib import Path
+import sys
+
+#some ctypes
+c_str = ct.c_char_p
+c_bool = ct.c_bool
+c_int = ct.c_int
+c_float = ct.c_float
+c_double = ct.c_double
+c_int_ptr = np.ctypeslib.ndpointer(ct.c_int,flags="C_CONTIGUOUS")
+c_float_ptr = np.ctypeslib.ndpointer(ct.c_float,flags="C_CONTIGUOUS")
+c_double_ptr = np.ctypeslib.ndpointer(ct.c_double,flags="C_CONTIGUOUS")
+
+#get the path of the library
+libpath = Path(__file__).resolve().parent / "__data" / "libgcpm"
+if sys.platform == "win32":
+	library = libpath / "libgcpm.dll"
+elif sys.platform == "darwin":
+	library = libpath / "libgcpm.dylib"
+else:
+	library = libpath / "libgcpm.so"
+
+libgcpm = ct.CDLL(str(library))
+
+
+
+#define the functions and their arguments
+#This is the model wrapper function
+_Cgcpm = libgcpm.GCPM
+_Cgcpm.restype = None
+_Cgcpm.argtypes = [	c_float_ptr,	#x
+					c_float_ptr,	#y
+					c_float_ptr,	#z
+					c_int_ptr,		#year
+					c_int_ptr,		#day number
+					c_float_ptr,	#ut in hours
+					c_float_ptr,	#kp index
+					c_int,			#number of positions to calculate density
+					c_float_ptr,	#electron density
+					c_float_ptr,	#proton density
+					c_float_ptr,	#helium density
+					c_float_ptr,	#oxygen density
+					c_int]			#verbosity flag
+
+#This will set the path of the model so it can find the data files
+_Csetpath = libgcpm.setLibPath
+_Csetpath.restype = None
+_Csetpath.argtypes = [c_str]
+
+_Csetpath(c_str((str(libpath) + "/").encode("utf-8")))

PyGCPM/__data/libgcpm/gcpm.py

@@ -0,0 +1,49 @@
+import numpy as np
+import ctypes as ct
+import DateTimeTools as TT
+
+c_str = ct.c_char_p
+c_bool = ct.c_bool
+c_int = ct.c_int
+c_float = ct.c_float
+c_double = ct.c_double
+c_int_ptr = np.ctypeslib.ndpointer(ct.c_int,flags="C_CONTIGUOUS")
+c_float_ptr = np.ctypeslib.ndpointer(ct.c_float,flags="C_CONTIGUOUS")
+c_double_ptr = np.ctypeslib.ndpointer(ct.c_double,flags="C_CONTIGUOUS")
+
+lib = ct.CDLL('./libgcpm.so')
+_Fgcpm = lib.gcpm_v24_
+_Fgcpm.restype = None
+_Fgcpm.argtypes = [	c_int_ptr,
+					c_float_ptr,
+					c_float_ptr,
+					c_float_ptr,
+					c_float_ptr,
+					c_float_ptr]
+
+_Csetpath = lib.setLibPath
+_Csetpath.restype = None
+_Csetpath.argtypes = [c_str]
+
+def gcpm(x,y,z,Date,ut,kp=1.0):
+	
+	#set the path
+	path = '/home/matt/gcpm/src/'
+	c_path = ct.c_char_p(path.encode('utf-8'))
+	_Csetpath(c_path)
+	
+	#convert date and time
+	doy = TT.DayNo(Date)
+	h,m,s = TT.DectoHHMM(ut,Split=True,ss=True)
+
+	itime = np.array([(Date // 10000)*1000 + doy,1000*(h*3600 + m*60 + s)],dtype='int32')
+	r = np.array([np.sqrt(x**2 + y**2 + z**2)],dtype='float32')
+	rho = np.sqrt(x**2 + y**2)
+	amlt = ((np.array([np.arctan2(-y,-x)*12/np.pi],dtype='float32') + 24.0) % 24.0)
+	alatr = np.array([np.arcsin(z/rho)],dtype='float32')
+	akp = np.array([kp],dtype='float32')
+	
+	out = np.zeros(4,dtype='float32')
+	_Fgcpm(itime,r,amlt,alatr,akp,out)
+
+	return out

PyGCPM/__data/libgcpm/iri/00readme.txt

@@ -0,0 +1,114 @@
+		International Reference Ionosphere 2007 (IRI2007) Software
+		----------------------------------------------------------
+
+================================================================================
+IMPORTANT: Updates and new versions of the IRI programs will be reported through 
+the IRInfo electronic mailer distribution. To subscribe send e-mail to 
+Majordomo@nssdc.gsfc.nasa.gov with the following text in the body of the
+message: subscribe iri (use 'unsubscribe' to remove yourself from the list)
+================================================================================
+
+The IRI is a joined project of the Committee on Space Research (COSPAR) and the 
+International Union of Radio Science (URSI). IRI is an empirical model specifying
+monthly averages of electron density, ion composition, electron temperature, and 
+ion temperature in the altitude range from 50 km to 1500 km.
+
+This directory includes the FORTRAN program, coefficients, and indices files for 
+the latest version of the International Reference Ionosphere model: IRI2007. This
+version includes several options for different parts and parameters. A logical
+array JF(30) is used to set these options. The IRI-recommended set of options
+can be found in the COMMENT section at the beginning of IRISUB.FOR. IRITEST.FOR 
+sets these options as the default.
+
+The compilation/link command in Fortran 77 is:
+f77 -o iri iritest.for irisub.for irifun.for iritec.for iridreg.for igrf.for cira.for
+
+================================================================================
+IMPORTANT: Please note that the following files have NOT been changed and are the
+same as for IRI2001: CCIR%%, URSI%%, DGRF45-DGRF95,
+================================================================================
+ 
+Directory Contents:
+-----------------------------------------------------------------------------------
+
+00_iri2007.tar	TAR file that includes all files from this directory. Was created
+				in UNIX using 'tar -cvf 00_iri2007.tar *'. UNIX command to unpack
+				is "tar -xvf 00_iri2007.tar". 
+				 
+irisub.for	    This file contains the main subroutine iri_sub. It computes 
+                height profiles if IRI output parameters (Ne, Te, Ti, Ni, vi) 
+                for specified date and location. Also included is the 
+                subroutine iri_web that computes output parameters versus
+                latitude, longitude (geog. or geom.), year, day of year, hour 
+                (LT or UT), and month. An example of how to call and use iri_web 
+                is shown in iritest.for. Compilation of iritest.for requires
+                irisub.for, irifun.for, iritec.for, iridreg.for, igrf.for, and
+                cira.for.
+
+irifun.for	    This file contains the subroutines and functions that are 
+                required for running IRI.
+
+iridreg.for     Subroutines for the D region models of Friedrich-Torkar
+                and of Danilov et al.
+
+iritec.for 	    This file includes the subroutines for computing the ionospheric 
+                electron content from 60km up to a specified upper limit. 
+
+cira.for	    This file includes the subroutines and functions for computing 
+		        the COSPAR International Reference Ionosphere 1986 (CIRA-86) 
+                neutral temperature. 
+
+igrf.for        This file includes the subroutines for the International
+                Geomagnetic Reference Field (IGRF).
+
+dgrf%%.dat      Definitive IGRF coefficients for the years 1945 to 2000 in steps
+                of 5 years (%%=45, 50, etc.)(ASCII).
+igrf05.dat      IGRF coefficients for 2005 (ASCII).
+igrf05s.dat     IGRF coefficients for 2005-2010 (ASCII).
+
+iritest.for 	Test program indicating how to use of the IRI subroutines. 
+                Requires irisub, irifun, iritec, iridreg, igrf,and cira.
+
+input.txt       Input parameters for a few examples using the iritest.for program.
+output.txt 	    Output from the test program for the input.txt input parameters.
+
+ig_rz.dat	    This file contains the solar and ionospheric indices (IG12, Rz12) 
+                for the time period from Jan 1958 onward. The file is updated 
+                quarterly. It is read by subroutine tcon in irifun.for (ASCII). 
+
+ap.dat		    This file provides the 3-hour ap magnetic index and F10.7 daily
+				index from 1960 onward (ASCII).
+
+CCIR%%.ASC,	    Coefficient files for the global representation of the F2 peak
+   URSI%%.ASC	peak parameters (foF2, M3000) where %% = Month+10 (ASCII). CCIR is
+                the model recommended by the International Committee Consultative  
+                on Radiocommunication (CCIR) of the International Union of 
+                Telecommunication (ITU). URSI is the model recommended by the 
+                International Union of Radio Science. IRI recommends the CCIR
+                model for the continents and the URSI model for the ocean areas.
+                If a single model is needed globally URSI is recommended.
+
+Stand-alone Programs:
+
+IMAZ			The Ionospheric model for the Auroral Zone (IMAZ) specifies the
+				electron density in the auroral E-region using a NeuralNet
+				approach and expecting as input (auroral) latitude, longitude, year,
+				day of year, hour, 3-hourly Ap, daily F10.7, and riometer 
+				absoprtion as an optional input if available. Consist of the
+				following files iri_imaz.for, imaztest.for, chapman.prn, 
+				press_60deg.txt, press_70deg.txt, and 00readme_imaz.txt.
+	
+akebono_te.for	Model for the plasmspheric electron temperature based on Akebono 
+				measurements. The file includes the model subroutines and 
+				coefficients and a simple driver program to illustrate its usage.  
+-----------------------------------------------------------------------------------
+
+Please consult the 'listing of changes' in the comments section at the top 
+of each one of these programs for recent corrections and improvements.
+
+More information about the IRI project can be found at
+	http://modelweb.gsfc.nasa.gov/ionos/iri.html
+IRI parameters can be calculated and plotted online at
+	http://modelweb.gsfc.nasa.gov/models/iri.html
+
+------------------------ dieter bilitza ------------------ May 2007

PyGCPM/__data/libgcpm/iri/IMAZ/00readme_imaz.txt

@@ -0,0 +1,44 @@
+README FILE
+
+IMAZ � Ionospheric Model for the Auroral Zone
+
+Lee-Anne McKinnell, April 2007
+
+(1) IMAZ has been developed for the purpose of obtaining prediction for the 
+electron density in the auroral zone. It is implemented as a
+separate option within IRI. 
+
+(2) IMAZ is valid for the Auroral Zone latitudes (around 70 degrees), and for 
+the altitude range from 50 km to about 150 km. 
+
+(3) A program, called IMAZTEST.FOR, has been provided for testing the implementation.
+
+(4) The main IMAZ subroutines are contained in a file called IRI_IMAZ.FOR, which
+should be linked to IMAZTEST.FOR when compiling. 
+
+(5) The following files are required by IRI_IMAZ.FOR: a) nighttruequiet.txt � 
+which is required for determining the rest absorption in the case where absorption 
+is considered as an input; b) chapman.prn � the chapman function is also required 
+for determining the rest absorption; c) press_70deg.txt & press_60deg.txt � 
+required for converting from pressure to altitude and back again, the model is 
+developed using the pressure levels as an input, but the user friendly output is by
+altitude level; 
+
+(6) The following inputs to the model are required: a) Geographic
+Latitude; b) Geographic Longitude; c) Year; d) day number; e) hour, in universal
+time (UT); f) the riometer absorption (if this is not available, enter -1 and
+the version that does not require this input will be used); g) the 3-hourly
+planetary magnetic A index; h) the daily F10.7 solar flux value; i) the altitude 
+for which the electron density is required (if the entire profile from 50 km to
+about 150 km is required, then enter -1); 
+
+(7) The output file contains 11 columns, the first 8 being the inputs,
+then the altitude in km, the predicted electron density and the error on the log
+of the predicted electron density. The density is 
+
+(8) Note that the electron density is given as the logarithm (to base 10) of the 
+electron density in [cm-3]. 
+
+Reference:
+McKinnel, L.A. and M. Friedrich, Results from a new lower ionosphere model, 
+Adv. Space Res., 37, #5, 1045-1050, 2006.