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

Last modified: Sat Jul 26 18:17:38 2025.

# Directory Listing of Routines

# projects/cluster/common

- CL_CONFIG
  This procedure serves as the Cluster configuration file. It sets global (system)
- CL_INIT
  Initializes system variables for Cluster. Can be called from idl_startup to set
- CL_LOAD_DATA
  Load Cluster data from NASA/SPDF
- CL_READ_CONFIG
  Reads the plug-in configuration file (cl_config.txt) for Cluster
- CL_SET_VERBOSE
  Sets verbose level in !cluster.verbose and in tplot_options

# Routine Descriptions

## CL_CONFIG

[Next Routine] [List of Routines]

    NAME:    cl_config

    PURPOSE:
      This procedure serves as the Cluster 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 "CL_INIT" procedure.

      This should be the only Cluster 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 do color setup if taken care for already
       COLORTABLE       Overwrite the default colortable initialization

    HISTORY:
     2019-12-23, egrimes, created based on mms_init

     $LastChangedBy: egrimes $
     $LastChangedDate: 2020-08-06 11:40:23 -0700 (Thu, 06 Aug 2020) $
     $LastChangedRevision: 29003 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/cluster/common/cl_config.pro $

(See projects/cluster/common/cl_config.pro)

## CL_INIT

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

    NAME:    cl_init

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

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

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

       !cluster.REMOTE_DATA_DIR  This is the URL of the server that can provide the data files.
                      (default is: "https://spdf.gsfc.nasa.gov/pub/data/cluster/")
                      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.

       !cluster.MIRROR_DATA_DIR  - this is a mirror directory (typically over the local network); setting this
                     will cause the load routines to check this for files after checking your local data directory.
                     If files are found here, they're copied to your local data directory, and the copied files
                     are loaded

       Regarding data directory environment variables: it is highly advised to use the mission specific environment variables
                      (e.g., CLUSTER_DATA_DIR) rather than ROOT_DATA_DIR to avoid conflicts with other missions/projects

       *** please note that setting REMOTE_DATA_DIR will have no effect when loading data from the LASP SDC, due to the
           custom web services at the SDC; this still allows you override the remote path to the data at SPDF, though ***

    KEYWORDS:
       RESET:           Reset !mms 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.
       MIRROR_DATA_DIR:  network mirror directory - for loading data from the local network; note that this
                        will copy files to your local data directory if they're found on the mirror, and this is
                        only checked if the files do not currently exist in the LOCAL_DATA_DIR. Only works on inital
                        call or reset.
       NO_COLOR_SETUP   do not set colors if already taken care of
       DEBUGGING_GUI:   set this keyword if you intend to put 'stop's in any GUI widget code, i.e., if you're debugging
                        any code that involves widget events (EVA or the SPEDAS GUI)

    HISTORY:
     2015-04-10, moka, Created based on 'thm_init'
     2015-02-15, egrimes, commented out dialog_message in CDF version error due to a bug on MacOS X 10.11.6/IDL 8.5
     2018-04-05, egrimes, added MIRROR_DATA_DIR functionality
     2019-08-28, egrimes, made debugging fix (!debug_process_events=0) dependent on a keyword (DEBUGGING_GUI)
                          this debugging fix is known to cause problems with widgets on some machines
     2019-12-23, egrimes, forked for Cluster

     $LastChangedBy: egrimes $
     $LastChangedDate: 2020-08-06 11:40:23 -0700 (Thu, 06 Aug 2020) $
     $LastChangedRevision: 29003 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/cluster/common/cl_init.pro $

(See projects/cluster/common/cl_init.pro)

## CL_LOAD_DATA

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

     PROCEDURE:
             cl_load_data

     PURPOSE:
             Load Cluster data from NASA/SPDF

             This routine is not meant to be called directly - please use
             the instrument specific wrappers: cl_load_xxx

     KEYWORDS:
             See the instrument load routines.

     EXAMPLE:
        cl_load_fgm, probe=1, level='l2', trange=['2016-01-10', '2016-01-11']

     NOTES:

    $LastChangedBy: egrimes $
    $LastChangedDate: 2020-08-06 11:40:23 -0700 (Thu, 06 Aug 2020) $
    $LastChangedRevision: 29003 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/cluster/common/cl_load_data.pro $

(See projects/cluster/common/cl_load_data.pro)

## CL_READ_CONFIG

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

     NAME:
       cl_read_config

     PURPOSE:
       Reads the plug-in configuration file (cl_config.txt) for Cluster

     CALLING SEQUENCE:
       cstruct = cl_read_config()

     OUTPUT:
       cstruct = a structure with the changeable fields of the !istp
               structure

     HISTORY:
       Cleaned up for new plug-ins by egrimes 14-may-2018
       Copied from thm_read_config and tt2000_read_config lphilpott 20-jun-2012

    $LastChangedBy: jwl $
    $LastChangedDate: 2021-05-20 16:55:32 -0700 (Thu, 20 May 2021) $
    $LastChangedRevision: 29976 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/cluster/common/cl_read_config.pro $

(See projects/cluster/common/cl_read_config.pro)

## CL_SET_VERBOSE

[Previous Routine] [List of Routines]

    NAME:
     cl_set_verbose
    PURPOSE:
     Sets verbose level in !cluster.verbose and in tplot_options
    CALLING SEQUENCE:
     cl_set_verbose, vlevel
    INPUT:
     vlevel = a verbosity level, if not set then !cluster.verbose is used
              (this is how you would propagate the !cluster.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 MMS from 'thm_set_verbose'
     23-dec-2019, egrimes, forked for Cluster

     $LastChangedBy: egrimes $
     $LastChangedDate: 2019-12-23 16:57:38 -0800 (Mon, 23 Dec 2019) $
     $LastChangedRevision: 28136 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/cluster/common/cl_set_verbose.pro $

(See projects/cluster/common/cl_set_verbose.pro)