This page was created by the IDL library routine mk_html_help2.

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

Directory Listing of Routines

Routine Descriptions

SOSMAG_CRIB

 [Next Routine] [List of Routines] 
 Procedure:
  sosmag_crib

 Purpose:
  Demonstrate how to load and plot SOSMAG data.


$LastChangedBy: nikos $
$LastChangedDate: 2023-09-05 16:26:53 -0700 (Tue, 05 Sep 2023) $
$LastChangedRevision: 32080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/hapi/sosmag_crib.pro $

(See projects/sosmag/hapi/sosmag_crib.pro)

SOSMAG_HAPI_LOAD_DATA

 [Previous Routine] [Next Routine] [List of Routines] 
 Procedure:
  sosmag_hapi_load_data

 Purpose:
  Loads SOSMAG data using the ESA HAPI server.

 Keywords:
     trange:     Time range of interest (array with 2 elements, start and end time)
     dataset:    Two datasets are available: recalibrated (default) and 1-min:
                      'spase://SSA/NumericalData/GEO-KOMPSAT-2A/esa_gk2a_sosmag_recalib'
                      'spase://SSA/NumericalData/GEO-KOMPSAT-2A/esa_gk2a_sosmag_1m'
     recalib:    If 1 then select recalibrated dataset, if 0 select 1-min dataset
     prefix:     String to append to the beginning of the loaded tplot variables
     tplotnames: Array of strings with the tplot variables that were loaded.


$LastChangedBy: nikos $
$LastChangedDate: 2023-09-05 16:26:53 -0700 (Tue, 05 Sep 2023) $
$LastChangedRevision: 32080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/hapi/sosmag_hapi_load_data.pro $

(See projects/sosmag/hapi/sosmag_hapi_load_data.pro)

SOSMAG_HAPI_QUERY

 [Previous Routine] [Next Routine] [List of Routines] 
 Procedure:
  sosmag_hapi_query

 Purpose:
  Sends a query to SOSMAG HAPI server.
  Receives a json answer.


 Notes:
  SOSMAG HAPI server is: 'https://swe.ssa.esa.int/hapi/'
  As of 2021/12/03 the server has non-standard behavior that requires special treatment:
    1. It requires username and password for each user.
    2. The catalog contains 134 datasets, but only 2 are actually available.
    3. By design, it returns Error 500 responses that cannot be parsed by json.
  All the above may be changed in the future.


$LastChangedBy: nikos $
$LastChangedDate: 2023-09-05 16:26:53 -0700 (Tue, 05 Sep 2023) $
$LastChangedRevision: 32080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/hapi/sosmag_hapi_query.pro $

(See projects/sosmag/hapi/sosmag_hapi_query.pro)

SOSMAG_JSON_PARSE

 [Previous Routine] [Next Routine] [List of Routines] 
 Procedure:
  sosmag_json_parse

 Purpose:
  Returns empty orderedhash if the IDL json_parse function cannot handle the string.


 Notes:
  The SOSMAG HAPI server sometimes sends responses that are not json
  and can cause IDL errors if not handled.


$LastChangedBy: nikos $
$LastChangedDate: 2023-09-05 16:26:53 -0700 (Tue, 05 Sep 2023) $
$LastChangedRevision: 32080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/hapi/sosmag_json_parse.pro $

(See projects/sosmag/hapi/sosmag_json_parse.pro)

SOSMAG_LOAD_DATA

 [Previous Routine] [Next Routine] [List of Routines] 
 Procedure:
  sosmag_load_data

 Purpose:
  Load SOSMAG data.

 Keywords:
     server:     Server to use. Default is HAPI.
     trange:     Time range of interest (array with 2 elements, start and end time)
     dataset:    Two datasets are available: recalibrated (default) and 1-min:
                      'spase://SSA/NumericalData/GEO-KOMPSAT-2A/esa_gk2a_sosmag_recalib'
                      'spase://SSA/NumericalData/GEO-KOMPSAT-2A/esa_gk2a_sosmag_1m'
     recalib:    If 1 then select recalibrated dataset, if 0 select 1-min dataset
     prefix:     String to append to the beginning of the loaded tplot variables
     tplotnames: Array of strings with the tplot variables that were loaded.


$LastChangedBy: nikos $
$LastChangedDate: 2023-09-05 16:26:53 -0700 (Tue, 05 Sep 2023) $
$LastChangedRevision: 32080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/hapi/sosmag_load_data.pro $

(See projects/sosmag/hapi/sosmag_load_data.pro)

SOSMAG_READ_PASSWORD

 [Previous Routine] [List of Routines] 
 Procedure:
  sosmag_read_password

 Purpose:
  Read the username and password for SOSMAG.


 Notes:
   SOSMAG requires a username and password for each user.
   These should be saved in a file 'sosmag_password.txt'
   that resides in the same directory as the present file.
   It should contain the username and password separated by =,
   for example:
     username=spedas
     password=adg4kgpGf9Bh26v2


$LastChangedBy: nikos $
$LastChangedDate: 2023-09-05 16:26:53 -0700 (Tue, 05 Sep 2023) $
$LastChangedRevision: 32080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/hapi/sosmag_read_password.pro $

(See projects/sosmag/hapi/sosmag_read_password.pro)