This page was created by the IDL library routine mk_html_help2.

Last modified: Wed Jun 12 10:49:46 2024.

projects/bas

• BAS_INIT
  Initializes system variables for bas. Currently the variable only contains information
• BAS_LOAD_DATA
• BAS_READ_DATA
  

Routine Descriptions

NAME:    bas_init_private

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

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

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

   !bas.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 bas_init uses the remote data dir in the PRIVATE AREA
   *******

KEYWORDS:
   RESET:           Reset !bas 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/basin/common/bas_init.pro $

(See projects/bas/bas_init.pro)

 Procedure: bas_load_data

 Keywords:
             sites:         list of sites user wants to load into tplot 
             trange:        time range of interest [starttime, endtime] with the format
                            ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day
                            ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss']
             datatype:      type of bas data to be loaded (Is this needed?)
             suffix:        String to append to the end of the loaded tplot variables
             prefix:        String to append to the beginning of the loaded tplot variables
             /downloadonly: Download the file but don't read it (not implemented yet)
             /noupdate:     Don't download if file exists (not implemented, need to test when
                            two tvars are requested)
             /nodownload:   Don't download - use only local files (not implemented)
             verbose:       controls amount of error/information messages displayed
             /valid_names:  get list of BAS sites

 EXAMPLE:
   bas_load_data, site='ssss', trange=['2021-01-03','2021-01-04']

 NOTE:
 - Need to add No Update and No clobber
 - Need to correctly handle time clip
 - Add all standard tplot options
 - If no files downloaded notify user

 $LastChangedBy: clrusell $
 $LastChangedDate: 2017-02-13 15:32:14 -0800 (Mon, 13 Feb 2017) $
 $LastChangedRevision: 22769 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/bas/bas_load_data.pro $

(See projects/bas/bas_load_data.pro)

 Procedure: bas_read_data

 Keywords:
             filename:      full path name of the file
             site:          name of the magnetometer station 
             
 OUTPUT:
   bas_data : a structure in the standard tplot variable format
              ( data = {x:time, y:[H,D,Z]}

 EXAMPLE:
    bas_data = bas_read_data(filename, site)
    
 $LastChangedBy: clrussell $
 $LastChangedDate: 2017-02-13 15:32:14 -0800 (Mon, 13 Feb 2017) $
 $LastChangedRevision: 22769 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/bas/bas_load_data.pro $

(See projects/bas/bas_read_data.pro)