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

Last modified: Tue Nov 4 18:16:51 2025.

# Directory Listing of Routines

# projects/tracers/load_data

- TRACERS_GET_LOCAL_FILES
- TRACERS_LOAD_DATA

# Routine Descriptions

## TRACERS_GET_LOCAL_FILES

[Next Routine] [List of Routines]

    Procedure:
      tracers_get_local_files

    Purpose:
      Search for local TRACERS files in case a list cannot be retrieved from the
      remote server. Returns a sorted list of file paths.

    Calling Sequence:

      files = tracers_get_local_file_info( probe=probe, instrument=instrument, $
                data_rate=data_rate, level=level, datatype=datatype, trange=trange)

    Input:
      probe:  (string) Full spacecraft designation, e.g. 'ela'
      instrument:  (string) Instrument designation, e.g. 'fgm'
      data_rate:  (string) Data collection mode?  e.g. 'srvy'
      level:  (string) Data processing level, e.g. 'l1'
      trange:  (string/double) Two element time range, e.g. ['2015-06-22','2015-06-23']
      datatype:  (string) Optional datatype specification, e.g. 'pos'
      cdf_version: not yet implemented
      latest_version: not yet implemented
      min_version: not yet implemented
      mirror: not yet implemented
      pred: set this keyword if you want predicted state data. the default for state data is
            definitive

    Output:
      return value:  Sorted string array of file paths, if successful; 0 otherwise

    Notes:
      -Input strings should not contain wildcards (datatype may be '*')

    $LastChangedBy: jwl $
    $LastChangedDate: 2025-07-31 17:36:13 -0700 (Thu, 31 Jul 2025) $
    $LastChangedRevision: 33518 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/tracers/load_data/tracers_get_local_files.pro $

(See projects/tracers/load_data/tracers_get_local_files.pro)

## TRACERS_LOAD_DATA

[Previous Routine] [List of Routines]

    NAME:
      tracers_load_data

    KEYWORDS (commonly used by other load routines):
             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']
             probes:       list of probes, valid values for TRACERS probes are ['1','2'].
                           if no probe is specified the default is probe 'a'
             level:        indicates level of data processing. levels include 'l1' and 'l2'
                           The default if no level is specified is 'l1' (l1 default needs to be confirmed)
             datatype:     depends on the instrument, see header for the instruments load routine
             data_rate:    instrument data rates
             tplotnames:   returns a list of the names of the tplot variables loaded by the load routine
             get_support_data: load support data (defined by VAR_TYPE="support_data" in the CDF)
             no_color_setup: don't setup graphics configuration; use this keyword when you're
                           using this load routine from a terminal without an X server running
             no_time_clip: don't clip the data to the requested time range; note that if you do use
                           this keyword you may load a longer time range than requested.
             no_update:    (NOT YET IMPLEMENTED) set this flag to preserve the original data. if not set and newer
                           data is found the existing data will be overwritten
             suffix:       appends a suffix to the end of the tplot variable name. this is useful for
                           preserving original tplot variable.
             varformat:    should be a string (wildcards accepted) that will match the CDF variables
                           that should be loaded into tplot variables
             cdf_filenames:  this keyword returns the names of the CDF files used when loading the data
             cdf_version:  specify a specific CDF version # to load (e.g., cdf_version='4.3.0')
             cdf_records: specify the # of records to load from the CDF files; this is useful
                 for grabbing one record from a CDF file
             spdf:         grab the data from the SPDF instead of TRACERS server - ***NOTE: only state and epdef data are
                           at SPDF available
             available:    (NOT YET IMPLEMENTED) returns a list of files available at the SDC for the requested parameters
                           this is useful for finding which files would be downloaded (along with their sizes) if
                           you didn't specify this keyword (also outputs total download size)
             versions:     this keyword returns the version #s of the CDF files used when loading the data
             no_time_sort:    set this flag to not order by time and remove duplicates
             tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in
                           SPEDAS (e.g., tplot.pro) do not currently support these timestamps)
             pred: set this flag for 'predicted' state data. default state data is 'definitive'.
             public_data: set this flag to retrieve data from the public area (default is private dir)
    ;
    EXAMPLE:
       tracers_load_data,probe='a'

    NOTES:
       Since there is no data server - yet - files must reside locally.
       Current file naming convention is el[a/b]_ll_instr_yyyymmdd_v0*.cdf.
       Temporary fix for state CDF - state CDFs are the only CDFs that have version v02

(See projects/tracers/load_data/tracers_load_data.pro)