added new idl docs

docs/code/idlaurorax_api_reference/data/aurorax_list_datasets.md

@@ -0,0 +1,41 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_list_datasets
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_LIST_DATASETS
+;
+; PURPOSE:
+;       Retrieve list of available datasets for which you can
+;       download data.
+;
+; EXPLANATION:
+;       Retrieve information about available datasets, including provider,
+;       short+long descriptions, and DOI details. Optional parameters are
+;       used to filter for certain matching datasets.
+;
+; CALLING SEQUENCE:
+;       aurorax_list_datasets()
+;
+; PARAMETERS:
+;       name         dataset name for filter on, case-sensitive and partial
+;                    matches are allowed. Optional.
+;
+; OUTPUT
+;       the found datasets
+;
+; OUTPUT TYPE:
+;       a list of structs
+;
+; EXAMPLES:
+;       datasets = aurorax_list_datasets()
+;       datasets = aurorax_list_datasets(name='THEMIS_ASI')
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/data/aurorax_list_observatories.md

@@ -0,0 +1,41 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_list_observatories
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_LIST_OVSERVATORIES
+;
+; PURPOSE:
+;       Retrieve list of available observatories where an instrument exists.
+;
+; EXPLANATION:
+;       Retrieve information about observatories, including full name, geodetic
+;       latitude and longitude. Optional parameters are used to filter for certain
+;       matching observatories.
+;
+; CALLING SEQUENCE:
+;       aurorax_list_observatories(instrument_array)
+;
+; PARAMETERS:
+;       insrument_array     the insrument array. Possible values are 'themis_asi',
+;                           'rego', 'trex_rgb', 'trex_nir', and 'trex_blue'.
+;       uid                 site unique identifier to filter on, optional
+;
+; OUTPUT
+;       the found observatories
+;
+; OUTPUT TYPE:
+;       a list of structs
+;
+; EXAMPLES:
+;       observatories = aurorax_list_observatories('themis_asi')
+;       observatories = aurorax_list_datasets('trex_rgb', uid='gill')
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/data/aurorax_ucalgary_download.md

@@ -0,0 +1,47 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_ucalgary_download
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_UCALGARY_DOWNLOAD
+;
+; PURPOSE:
+;       Download data from the UCalgary Open Data Platform
+;
+; EXPLANATION:
+;       Download data from the UCalgary Open Data Platform, for the given
+;       dataset, timeframe, and optional site/device.
+;
+; CALLING SEQUENCE:
+;       aurorax_ucalgary_download(dataset_name, start_ts, end_ts)
+;
+; PARAMETERS:
+;       dataset_name       name of the dataset to download data for
+;       start_ts           start timestamp, format as ISO time string (YYYY-MM-DDTHH:MM:SS)
+;       end_ts             end timestamp, format as ISO time string (YYYY-MM-DDTHH:MM:SS)
+;       site_uid           unique 4-letter site UID to filter on (e.g., atha, gill, fsmi), optional
+;       device_uid         unique device UID to filter on (e.g., themis08, rgb-09), optional
+;       download_path      path to save data to, default is your home directory; optional
+;
+; KEYWORDS:
+;       /OVERWRITE         download the files regardless of them existing locally already
+;       /QUIET             no print messages, data download will be silent
+;
+; OUTPUT
+;       information about the downloaded data
+;
+; OUTPUT TYPE:
+;       a struct
+;
+; EXAMPLES:
+;       d = aurorax_ucalgary_download('THEMIS_ASI_RAW','2022-01-01T06:00:00','2022-01-01T06:59:59',site_uid='atha')
+;       d = aurorax_ucalgary_download('TREX_RGB_RAW_NOMINAL','2022-01-01T06:00:00','2022-01-01T06:00:00',/overwrite)
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/data/aurorax_ucalgary_download_best_skymap.md

@@ -0,0 +1,44 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_ucalgary_download_best_skymap
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_UCALGARY_DOWNLOAD_BEST_SKYMAP
+;
+; PURPOSE:
+;       Download the best skymap for the corresponding parameters
+;
+; EXPLANATION:
+;       Download the best skymap for the given dataset name, timestamp, and site UID
+;
+; CALLING SEQUENCE:
+;       aurorax_ucalgary_download_best_skymap(dataset_name, site_uid, time_stamp)
+;
+; PARAMETERS:
+;       dataset_name       name of the skymap dataset to download data for
+;       site_uid           unique 4-letter site UID to retrieve skymap for
+;       time_stamp         timestamp, format as ISO time string (YYYY-MM-DDTHH:MM:SS)
+;       download_path      path to save data to, default is your home directory; optional
+;
+; KEYWORDS:
+;       /OVERWRITE         download the skymap files regardless of them existing locally already
+;       /QUIET             no print messages, data download will be silent
+;
+; OUTPUT
+;       information about the downloaded data
+;
+; OUTPUT TYPE:
+;       a struct
+;
+; EXAMPLES:
+;       d = aurorax_ucalgary_download_best_skymap('THEMIS_ASI_SKYMAP_IDLSAV','atha','2020-01-01T00:00:00')
+;       d = aurorax_ucalgary_download_best_skymap('TREX_RGB_SKYMAP_IDLSAV','gill','2023-02-01T06:00:00',/overwrite)
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/data/aurorax_ucalgary_get_urls.md

@@ -0,0 +1,45 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_ucalgary_get_urls
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_UCALGARY_GET_URLS
+;
+; PURPOSE:
+;       Retrieve list of URLS that can be downloaded from the UCalgary
+;       Open Data Platform.
+;
+; EXPLANATION:
+;       Retrieve the URLs of files available for download from the UCalgary
+;       Open Data Platform, for the given dataset, timeframe, and optional
+;       site/device. This function is used by the aurorax_ucalgary_download()
+;       function.
+;
+; CALLING SEQUENCE:
+;       aurorax_ucalgary_get_urls(dataset_name, start_ts, end_ts)
+;
+; PARAMETERS:
+;       dataset_name       name of the dataset to get URLs of data files for
+;       start_ts           start timestamp, format as ISO time string (YYYY-MM-DDTHH:MM:SS)
+;       end_ts             end timestamp, format as ISO time string (YYYY-MM-DDTHH:MM:SS)
+;       site_uid           unique 4-letter site UID to filter on (e.g., atha, gill, fsmi), optional
+;       device_uid         unique device UID to filter on (e.g., themis08, rgb-09), optional
+;
+; OUTPUT
+;       information about the available URLs of data files
+;
+; OUTPUT TYPE:
+;       a struct
+;
+; EXAMPLES:
+;       u = aurorax_ucalgary_get_urls('THEMIS_ASI_RAW','2022-01-01T06:00:00','2022-01-01T06:59:59',site_uid='atha')
+;       u = aurorax_ucalgary_get_urls('TREX_RGB_RAW_NOMINAL','2022-01-01T06:00:00','2022-01-01T06:00:00')
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/data/aurorax_ucalgary_is_read_supported.md

@@ -0,0 +1,44 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_ucalgary_is_read_supported
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_UCALGARY_IS_READ_SUPPORTED
+;
+; PURPOSE:
+;       Determine if a given dataset is supported in the aurorax_ucalgary_read()
+;       function.
+;
+; EXPLANATION:
+;       Some datasets provided by UCalgary require special readfile routines. This
+;       function provides the ability to programmatically determine if a dataset
+;       is supported in the aurorax_ucalgary_read() function.
+;
+;       Some datasets are simple enough for special read routines to be needed. For
+;       example, 'THEMIS_ASI_DAILY_KEOGRAM_JPG', can be read in using the built-in
+;       READ_JPEG procedure.
+;
+; CALLING SEQUENCE:
+;       aurorax_ucalgary_is_read_supported(dataset_name)
+;
+; PARAMETERS:
+;       dataset_name       name of the dataset check for read support
+;
+; OUTPUT
+;       0 for False, 1 for True
+;
+; OUTPUT TYPE:
+;       integer
+;
+; EXAMPLES:
+;       supported = aurorax_ucalgary_is_read_supported('THEMIS_ASI_RAW')
+;       supported = aurorax_ucalgary_is_read_supported('THEMIS_ASI_DAILY_KEOGRAM_JPG')
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/data/aurorax_ucalgary_read.md

@@ -0,0 +1,45 @@
+---
+hide:
+  - toc
+---
+
+# aurorax_ucalgary_read
+
+```
+;-------------------------------------------------------------
+;+
+; NAME:
+;       AURORAX_UCALGARY_READ
+;
+; PURPOSE:
+;       Read data downloaded from the UCalgary Open Data Platform
+;
+; EXPLANATION:
+;       Read data files that were dowloaded from the UCalgary Open
+;       Data Platform.
+;
+; CALLING SEQUENCE:
+;       aurorax_ucalgary_read(dataset, file_list)
+;
+; PARAMETERS:
+;       dataset            struct for the dataset that is being read in (retrieved from aurorax_list_dataset() function)
+;       file_list          list of files on the local computer to read in (can also be a single filename string)
+;
+; KEYWORDS:
+;       /FIRST_RECORD      only read the first record/frame/image in each file
+;       /NO_METADATA       exclude reading of metadata
+;       /QUIET             read data silently, no print messages will be shown
+;
+; OUTPUT
+;       the loaded data
+;
+; OUTPUT TYPE:
+;       a struct
+;
+; EXAMPLES:
+;       download_obj = aurorax_ucalgary_download('THEMIS_ASI_RAW','2022-01-01T06:00:00','2022-01-01T06:59:59',site_uid='gill')
+;       data = aurorax_ucalgary_read(d.dataset,f)
+;       help,data
+;+
+;-------------------------------------------------------------
+```

docs/code/idlaurorax_api_reference/index.md

@@ -0,0 +1,55 @@
+---
+hide:
+  - toc
+---
+
+# IDL-AuroraX API Reference
+
+IDL-AuroraX is an IDL library for interacting with the AuroraX platform. It can be used to retrieve data such as ephemeris and data product records, and perform conjunction searches.
+
+The below pages provide the documentation for each function. Examples can be found in the over-arching "Basic Usage" and "Advanced Usage" sections.
+
+## Data Download and Reading
+
+- [`aurorax_list_datasets`](/code/idlaurorax_api_reference/data/aurorax_list_datasets/)
+- [`aurorax_list_observatories`](/code/idlaurorax_api_reference/data/aurorax_list_observatories/)
+- [`aurorax_ucalgary_get_urls`](/code/idlaurorax_api_reference/data/aurorax_ucalgary_get_urls/)
+- [`aurorax_ucalgary_download`](/code/idlaurorax_api_reference/data/aurorax_ucalgary_download/)
+- [`aurorax_ucalgary_download_best_skymap`](/code/idlaurorax_api_reference/data/aurorax_ucalgary_download_best_skymap/)
+- [`aurorax_ucalgary_read`](/code/idlaurorax_api_reference/data/aurorax_ucalgary_read/)
+- [`aurorax_ucalgary_is_read_supported`](/code/idlaurorax_api_reference/data/aurorax_ucalgary_is_read_supported/)
+
+## Analysis Support Software
+
+- [`aurorax_bounding_box_extract_metric`](/code/idlaurorax_api_reference/tools/aurorax_bounding_box_extract_metric/)
+- [`aurorax_calibrate_rego`](/code/idlaurorax_api_reference/tools/aurorax_calibrate_rego/)
+- [`aurorax_calibrate_trex_nir`](/code/idlaurorax_api_reference/tools/aurorax_calibrate_trex_nir/)
+- [`aurorax_keogram_add_axis`](/code/idlaurorax_api_reference/tools/aurorax_keogram_add_axis/)
+- [`aurorax_keogram_create_custom`](/code/idlaurorax_api_reference/tools/aurorax_keogram_create_custom/)
+- [`aurorax_keogram_create`](/code/idlaurorax_api_reference/tools/aurorax_keogram_create/)
+- [`aurorax_keogram_plot`](/code/idlaurorax_api_reference/tools/aurorax_keogram_plot/)
+- [`aurorax_mosaic_plot`](/code/idlaurorax_api_reference/tools/aurorax_mosaic_plot/)
+- [`aurorax_mosaic_oplot`](/code/idlaurorax_api_reference/tools/aurorax_mosaic_oplot/)
+- [`aurorax_mosaic_prep_images`](/code/idlaurorax_api_reference/tools/aurorax_mosaic_prep_images/)
+- [`aurorax_mosaic_prep_skymap`](/code/idlaurorax_api_reference/tools/aurorax_mosaic_prep_skymap/)
+- [`aurorax_get_decomposed_color`](/code/idlaurorax_api_reference/tools/aurorax_get_decomposed_color/)
+- [`aurorax_movie`](/code/idlaurorax_api_reference/tools/aurorax_movie/)
+
+## TREx Auroral Transport Model (ATM)
+
+- Coming soon!
+
+## AuroraX Search Engine
+- [`aurorax_conjunction_search`](/code/idlaurorax_api_reference/search/conjunctions/search/)
+- [`aurorax_open_conjunctions_in_aurorax`](/code/idlaurorax_api_reference/search/conjunctions/open_in_aurorax/)
+- [`aurorax_open_conjunctions_in_swarmaurora`](/code/idlaurorax_api_reference/search/conjunctions/open_in_swarmaurora/)
+- [`aurorax_save_swarmaurora_custom_import_file`](/code/idlaurorax_api_reference/search/conjunctions/save_swarmaurora_import_file/)
+- [`aurorax_create_advanced_distances_hash`](/code/idlaurorax_api_reference/search/conjunctions/create_advanced_distances/)
+- [`aurorax_create_criteria_block`](/code/idlaurorax_api_reference/search/conjunctions/create_criteria_block/)
+- [`aurorax_create_metadata_filter`](/code/idlaurorax_api_reference/search/metadata_filters/create_metadata_filter/)
+- [`aurorax_create_metadata_filter_expression`](/code/idlaurorax_api_reference/search/metadata_filters/create_expression/)
+- [`aurorax_data_products_availability`](/code/idlaurorax_api_reference/search/availability/data_products/)
+- [`aurorax_data_product_search`](/code/idlaurorax_api_reference/search/data_products/search/)
+- [`aurorax_ephemeris_availability`](/code/idlaurorax_api_reference/search/availability/ephemeris/)
+- [`aurorax_ephemeris_search`](/code/idlaurorax_api_reference/search/ephemeris/search/)
+- [`aurorax_sources_list`](/code/idlaurorax_api_reference/search/sources/list/)