Directory: external/IDL_GEOPACK/

Contents

.pro files

calculate_lshell.pro

Name: CALCULATE_LSHELL Purpose: Calculates the l shell value given spacecraft position data in GSM coordinates Inputs: Spacecraft position vector, an array of [time, x, y, z] where time is double precision, and x, y, z, are in GSM coordinates and have units in RE Outputs: The l shell value, or -1L on failure Usage: lshell = calculate_lshell(pos_gsm_re) See Also: tkm2re.pro, thm_crib_calculate_lshell.pro History: Notes: This routine requires IDL geopack routines, returns -1L if not installed $LastChangedBy: egrimes $ $LastChangedDate: 2014-03-17 08:22:00 -0700 (Mon, 17 Mar 2014) $ $LastChangedRevision: 14543 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/external/IDL_GEOPACK/calculate_lshell.pro $

get_tsy_params.pro

PROCEDURE: get_tsy_params PURPOSE: this procedure will interpolate inputs, generate tsyganenko model parameters and store them in a tplot variable that can be passed directly to the model procedure relevant variables can be loaded from INPUTS: dst_tvar: tplot variable storing the dst index imf_tvar: tplot variable name storing the interplanetary magnetic field bvector in gsm Np_tvar: tplot variable name storing the solar wind ion density(rho) cm^-3 Vp_tvar: tplot variable name storing the proton velocity model: a string, should be 'T96','T01' or 'T04S' (upper or lower case) KEYWORDS: newname(optional): the name of the output tplot variable (default: t96_par','t01_par' or 't04s_par' depending on selected model) trange(optional): the time range over which the parameters should range, if not set, this program will check the timespan variable or prompt the user for a range speed(optional): set this if Vp_tvar is stored as a speed imf_yz(optional): set this to indicate that the imf_tvar is actually storing two separate tplot variables(the first being the y component of the imf and the second being the z) This can be done as follows: store_data,'omni_imf',data=['OMNI_HRO_1min_BY_GSM','OMNI_HRO_1min_BZ_GSM'] Then just pass omni_imf into get_tsy_params and set /imf_yz g_coefficients (optional): set this to specify a tplot variable containing the G coefficients for the T01 field model.

igp_test.pro

Function: igp_testPurpose: Tests whether the idl/geopack module is installed Provides installation message if not installedKeywords: geopack_2008: set to use the 2008 version of the Geopack library.

tsy_valid_coords.pro

Procedure : tsy_valid_coordsPurpose: Helper function used by Tsygenanko wrapper routines - checks coordinate system in dlimits structureInput: dlimits: dlimits structure from the tplot position variableKeywords: geopack_2008: specify to use the 2008 version of Geopack library.

tsy_valid_param.pro

Procedure : tsy_valid_paramPurpose: Helper function used by Tsygenanko wrapper routines.