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

Last modified: Wed Dec 28 01:15:18 2011.

# Directory Listing of Routines

# ssl_general/missions/rbsp

- RBSP_CONFIG
- RBSP_CONFIG_FILEDIR
- RBSP_INIT
- RBSP_READ_CONFIG
  Reads the rbsp_config file

# Routine Descriptions

## RBSP_CONFIG

[Next Routine] [List of Routines]

      PRO rbsp_config

      This procedure serves as the rbsp 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 "RBSP_INIT" procedure.

      This should be the only RBSP 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.
      (see setup_themis or setup_themis_bash for examples of setting environment
      variables on UNIX-like systems.  The environment can also be set on Windows
      systems.)

      KEYWORDS
         no_color_setup: do not set colors if already taken care of

      Author:  Peter Schroeder Jul 2011

     $LastChangedBy: peters $
     $LastChangedDate: 2011-07-01 13:20:16 -0700 (Fri, 01 Jul 2011) $
     $LastChangedRevision: 8770 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/rbsp_config.pro $

(See ssl_general/missions/rbsp/rbsp_config.pro)

## RBSP_CONFIG_FILEDIR

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

    Function: rbsp_config_filedir.pro
    Purpose: Get the applications user directory for RBSP data analysis software

    $LastChangedBy: peters $
    $LastChangedDate: 2011-07-01 13:20:16 -0700 (Fri, 01 Jul 2011) $
    $LastChangedRevision: 8770 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/rbsp_config_filedir.pro $

(See ssl_general/missions/rbsp/rbsp_config_filedir.pro)

## RBSP_INIT

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

    PROCEDURE:  rbsp_init
    PURPOSE:    Initializes system variables for rbsp.  Can be called from idl_startup to set
                custom locations.

     The system variable !RBSP is defined here.  The elements of this structure are explained below:

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

     !RBSP.REMOTE_DATA_DIR   This is the URL of the server that can provide the data files.
                      (default is: "http://themis.ssl.berkeley.edu/data/themis/")
                      if the software does not find a needed file in LOCAL_DATA_DIR,
                      then it will attempt to download the data from the URL and REMOTE_DATA_DIR is defined,
                      the software will attempt to download the file from REMOTE_DATA_DIR, place it in LOCAL_DATA_DIR
                      with the same relative pathname, and then continue processing.
                      (NOT YET IMPLEMENTED)

    KEYWORDS:
       RESET:           Reset !rbsp 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: Use given value for remote_data_dir, rather than env.  Only works on inital
                        call or reset.
       NO_COLOR_SETUP   do not set colors if already taken care of

     Typical examples:

              Desktop UNIX/LINUX computer located at SSL
       LOCAL_DATA_DIR  = '/disks/data/rbsp/'               ; This master directory is read only.
       REMOTE_DATA_DIR = ''                                  ; Should be empty string. (/disks/data/rbsp and server are the same)

              Desktop WINDOWS computer located at SSL
       LOCAL_DATA_DIR  = '\\justice\data\rbsp\'            ; Justice is a samba server (physically the same as /disk/data/rbsp)
       REMOTE_DATA_DIR = ''

              laptop WINDOWS computer located far from a data server, but with internet connection.
       LOCAL_DATA_DIR  = 'C;\data\rbsp\'                              ; Local (portable) directory on laptop
       REMOTE_DATA_DIR = 'http://themis.ssl.berkeley.edu/data/themis/'    ;  URL used to download data to LOCAL_DATA_DIR

              MacOS computer located away from SSL without a nearby data server
       LOCAL_DATA_DIR  = '/data/rbsp/'                              ; Local (portable) directory on laptop
       REMOTE_DATA_DIR = 'http://themis.ssl.berkeley.edu/data/themis/'    ;  URL used to download data to LOCAL_DATA_DIR

       Note: If automatic downloads are used. (i.e. REMOTE_DATA_DIR is not an empty string) the user must ensure that
       LOCAL_DATA_DIR is writeable.

       Note to WINDOWS users: the WINDOWS version of IDL accepts both the '\' and '/' character as the directory
       separation character. The converse is not true.

    HISTORY
     Written by Peter Schroeder July 2011

    $LastChangedBy: peters $
    $LastChangedDate: 2011-07-01 13:20:16 -0700 (Fri, 01 Jul 2011) $
    $LastChangedRevision: 8770 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/rbsp_init.pro $

(See ssl_general/missions/rbsp/rbsp_init.pro)

## RBSP_READ_CONFIG

[Previous Routine] [List of Routines]

    NAME:
     rbsp_read_config
    PURPOSE:
     Reads the rbsp_config file
    CALLING SEQUENCE:
     cstruct = rbsp_read_config()
    INPUT:
     none, the filename is hardcoded, 'rbsp_config.txt',and is s put in a
     folder given by the routine rbsp_config_filedir, that uses the IDL
     routine app_user_dir to create/obtain it
    OUTPUT:
     cstruct = a structure with the changeable fields of the !rbsp
               structure
    HISTORY:
     01-jul-2011, peters
    $LastChangedBy: peters $
    $LastChangedDate: 2011-07-01 13:20:16 -0700 (Fri, 01 Jul 2011) $
    $LastChangedRevision: 8770 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/rbsp_read_config.pro $

(See ssl_general/missions/rbsp/rbsp_read_config.pro)