Working with our data

Our data is accessible using several different methods. In the Downloading data section we discuss these options, along with details about several software packages and our API. A collection of quick piece-wise examples in Python and IDL are available to help you get started on working with the data.

Downloading Data

Fully open archive

All methods of accessing our data archive require no username or password authentication.

Our data is available using Python and IDL libraries, basic HTTP, Rsync, FTP, and our API directly.

• HTTP: by project, by instrument type

• Rsync: rsync rsync://data.phys.ucalgary.ca

• FTP: ftp://data.phys.ucalgary.ca

• Python: PyAuroraX, PyUCRio

• IDL: IDL-AuroraX, IDL-UCRio (coming soon)

• RESTful API: https://api.phys.ucalgary.ca

Software Packages

NEW! Analysis support software for optical and riometer data

We have released new analysis support libraries for working with the optical and riometer data we provide. Software is available for both Python and IDL.

PyAuroraX / IDL-AuroraX are for working with the optical data (all-sky imagers, spectrographs), and PyUCRio / IDL-UCRio are for working with the riometer data (single frequency riometers, hyper-spectral riometers).

Examples of using these libraries are shown in the below crib sheets. If you have questions, please reach out to our team: Emma Spanswick, Eric Donovan.

UCalgary has several Python and IDL tools available to work with our data:

• Optical instruments (All-sky Imagers, Spectrographs)

  • Python: PyAuroraX

  • IDL: IDL-AuroraX

• Riometer instruments (single frequency riometers, hyper-spectral riometers)

  • Python: PyUCRio

  • IDL: IDL-UCRio (coming soon)

If you have any questions or feature requests for the software packages, feel free to reach out to the UCalgary team: Emma Spanswick, Eric Donovan.

API

The UCalgary Space Remote Sensing API is a RESTful web service that provides various functions for our data best facilitated by such a service. The API and its interactive documentation can be found at https://api.phys.ucalgary.ca.

The API it utilized by our Python and IDL libraries PyAuroraX, PyUCRio, IDL-AuroraX, and IDL-UCRio. We recommend that you utilize these libraries instead of the API directly. However, the option is always there for you to use the API directly if it best suites your use-case. Please reach out to the UCalgary Team if you have any questions: Emma Spanswick, Eric Donovan.

Crib Sheets

The below links are meant to provide access to simple examples of various tasks when working with our data. These examples can also be found in the PyAuroraX, and IDL-AuroraX Github repositories, if you prefer to browse them there.

Python

Package	Category	Description	Open
PyAuroraX	Data Access	Explore datasets and observatories
PyAuroraX	Data Access	Download and read data
PyAuroraX	Data Access	Download skymaps and calibrations
PyAuroraX	Analysis Support	Add contours to CCD image
PyAuroraX	Analysis Support	Extract metrics from bounding box
PyAuroraX	Analysis Support	Create movie
PyAuroraX	Analysis Support	Create REGO keograms
PyAuroraX	Analysis Support	Create THEMIS ASI keograms
PyAuroraX	Analysis Support	Create TREx Blueline keograms
PyAuroraX	Analysis Support	Create TREx NIR keograms
PyAuroraX	Analysis Support	Create TREx RGB keograms
PyAuroraX	Analysis Support	Create TREx Spectrograph keograms
PyAuroraX	Analysis Support	Create THEMIS ASI montages
PyAuroraX	Analysis Support	Create TREx RGB montages
PyAuroraX	Analysis Support	Create THEMIS ASI mosaic
PyAuroraX	Analysis Support	Create TREx RGB mosaic
PyAuroraX	Analysis Support	Create TREx Spectrograph+RGB mosaic
PyAuroraX	Analysis Support	Plot TREx Spectrograph data
PyAuroraX	Analysis Support	Create REGO Rayleighs-converted mosaic
PyAuroraX	Analysis Support	Add contours to mosaic
PyAuroraX	Analysis Support	Apply REGO correction and calibrations
PyAuroraX	Analysis Support	Apply TREx NIR correction and calibrations
PyAuroraX	Analysis Support	Create multi-network mosaic
PyAuroraX	Analysis Support	Create custom keogram
PyAuroraX	Analysis Support	Mosaic with satellite location data
PyAuroraX	Analysis Support	Load and plot THEMIS grid data
PyAuroraX	Analysis Support	Load and plot TREx RGB grid data
PyAuroraX	Analysis Support	Load and plot TREx NIR grid data
PyAuroraX	Analysis Support	Load and plot REGO grid data
PyAuroraX	Analysis Support	Load and plot TREx RGB 5577-derived grid data
PyAuroraX	Auroral Transport Model	Perform ATM forward calculation
PyAuroraX	Auroral Transport Model	Perform ATM forward calculation using custom spectrum
PyAuroraX	Auroral Transport Model	Perform ATM inverse calculation
PyAuroraX	AuroraX Search Engine	Explore data sources
PyAuroraX	AuroraX Search Engine	Perform conjunction searches
PyAuroraX	AuroraX Search Engine	Perform ephemeris searches
PyAuroraX	AuroraX Search Engine	Perform data product searches
PyAuroraX	AuroraX Search Engine	Determine data availability
PyAuroraX	AuroraX Search Engine	Explore metadata in ephemeris records
PyAuroraX	AuroraX Search Engine	Explore machine learning metadata in AuroraX
PyUCRio	Data Access	Explore datasets and observatories
PyUCRio	Data Access	Download and read data
PyUCRio	Analysis Support	Plot riometer data

IDL

Package	Category	Name	Open
IDL-AuroraX	Data Access	Explore datasets and observatories
IDL-AuroraX	Data Access	Download data
IDL-AuroraX	Data Access	Read data
IDL-AuroraX	Analysis Support	Add contours to CCD image
IDL-AuroraX	Analysis Support	Extract lumonosity from bounding box (THEMIS)
IDL-AuroraX	Analysis Support	Extract lumonosity from bounding box using percentile (TREx RGB)
IDL-AuroraX	Analysis Support	Create THEMIS keograms
IDL-AuroraX	Analysis Support	Create REGO keograms
IDL-AuroraX	Analysis Support	Create TREx RGB keograms
IDL-AuroraX	Analysis Support	Create TREx Spectrograph keograms	Coming soon
IDL-AuroraX	Analysis Support	Create THEMIS ASI montage
IDL-AuroraX	Analysis Support	Create TREx RGB montage
IDL-AuroraX	Analysis Support	Create THEMIS ASI mosaic
IDL-AuroraX	Analysis Support	Create TREx RGB mosaic
IDL-AuroraX	Analysis Support	Create TREx Spectrograph+RGB mosaic	Coming soon
IDL-AuroraX	Analysis Support	Plot TREx Spectrograph data	Coming soon
IDL-AuroraX	Analysis Support	Create movie
IDL-AuroraX	Analysis Support	Create custom keogram
IDL-AuroraX	Analysis Support	Apply REGO correction and calibrations
IDL-AuroraX	Analysis Support	Apply TREx NIR correction and calibrations
IDL-AuroraX	Analysis Support	Mosaic with satellite location data (single spacecraft)
IDL-AuroraX	Analysis Support	Mosaic with satellite location data (multiple spacecraft)
IDL-AuroraX	Analysis Support	REGO mosaic in calibrated Rayleighs
IDL-AuroraX	Analysis Support	Create multi-network mosaic
IDL-AuroraX	Analysis Support	Load and plot THEMIS grid data
IDL-AuroraX	Analysis Support	Load and plot TREx RGB grid data
IDL-AuroraX	Analysis Support	Load and plot TREx NIR grid data
IDL-AuroraX	Analysis Support	Load and plot REGO grid data
IDL-AuroraX	Analysis Support	Load and plot TREx RGB 5577-derived grid data
IDL-AuroraX	Auroral Transport Model	Perform ATM forward calculation
IDL-AuroraX	Auroral Transport Model	Perform ATM forward calculation using custom spectrum
IDL-AuroraX	Auroral Transport Model	Perform ATM inverse calculation
IDL-AuroraX	AuroraX Search Engine	Explore data sources
IDL-AuroraX	AuroraX Search Engine	Perform conjunction searches
IDL-AuroraX	AuroraX Search Engine	Perform ephemeris searches
IDL-AuroraX	AuroraX Search Engine	Perform data product searches
IDL-AuroraX	AuroraX Search Engine	Determine data availability
IDL-AuroraX	AuroraX Search Engine	Explore machine learning metadata in AuroraX
IDL-UCRio	Data Access	Explore datasets and observatories	Coming soon
IDL-UCRio	Data Access	Download and read data	Coming soon
IDL-UCRio	Analysis Support	Plot riometer data	Coming soon