projects/themis/common/
thm_init.pro
Routines
top source thm_init
thm_init, reset=reset, local_data_dir=local_data_dir, remote_data_dir=remote_data_dir, no_color_setup=no_color_setup, no_download=no_download
PROCEDURE: thm_init PURPOSE: Initializes system variables for themis. Can be called from idl_startup to set custom locations. The system variable !THEMIS is defined here. The elements of this structure are explained below: !THEMIS.LOCAL_DATA_DIR This is the root location for all THEMIS data files. The THEMIS software expects all data files to reside in specific subdirectories relative to this root directory.; !THEMIS.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. KEYWORDS: RESET: Reset !themis 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/themis/' ; This master directory is read only. REMOTE_DATA_DIR = '' ; Should be empty sting. (/disks/data/themis and server are the same) Desktop WINDOWS computer located at SSL LOCAL_DATA_DIR = '\\justice\data\themis\' ; Justice is a samba server (physically the same as /disk/data/themis) REMOTE_DATA_DIR = '' laptop WINDOWS computer located far from a data server, but with internet connection. LOCAL_DATA_DIR = 'C;\data\themis\' ; 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/themis/' ; 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 Davin Larson 2006-12-16 KRB Can now be called from idl_startup to set paths using optional keywords. 2007-07-02, jmm, Adds trailing slash to local and remote data dirs, if not there 2013-02-27, jmm, Added comment to test SVN commit $LastChangedBy: pcruce $ $LastChangedDate: 2014-11-06 19:32:47 -0800 (Thu, 06 Nov 2014) $ $LastChangedRevision: 16146 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_init.pro $
Keywords
- reset
- local_data_dir
- remote_data_dir
- no_color_setup
- no_download
File attributes
Modification date: | Fri Nov 21 06:43:14 2014 |
Lines: | 59 |