Package: abcgan-drivers
atmosense-abcgan-driversSoftware to generate the drivers for ABCGANInstallationThis package can be installed with pippip install git+https://github.com/sri-geospace/atmosense-abcgan-drivers.gitThe following external dependencies are required, some of which may need to be installed manually.numpyscipyh5pyflipchemapexpyskyfieldspacepypytzUsageThis package can be used to generate a full set of drivers both within other python scripts and as a stand-alone command line program.Python ScriptIn the following example, drivers are calculated once an hour on January 1, 2020.importabcdriversimportdatetimeasdtstarttime=dt.datetime(2020,1,1,0,0,0)endtime=dt.datetime(2020,1,2,0,0,0)timestep=1.0# in decimal hourssite_lat=65.5site_lon=-147.5# generate an array of times to calculate drivers attimes,utime=abcdrivers.generate_time_array(starttime,endtime,timestep)# calculate drivers for each timedrivers=abcdrivers.collect_drivers(times,site_lat,site_lon)Note that itcollect_drivers()can take in any array ofdatetime.datetimeobjects and it is not necessary to use thegenerate_time_array()function if the time array is created elsewhere.Command LineIn order to generate driver from the command line, you must create a config file following the format of the example provided in the project root directory.abcgan-drivers config.iniDrivers will be saved to an output hdf5 file along with some other information about the processing.  The output file name is specified in the config file.DriversKeyFull NameDescriptionMLTMagnetic Local TimeLocal time calculated used magnetic coordinate systemSLTSolar Local TimeLocal time as determined by the sun's positionMLATMagnetic LatitudeApex magnetic latitudeSZASolar Zenith AngleAngle between the sun and local zenithShadHeightShadow HeightHeight of the Earth's shadow in the atmospheremoon_xLunar Position (x)X component of Lunar position in GSE coordinatesmoon_yLunar Position (y)Y component of Lunar position in GSE coordinatesmoon_zLunar Position (z)Z component of Lunar position in GSE coordinatesmoon_phaseLunar PhaseLunar phase in degreesF10.7F10.7 Solar Radio FluxSolar rado flux at 10.7 cm (2800 MHz) in s.f.u (10^-22 W m^-2 Hz^-1)F10.7avgAverage F10.7 Solar Radio FluxAverage solar radio flux at 10.7 cm (2800 MHz) in s.f.u (10^-22 W m^-2 Hz^-1)apap Geomagnetic IndexThree hour equivalent planetary amplitudeApDaily Ap IndexDaily equivalent planetary amplitudedstDisturbance storm-time (Dst) indexIndex for geomagnetic storm activityTCIThermosphere Climate Index60-day running average of global cooling power radiated from the thermosphereMEIMultivariate ESNO IndexMeasure of the El Nino/Southern Oscillation (ESNO)/sea surface temperatureRMM1First MJO IndexFirst component of the Madden-Julian Oscillation IndicesRMM2Second MJO IndexSecond component of the Madden-Julian Oscillation IndicesT*Stratospheric TemperatureStratospheric Temperature at pressure level *U*Stratospheric WindStratospheric Wind at pressure level *Time Range LimitationsMany drivers are extracted from data files included as package data.  Consequentially, this package can only calculate drivers in the time ranges these data files cover.  To calculate drivers for recent times, the data files may need to be manually updated (seeabcdrivers/data_files/README.md).  This package cannot calculate drivers for future times.