This page was created by the IDL library routine mk_html_help2.

Last modified: Fri Apr 1 11:58:51 2022.


Directory Listing of Routines


Routine Descriptions

GOESR_CONFIG_FILEDIR

[Next Routine] [List of Routines]
 Function:
       goesr_config_filedir.pro

 Purpose:
       Get the applications user directory for SPEDAS


 $LastChangedBy: nikos $
 $LastChangedDate: 2020-12-21 10:57:20 -0800 (Mon, 21 Dec 2020) $
 $LastChangedRevision: 29545 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/goesr/goesr_config_filedir.pro $

(See projects/goesr/goesr_config_filedir.pro)


GOESR_INIT

[Previous Routine] [Next Routine] [List of Routines]
 Procedure:
       goesr_init

 Purpose:
       Initializes system variables for GOES-R data.  Can be called from idl_startup to set
             custom locations.

 Keywords:
       reset: resets configuration data already in place on the machine
       local_data_dir: location to save data files on the local machine
       remote_data_dir: location of the data on the remote machine
       no_color_setup: skip setting up the graphics configuration


 $LastChangedBy: nikos $
 $LastChangedDate: 2020-12-21 10:57:20 -0800 (Mon, 21 Dec 2020) $
 $LastChangedRevision: 29545 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/goesr/goesr_init.pro $

(See projects/goesr/goesr_init.pro)


GOESR_LOAD_DATA

[Previous Routine] [Next Routine] [List of Routines]
 Procedure:
     goesr_load_data

 Purpose:
     Loads data from GOES-R satelites (GOES-16, GOES-17)
     or from reprocessed data from earlier satelites (GOES 8-15).

 Keywords:
     trange:       Time range of interest
     datatype:     Type of GOES-R data to be loaded. Valid data types are:
                     'mag': Magnetometer (default: 1 min, 'hires': 0.1 sec)
                     'xrs': EXIS X-Ray Sensor (default: 1 min, 'hires': 1 sec);
                     'mpsh': Magnetospheric Electrons and Protons, Medium and High Energy (MPSH)
                             (default: 5 min, hires: 1 min)
                     'sgps': Solar and Galactic Proton Sensors (SGPS)
                             (default: 5 min, Hires: 1 min)
     prefix:        String to append to the beginning of the loaded tplot variables
     suffix:        String to append to the end of the loaded tplot variables
     prefix:        String to append to the beginning of the loaded tplot variables
     probes:        Array of GOES spacecrafts (8-17). Default is probes=['16'].
     varnames:      Array of names of variables to load. Defaults is all (*)
     downloadonly: Download files but don't load them into tplot.
     hires:        If set, download full data files (larger files, can be over 180MB).
                   If not set, use lowest available resolution (default).
     no_time_clip: Don't clip the tplot variables.
     get_support_data: Keep the support data.

 Notes:
     NOAA Site:  https://www.ngdc.noaa.gov/stp/satellite/goes-r.html
     data:   https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes/goes16/l2/data/

 $LastChangedBy: nikos $
 $LastChangedDate: 2021-10-15 16:54:16 -0700 (Fri, 15 Oct 2021) $
 $LastChangedRevision: 30371 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/goesr/goesr_load_data.pro $

(See projects/goesr/goesr_load_data.pro)


GOESR_OVERVIEW_PLOT

[Previous Routine] [Next Routine] [List of Routines]
 Procedure:
         goesr_overview_plot

 Purpose:
         Generates daily overview plots for GOES-R data (goes16-17)

 Keywords:
         date: start date for the overview plot
         duration: duration of the overview plot, in days; defaults to 1-day
         directory: local directory to save the overview plots to (should end with '/' or '\')
         makepng: generate png files
         device: change the plot device for cron plotting (for cron use device = 'z')
         geopack_lshell: calculate L-shell by tracing field lines
             to the equator instead of using the dipole assumption
         skip_ae_idx: set this keyword to skip downloading/plotting AE data
         error: 1 indicates an error, 0 for no error

 Keywords specific to creating overview plots in the GUI:
         gui_overplot: overview plot was created in the GUI
         oplot_calls: pointer to an int for tracking calls to overview plots - for
             avoiding overwriting tplot data already loaded during this session
         import_only: Used to make this routine import the data into the gui, but not plot it.


 $LastChangedBy: nikos $
 $LastChangedDate: 2022-03-18 12:52:44 -0700 (Fri, 18 Mar 2022) $
 $LastChangedRevision: 30691 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/goesr/goesr_overview_plot.pro $

(See projects/goesr/goesr_overview_plot.pro)


GOESR_READ_CONFIG

[Previous Routine] [Next Routine] [List of Routines]
 Function:
   goesr_read_config

 Purpose:
   Reads the goesr_config file

 Input:
   none, the filename is hardcoded, 'goesr_config.txt',and is s put in a
   folder given by the routine goesr_config_filedir, that uses the IDL
   routine app_user_dir() to create/obtain it

 Output:
   otp: a structure with the changeable fields of the !goesr structure


 $LastChangedBy: nikos $
 $LastChangedDate: 2020-12-21 10:57:20 -0800 (Mon, 21 Dec 2020) $
 $LastChangedRevision: 29545 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/goesr/goesr_read_config.pro $

(See projects/goesr/goesr_read_config.pro)


GOESR_WRITE_CONFIG

[Previous Routine] [List of Routines]
NAME:
 goesr_write_config
 
PURPOSE:
 Writes the goesr_config file
 
CALLING SEQUENCE:
 goesr_write_config, copy=copy
 
INPUT:
 none, the filename is hardcoded, 'goesr_config.txt',and is s put in a
 folder given by the routine thm_config_filedir, that uses the IDL
 routine app_user_dir to create/obtain it

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


$LastChangedBy: nikos $
$LastChangedDate: 2021-09-08 13:44:17 -0700 (Wed, 08 Sep 2021) $
$LastChangedRevision: 30284 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/goesr/goesr_write_config.pro $

(See projects/goesr/goesr_write_config.pro)