Documentation

Each of our software libraries has its own API reference documentation, covering every available class, function, and submodule. Use these references to look up the details of specific methods and parameters as you work with the libraries.

Optical Instruments

Libraries for working with all-sky imager and spectrograph data (THEMIS ASI, TREx RGB, TREx NIR, TREx Blueline, TREx Spectrograph, REGO, SMILE ASI, and more):

• PyAuroraX (Python)
  • API Reference
• IDL-AuroraX (IDL)
  • API Reference

Riometer Instruments

Libraries for working with single frequency riometer and hyper-spectral riometer data:

• PyUCRio (Python)
  • API Reference
• IDL-UCRio (IDL)
  • GitHub Repository - a dedicated API reference is not yet available; see the examples in the repository

For more on each library, including installation instructions and example code, see the Software overview page.