This page was created by the IDL library routine `mk_html_help2`.

Last modified: Tue Sep 2 18:17:29 2025.

# Directory Listing of Routines

# spedas_gui/misc

- SPD_CHECK_TPLOT2GUI
- SPD_GEN_OVERPLOT_AE_PANEL
- SPD_UI_SPEDAS_FILECONFIG
  A widget that allows the user to set some of the !spedas environmental variables. The user
- SPEDAS_CONFIG_FILEDIR
- SPEDAS_INIT
- SPEDAS_READ_CONFIG
  Reads the spedas_config file
- SPEDAS_WRITE_CONFIG
  Writes the spedas_config file

# Routine Descriptions

## SPD_CHECK_TPLOT2GUI

[Next Routine] [List of Routines]

     Procedure:
      spd_check_tplot2gui

     Purpose:
      Checks if a tplot variable can be loaded as a gui variable.

     Keywords:
             varname: a single tplot variable name
             tcheck: returns 1 if the tplot variable can be loaded to gui, 0 otherwise
             error: if the variable cannot be loaded to gui, this contains the type of error

     $LastChangedBy: nikos $
     $LastChangedDate: 2021-10-14 19:49:56 -0700 (Thu, 14 Oct 2021) $
     $LastChangedRevision: 30358 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spd_check_tplot2gui.pro $

(See spedas_gui/misc/spd_check_tplot2gui.pro)

## SPD_GEN_OVERPLOT_AE_PANEL

[Previous Routine] [Next Routine] [List of Routines]

     Procedure:
             spd_gen_overplot_ae_panel

     Purpose:
             Generates combined AE index for overview plots

     Keywords:
             date: start date for the plot
             duration: int how many days, default is one
             suffix: string for suffix
             out_tname: (output) tplot name
             error: (output) indicates an error

     Notes:
       This is used in THEMIS and GOES overview plots.
       Combines THEMIS AE with Kyoto AE.
       When the Kyoto AE is available, it shows [Themis AE (black, 0), Kyoto AE (blue, 2)]
       When the Kyoto AE is not available, it shows [Themis AE (black, 0), Real Time Kyoto AE 5-min (green, 4)]

     $LastChangedBy: crussell $
     $LastChangedDate: 2024-10-02 04:51:07 -0700 (Wed, 02 Oct 2024) $
     $LastChangedRevision: 32867 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spd_gen_overplot_ae_panel.pro $

(See spedas_gui/misc/spd_gen_overplot_ae_panel.pro)

## SPD_UI_SPEDAS_FILECONFIG

[Previous Routine] [Next Routine] [List of Routines]

    NAME:
     spd_ui_spedas_fileconfig

    PURPOSE:
     A widget that allows the user to set some of the !spedas environmental variables. The user
     can save the changes permanently to file, reset to default values, or cancel any changes
     made since the panel was displayed.

    HISTORY:

    $LastChangedBy: jwl $
    $LastChangedDate: 2025-08-20 11:11:05 -0700 (Wed, 20 Aug 2025) $
    $LastChangedRevision: 33563 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spd_ui_spedas_fileconfig.pro $

(See spedas_gui/misc/spd_ui_spedas_fileconfig.pro)

## SPEDAS_CONFIG_FILEDIR

[Previous Routine] [Next Routine] [List of Routines]

    Function: spedas_config_filedir.pro
    Purpose: Get the applications user directory for SPEDAS data analysis software

    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-12-03 13:50:06 -0800 (Thu, 03 Dec 2015) $
    $LastChangedRevision: 19523 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spedas_config_filedir.pro $

(See spedas_gui/misc/spedas_config_filedir.pro)

## SPEDAS_INIT

[Previous Routine] [Next Routine] [List of Routines]

    PROCEDURE:  spedas_init

    PURPOSE:    Initializes system variables for spedas data.
                Can be called from idl_startup to set custom locations.

    $LastChangedBy: egrimes $
    $LastChangedDate: 2019-08-30 10:22:52 -0700 (Fri, 30 Aug 2019) $
    $LastChangedRevision: 27701 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spedas_init.pro $

(See spedas_gui/misc/spedas_init.pro)

## SPEDAS_READ_CONFIG

[Previous Routine] [Next Routine] [List of Routines]

    NAME:
     spedas_read_config
    PURPOSE:
     Reads the spedas_config file
    CALLING SEQUENCE:
     cstruct = spedas_read_config()
    INPUT:
     none, for the purposes of this example the filename is hardcoded,
     'spedas_config.txt',and is put in a folder given by the routine
     istp_config_filedir, that uses the IDL
     routine app_user_dir to create/obtain it: my linux example:
     /disks/ice/home/jimm/.idl/spedas/spedas_config-4-linux
    OUTPUT:
     cstruct = a structure with the changeable fields of the !istp
               structure
     Copied from thm_read_config and tt2000_read_config lphilpott 20-jun-2012
    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-12-03 13:50:06 -0800 (Thu, 03 Dec 2015) $
    $LastChangedRevision: 19523 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spedas_read_config.pro $

(See spedas_gui/misc/spedas_read_config.pro)

## SPEDAS_WRITE_CONFIG

[Previous Routine] [List of Routines]

    NAME:
     spedas_write_config

    PURPOSE:
     Writes the spedas_config file

    CALLING SEQUENCE:
     spedas_write_config, copy=copy

    INPUT:
     none, the filename is hardcoded, 'spedas_config.txt',and is  put in a
     folder given by the routine spedas_config_filedir, that uses the IDL
     routine app_user_dir to create/obtain it: my linux example:
     /disks/ice/home/jimm/.idl/spedas/spedas_config-4-linux

    OUTPUT:
     the file is written, and a copy of any old file is generated

    KEYWORD:
     copy = if set, the file is read in and a copy with the !stime
            appended is written out

    HISTORY:

    $LastChangedBy: jwl $
    $LastChangedDate: 2025-08-20 11:11:05 -0700 (Wed, 20 Aug 2025) $
    $LastChangedRevision: 33563 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/misc/spedas_write_config.pro $

(See spedas_gui/misc/spedas_write_config.pro)