This page was created by the IDL library routine mk_html_help2.

Last modified: Wed Dec 6 12:50:16 2017.

general/spedas_tools/hapi

• HAPI_LOAD_DATA
  Load data and query information from a Heliophysics API server
  

Routine Descriptions

 PROCEDURE:
         hapi_load_data

 PURPOSE:
         Load data and query information from a Heliophysics API server

 KEYWORDS:
         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']
         capabilities: describes relevant capabilities for the HAPI server (optional)
         catalog:      provides a list of datasets available from the HAPI server (optional)
         info:         provides information on a given dataset (optional)
         dataset:      dataset to load (optional)
         
         server:       HAPI server to connect to (optional, defaults to: datashop.elasticbeanstalk.com)
         path:         HAPI path (URI to /hapi, optional, defaults to: /hapi)
         port:         HAPI server port (defaults to 80)
         scheme:       URL scheme (defaults to http)

 EXAMPLES:
  List server capabilities:
    IDL> hapi_load_data, /capabilities
    HAPI v1.1
    Output formats: csv, binary, json
  
  List the datasets available on this server:
    IDL> hapi_load_data, /catalog
    HAPI v1.1
    1: CASSINI_LEMMS_PHA_CHANNEL_1_SEC
    2: CASSINI_LEMMS_REG_CHANNEL_PITCH_ANGLE_10_MIN_AVG
    ....
  
  Get info on a dataset:
    IDL> hapi_load_data, /info, dataset='spase://VEPO/NumericalData/Voyager1/LECP/Flux.Proton.PT1H'
    HAPI v1.1
    Dataset: spase://VEPO/NumericalData/Voyager1/LECP/Flux.Proton.PT1H
    Start: 1977-09-07T00:00:00.000
    End: 2017-05-02T21:38:00.000
    Parameters: Epoch, year, doy, hr, dec_year, dec_doy, flux, flux_uncert
  
  Load and plot the Voyager flux data:
    IDL> hapi_load_data, trange=['77-09-27', '78-01-20'], dataset='spase://VEPO/NumericalData/Voyager1/LECP/Flux.Proton.PT1H'
    IDL> tplot, 'flux'
  
 NOTES:
         - capabilities, catalog, info keywords are informational
         - Requires IDL 8.3 or later due to json_parse + orderedhash usage
         

$LastChangedBy: egrimes $
$LastChangedDate: 2017-11-17 10:01:35 -0800 (Fri, 17 Nov 2017) $
$LastChangedRevision: 24296 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_1/general/spedas_tools/hapi/hapi_load_data.pro $

(See general/spedas_tools/hapi/hapi_load_data.pro)