Downloads and Installation
*New* SPEDAS 4.0 released (August 2020)
The QA process for SPEDAS 4.0 has now been completed, and this version of the software is now released for general use for users who have paid for IDL licenses. This release includes improved support for HTTPS downloads, updated plugin support for the ERG, IUGONET, THEMIS, and MMS missions, and many bug fixes and performance improvements.
If you have an IDL software license, then you can download and use either the SPEDAS 4.0 release or the untested the nightly build. Check with your system administrator on how to obtain and install IDL.
If you don't have an IDL license, then you have two choices: you can either use the self-contained executables we provide, or you can separately install the IDL Virtual Machine (VM) and use the save file we provide, see below.
Release notes for SPEDAS 4.0 are available here.
If you have an IDL license
Download SPEDAS 4.0 (August 2020)
If you have an IDL license, you can download the SPEDAS 4.0 release, which contains the full source code:
* SPEDAS 4.0, IDL source code (~50 MB)
Unzip the file you downloaded in a directory of your choice and create a new IDL project that includes this directory.
You may also need to separately download and install the latest CDF DLM from NASA and the latest Geopack DLM -- see below for details.
To start the SPEDAS GUI from the IDL command line, type: spd_gui
SPEDAS nightly build
Alternatively, you can download the nightly build instead of the SPEDAS 4.0 release. This is build every day and it contains the most recent source code, but it is untested and you may encounter bugs and unresolved problems. It can be installed the same way as the SPEDAS 4.0 release, above.
* Download the latest SPEDAS nightly build
IDL Geopack library
To use the Tsyganenko Model extensions with the SPEDAS software, you need to download and install the Geopack DLM. We recommend using the latest version (Geopack 10.6).
* Download the Geopack Library
Installation instructions can be found in the download page, but basically you have to copy two files into the IDL bin directory, 1) a .dlm file and 2) either a .so file (Linux, Mac) or a .dll file (Windows).
You can check which version of Geopack DLM you have, by typing this at the IDL command prompt: help, 'geopack', /dlm
IDL CDF library
We recommend downloading and installing the most recent version (3.8.0) of the CDF DLM for IDL from NASA:
* Download the CDF Library
The suggested installation method is to run the install script for your operating system (e.g., install_idl_win.bat for Windows, install_idl_win.sh for macOS/Linux). Running these scripts will download the latest version of the library and install them to your chosen IDL installation folder.
You can check which version of CDF you have, by typing this at the IDL command prompt: help, 'cdf', /dlm
IDL SPICE library
Some functions (for example, cspice_str2et) require the NASA SPICE library. This library can be downloaded directly from NASA:
* Download the NASA IDL SPICE library
The installation is similar to any other dlm library. On windows, you have to copy two files (icy.dlm, icy.dll) into the bin.x86_64 directory of the IDL installation folder.
For more information, see:
* Information on the NASA IDL SPICE library
IDL DAS2 Library
Das2dlm is an IDL DLM that provides bindings for the das2C library. It is compatible with IDL 8.0 or newer.
* Zip file for DAS2 dlm
For more information, see:
* Github DAS2 project
You can check which version of Geopack DLM you have, by typing this at the IDL command prompt: help, 'geopack', /dlm
If you don't have an IDL license
SPEDAS is free software but if you do not have an IDL license, then you cannot use the IDL command line, and hence neither the SPEDAS command line tools. You can still use the SPEDAS GUI, and you have two options:
- Download the SPEDAS executable (for Linux, MacOS, or Windows), or
- Download the SPEDAS save file (for Solaris or other operating systems).
Download the SPEDAS executables, Version 4.0 (August 2020)
For users without IDL licenses, you can use the SPEDAS 4.0 executable files for Linux, Windows, and MacOS, which allow access to the Graphical User Interface capabilities of SPEDAS, with no additional IDL license required.
* SPEDAS 4.0, Windows 64bit executable with IDL 8.5.1, CDF 3.7.1, Geopack 10.6 (~55 MB) * SPEDAS 4.0, MacOs 64bit executable with IDL 8.5.1, CDF 3.7.1, Geopack 10.6 (~70 MB) * SPEDAS 4.0, Linux 64bit executable with IDL 8.5.1, CDF 3.7.1, Geopack 10.6 (~70 MB) * SPEDAS 4.0, Linux 64bit executable with IDL 8.5.1, CDF 3.7.1, Geopack 7.6 (~70 MB) - includes Geopack 7.6, for older Linux machines that may not work with Geopack 10.6
This release contains everything you need, including the IDL VM, the Geopack DLM and the CDF DLM. You just have to unzip the file and run the executable and the SPEDAS GUI will appear.
Download the SPEDAS save file, Version 4.0 (August 2020)
The SPEDAS save file requires the run-time IDL Virtual Machine (VM) which has to be downloaded for free from Harris Corporation. There are limitations using the VM compared to the full IDL.
* SPEDAS 4.0, IDL Savefile (20 MB)
To run SPEDAS using the IDL virtual machine,
- start the IDL virtual machine executable
- click through the splash screen to get to the file selection dialog
- navigate to the SPEDAS installation
- go into the thm_gui_new directory and click on thm_gui.sav
This should bring up the main screen of the SPEDAS GUI. From this point you should be able to load, plot, and analyze data through the GUI.
Further information for loading IDL save files can be found here: http://harrisgeospatial.com/docs/StartingVirtualMachineApplication.html
Troubleshooting and special considerations
Installation on a Mac - XQuartz and Java
Newer Mac OS X versions do not include the X11 libraries. XQuartz (X11) has to be downloaded and installed, or IDL will not work. Also, you may need to install an older Java version for IDL to work properly.
- Download and install XQuartz 2.7.11 or later, from here: http://www.xquartz.org/
- Run the commands in the following page: Known Issues in macOS
- Download and install Java for OS X 2015-001, from here: https://support.apple.com/kb/DL1572
- To be able to install the above software or the executable SPEDAS distribution, you may have to allow installation of applications from unidentified developers.
- Instructions can be found here: https://support.apple.com/kb/PH25088?locale=en_US
- Another way to override these warnings is described here: https://www.mcvsd.org/tips/powerteacher/osx_unidentified_developers.html
MacOS Sierra or later
If you want to run the executable SPEDAS file on macOS 10.12 Sierra or later, after downloading the zip file you have to do the following:
- Open the Finder and move the (automatically uncompressed)
spedas_v_2directory from Downloads to your Desktop. - Open a terminal and type the following:
cd Desktop/spedas_v_4_0/spd_gui
sudo xattr -r -d com.apple.quarantine spedas.app
(enter your password)
open ./spedas.app
Known issues on macOS
For known issues on macOS and solutions, see Known issues - macOS
Installation on Windows
When we update Geopack DLM or the CDF library on Windows, we have to copy files in the "Program Files\Exelis\IDL84\bin\bin.x86_64" folder (this folder depends on IDL version, for example it could be C:\Program Files\Harris\IDL86\bin\bin.x86_64). When we try to copy files into folders that reside inside Program Files, Windows 10 (and probably older Windows versions, too) will ask for administrator permission as you can see in the following image. In that case, we just have to click the button "Continue". If we are logged in as a user without administrator permissions, then we either have to log in as administrator, or perhaps contact the system administrator for the PC we are using.
Known issues on Windows
For known issues on Windows and solutions, see Known issues - MS Windows
Known issues on Linux
New editions of Linux may not be able to run IDL because the library libxp6 is missing. In that case, you have to download the missing library and install it manually:
1. Download the 64-bit edition of libxp6 from here:
https://www.ubuntuupdates.org/package/core/precise/main/updates/libxp6
2. Install the file you downloaded using:
sudo dpkg -i ./libxp6_1.0.1-2ubuntu0.12.04.2_amd64.deb
sudo apt-get install -f
Running SPEDAS for the first time
The first time you run SPEDAS, please make sure that all the directories where data files will be downloaded exist and have the proper permissions (they should be writable). To do this, launch the SPEDAS GUI (using the command spd_gui) and in the File menu choose Configuration Settings. Make sure that all the directories for SPEDAS and any other missions you use exist and are writable. If you make any changes, click "Save to File" to have the new settings saved.
Running SPEDAS from Linux or Mac OS terminal
For the command line version of IDL, installation consists of setting up the IDL_PATH environment variable.
Simply set the IDL_PATH environment to search all subdirectories of the SPEDAS directory.
for csh or tcsh, place the following in your .cshrc file: setenv IDL_PATH ’<IDL_DEFAULT>:+/path/to/spedas’
for bash or sh, place the following in your .bashrc (Linux, Solaris) or .bash_profile (Mac) file: export IDL_PATH=’<IDL_DEFAULT>:+/path/to/spedas’
It is important to replace the text "/path/to/spedas" with the directory on your system that contains the SPEDAS files. This might be something like: "~/spedas_4_0/idl/" Also, don't forget to include the “+” before the directory. Without this, it will not work.
Additional information can be found in THEMIS Use's Guide pdf file.