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

ELF_CONFIG

[Next Routine] [List of Routines]
  PRO elf_config

  This procedure serves as the elfin configuration file.  It sets global (system)
  variables and initializes devices

  This procedure will define the location of data files and the data server.
  This procedure is intended to be called from within the "ELF_INIT" procedure.

  This should be the only ELF file that requires modification for use in different
  locations.

  There is no need to modify this file if:
     - Your computer is an SSL UNIX machine that mounts "/disks/data/"   (i.e. ALL Linux and Solaris machines at SSL)
     - You use a portable computer that will be caching files on a local hard drive.


  Settings  in this file will be overridden by settings in the environment.

  KEYWORDS
     colortable  - sets the color table for spd_graphics_config. this is not
                   set if the no_color_setup keyword is used
     no_color_setup   added to prevent cronjob to crash, hfrey, 2007-02-10

  Author:  Davin Larson Nov 2006
           jmm, 2007-05-17, Altered to read thm_comfig text file,
           this removes the need for someone to alter this program
           jmm, 2007-07-02, applies slashes to remote and local
           directories, if they are not there
           cg, 2008-5-6, reset default default directory

 $LastChangedBy: nikos $
 $LastChangedDate: 2016-10-06 12:31:28 -0700 (Thu, 06 Oct 2016) $
 $LastChangedRevision: 22054 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_config.pro $

(See projects/elfin/common/elf_config.pro)


ELF_CONFIG_PUSH

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: elf_config_push
 
 PURPOSE: Puts structure A into structure B.
          By default, the same tag must exist in both structures.
 INPUT:  
    A - structure to be place in structure B
    B - structure that will contain structure A
 
 KEYWORD:
    force - if this keyword is set, a tag of 'A' does not necessarily be in 'B'.
            Such a tag will be forced (or newly added) into 'B'

(See projects/elfin/common/elf_config_push.pro)


ELF_INIT

[Previous Routine] [Next Routine] [List of Routines]
NAME:    elf_init

PURPOSE:
   Initializes system variables for elf. Currently the variable only contains information
   on the elfin local data directory. Lot's more features should be added. See thm_init
   for examples.

NOTE:
   The system variable !ELF is defined here, just like !THEMIS.
   The elements of this structure are explained below:

   !ELF.LOCAL_DATA_DIR    This is the root location for all elf data files.
                  The ELF software expects all data files to reside in specific subdirectories relative
                  to this root directory.;

   !ELF.REMOTE_DATA_DIR   This is not implemented yet because there is no server at this point in time.
                  A URL will most likely be available after launch.

   *******
   WARNING: This version of elf_init uses the remote data dir in the PUBLIC AREA
   *******

KEYWORDS:
   RESET:           Reset !elf to values in environment (or values in keywords).
   LOCAL_DATA_DIR:  use given value for local_data_dir, rather than environment. Only works on
                    initial call or reset.
   REMOTE_DATA_DIR: Not yet implemented.
   NO_COLOR_SETUP   do not set colors if already taken care of


HISTORY:
 2015-04-10, moka, Created based on 'thm_init'

 $LastChangedBy: moka $
 $LastChangedDate: 2015-07-07 11:34:49 -0700 (Tue, 07 Jul 2015) $
 $LastChangedRevision: 18027 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/common/elf_init.pro $

(See projects/elfin/common/elf_init.pro)


ELF_INIT_PRIVATE

[Previous Routine] [Next Routine] [List of Routines]
NAME:    elf_init_private

PURPOSE:
   Initializes system variables for elf. Currently the variable only contains information
   on the elfin local data directory. Lot's more features should be added. See thm_init
   for examples.

NOTE:
   The system variable !ELF is defined here, just like !THEMIS.
   The elements of this structure are explained below:

   !ELF.LOCAL_DATA_DIR    This is the root location for all elf data files.
                  The ELF software expects all data files to reside in specific subdirectories relative
                  to this root directory.;

   !ELF.REMOTE_DATA_DIR   This is not implemented yet because there is no server at this point in time.
                  A URL will most likely be available after launch.

   *******
   WARNING: This version of elf_init uses the remote data dir in the PRIVATE AREA
   *******

KEYWORDS:
   RESET:           Reset !elf to values in environment (or values in keywords).
   LOCAL_DATA_DIR:  use given value for local_data_dir, rather than environment. Only works on
                    initial call or reset.
   REMOTE_DATA_DIR: Not yet implemented.
   NO_COLOR_SETUP   do not set colors if already taken care of


HISTORY:
 2015-04-10, moka, Created based on 'thm_init'

 $LastChangedBy: moka $
 $LastChangedDate: 2015-07-07 11:34:49 -0700 (Tue, 07 Jul 2015) $
 $LastChangedRevision: 18027 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/common/elf_init.pro $

(See projects/elfin/common/elf_init_private.pro)


ELF_INIT_PUBLIC

[Previous Routine] [Next Routine] [List of Routines]
NAME:    elf_init_public

PURPOSE:
   Initializes system variables for elf. Currently the variable only contains information
   on the elfin local data directory. Lot's more features should be added. See thm_init
   for examples.

NOTE:
   The system variable !ELF is defined here, just like !THEMIS.
   The elements of this structure are explained below:

   !ELF.LOCAL_DATA_DIR    This is the root location for all elf data files.
                  The ELF software expects all data files to reside in specific subdirectories relative
                  to this root directory.;

   !ELF.REMOTE_DATA_DIR   This is not implemented yet because there is no server at this point in time.
                  A URL will most likely be available after launch.

   *******
   WARNING: This version of elf_init uses the remote data dir in the PUBLIC AREA
   *******

KEYWORDS:
   RESET:           Reset !elf to values in environment (or values in keywords).
   LOCAL_DATA_DIR:  use given value for local_data_dir, rather than environment. Only works on
                    initial call or reset.
   REMOTE_DATA_DIR: Not yet implemented.
   NO_COLOR_SETUP   do not set colors if already taken care of


HISTORY:
 2015-04-10, moka, Created based on 'thm_init'

 $LastChangedBy: moka $
 $LastChangedDate: 2015-07-07 11:34:49 -0700 (Tue, 07 Jul 2015) $
 $LastChangedRevision: 18027 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/common/elf_init.pro $

(See projects/elfin/common/elf_init_public.pro)


ELF_SET_VERBOSE

[Previous Routine] [List of Routines]
NAME:
 elf_set_verbose

PURPOSE:
 Sets verbose level in !elf.verbose and in tplot_options
 
CALLING SEQUENCE:
 elf_set_verbose, vlevel
 
INPUT:
 vlevel = a verbosity level, if not set then !elf.verbose is used
          (this is how you would propagate the !elf.verbose value
          into tplot options)
          
HISTORY:
 21-aug-2012, jmm, jimm@ssl.berkeley.edu
 12-oct-2012, jmm, Added this comment to test SVN
 12-oct-2012, jmm, Added this comment to test SVN, again
 18-oct-2012, jmm, Another SVN test
 10-apr-2015, moka, adapted for elf from 'thm_set_verbose'

 $LastChangedBy: egrimes $
 $LastChangedDate: 2017-07-13 07:39:47 -0700 (Thu, 13 Jul 2017) $
 $LastChangedRevision: 23597 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/common/elf_set_verbose.pro $

(See projects/elfin/common/elf_set_verbose.pro)