IDL-AuroraX is an IDL library for interacting with AuroraX, a project working to be the world's first and foremost data platform for auroral science. The primary objective of AuroraX is to enable mining and exploration of existing and future auroral data, enabling key science and enhancing the benefits of the world's investment in auroral instrumentation. This will be accomplished with the development of key systems/standards for uniform metadata generation and search, image content analysis, interfaces to leading international tools, and a community involvement that includes more than 80% of the world's data providers.
IDL-AuroraX officially supports IDL 8.8.3+.
Some links to help:
For usage details, please visit the AuroraX documentation website, and the basic examples section.
Installation can be done two different ways: 1) using the ipm
command (recommended), or 2) manually adding the files to your IDL path.
You can view all previous releases here.
Since IDL 8.7.1, there exists an IDL package manager called ipm. We can use this to install the idl-aurorax library with a single command. This is the recommended way of installing the IDL-AuroraX library.
-
From the IDL command prompt, run the following:
IDL> ipm,/install,'https://data.aurorax.space/data/software/idl-aurorax/latest.zip'
-
Add the following to your startup file, or run the command manually using the IDL command prompt:
[ open your startup.pro file and put the following in it ] .run aurorax_startup
-
[OPTIONAL] If you added the above line to your startup file, you must reset your IDL session. Do this by either clicking the Reset button in the IDL editor or by typing
.reset
into the IDL command prompt.
For further information, you can view what packages are installed using ipm,/list
. You can also view the package details using ipm,/query,'idl-aurorax'
.
Alternatively, you can install the idl-aurorax library manually by downloading the ZIP file and extracting it into, or adding it to, your IDL path.
-
Download the latest release here
-
Extract the zip file into your IDL path (or add it as a directory to your IDL path)
-
Add the following to your startup file (or run the command manually using the IDL command prompt).
[ open your startup.pro file and put the following in it ] .run aurorax_startup
-
[OPTIONAL] If you added the above line to your startup file, you must reset your IDL session. Do this by either clicking the Reset button in the IDL editor or by typing
.reset
into the IDL command prompt.
If you used ipm
to install idl-aurorax, you can update it using:
IDL> ipm,/update,'idl-aurorax'
IDL> .reset
If you installed the code manually, you can download the latest Zip file and overwrite the existing files. Then, add any new .run
commands to your startup file as defined in the "Installation" section above.
Note that for the AuroraX Search Engine capabilities, this IDL library only provides functionality to retrieve data. It does not have functions for uploading or editing data in the AuroraX search engine. Please use the Python library, PyAuroraX for this functionality.