Downloads and Installation: Difference between revisions

From SPEDAS Wiki
Jump to navigation Jump to search
No edit summary
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= *New* SPEDAS 2.00 beta 1 just released (May 2016) =
= *New* SPEDAS 2.00 released (June 2017) =


* [http://spedas.org/downloads/spedas_2_00_beta1.zip Download SPEDAS 2.00 beta 1]
The QA process for SPEDAS 2.00 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.


The next SPEDAS release, SPEDAS 2.00 beta 1, is now available. A final, fully QA-ed release will occur sometime in Fall 2016, but we have done enough testing to be confident that the beta release is stable and functional enough to be routinely used. This release includes several new features, including the ISEE 3D visualization tool, updated plugins for ERG, IUGONET, and BARREL, and a new plugin for working with MMS data.
If you have an [http://www.harrisgeospatial.com/ProductsandTechnology/Software/IDL.aspx IDL software] license, then you can download
and use either the SPEDAS 2.00 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 separetely install the IDL Virtual Machine (VM) and use the save file we provide, see below.  


This version contains the source code and can be installed in a similar way to a nightly build (see below).


= If you have an IDL license =
= If you have an IDL license =


If you have an [http://www.exelisvis.com/IntelliEarthSolutions/GeospatialProducts/IDL.aspx IDL software] license, then download the nightly build. Check with your system administrator on how to obtain and install IDL.  
== Download SPEDAS 2.00 (June 2017) ==


== Download the SPEDAS nightly build ==
If you have an IDL license, you can download the SPEDAS 2.00 release, which contains the full source code:


The nightly build contains the most recent source code:
* [http://spedas.org/downloads/spedas_2_00.zip SPEDAS 2.00, IDL source code (~33 MB)]


* [http://spedas.org/downloads/spdsw_latest.zip Download the latest SPEDAS nightly build]
Unzip the file you downloaded in a directory of your choice and create a new IDL project that includes this directory.  


Unzip the files you downloaded and create a new IDL project that includes these files. To start the SPEDAS GUI from the IDL command line, type: '''spd_gui'''
You may also need to separately download and install the latest CDF DLM from NASA and the latest Geopack DLM -- see below for details. 


== IDL Geopack DLM ==
To start the SPEDAS GUI from the IDL command line, type: '''spd_gui'''


To use the Tsyganenko Model extensions with the SPEDAS software, you need to download and install the Geopack DLM. We recommend using the 9.3 version.
== SPEDAS nightly build ==


* [http://ampere.jhuapl.edu/code/idl_geopack.html Download the IDL Geopack]
Alternatively, you can download the nightly build instead of the SPEDAS 2.00 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 2.00 release, above.


Installation instructions can be found in the download page, but basically you have to copy two files into the IDL bin directory: a .dlm file and either a .so file (Linux, Mac) or a .dll file (Windows).  
* [http://spedas.org/downloads/spdsw_latest.zip Download the latest SPEDAS nightly build]


You can check which version of Geopack DLM you have, by typing this at the IDL command prompt: '''help, 'geopack', /dlm'''
== IDL Geopack library ==


== IDL CDF library ==
To use the Tsyganenko Model extensions with the SPEDAS software, you need to download and install the Geopack DLM. We recommend using the 9.4 version.


We recommend downloading and installing the most recent version (3.6.1) of the CDF library from NASA:
* [http://ampere.jhuapl.edu/code/idl_geopack.html Download the Geopack Library]


* [http://cdf.gsfc.nasa.gov/html/sw_and_docs.html Download the CDF 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 CDF you have, by typing this at the IDL command prompt: '''help, 'cdf', /dlm'''
You can check which version of Geopack DLM you have, by typing this at the IDL command prompt: '''help, 'geopack', /dlm'''


== Older versions ==
The GEOPACK dlm files can also be downloaded here: [http://spedas.org/downloads/geopack_dlm.zip GEOPACK dlm files]


1. You can download the source code for the SPEDAS version 1.0 release that has undergone extensive Quality assurance (QA) testing:
== IDL CDF library ==


* [http://spedas.org/downloads/spedas_1_00.zip Download the SPEDAS 1.0 source code, August 2014]
We recommend downloading and installing the most recent version (3.6.4) of the CDF DLM for IDL from NASA:


2. For a list of previous nightly builds, see:
* [http://cdf.gsfc.nasa.gov/html/sw_and_docs.html Download the CDF Library]


* [http://themis.ssl.berkeley.edu/socware/bleeding_edge/?C=M;O=D The nightly builds download site]
Installation is similar to Geopack library instalation: 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 CDF you have, by typing this at the IDL command prompt: '''help, 'cdf', /dlm'''




Line 52: Line 61:
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:
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, or
# Download the SPEDAS executable (for Linux, MacOS, or Windows), or
# Download the SPEDAS save file.
# Download the SPEDAS save file (for Solaris or other operating systems).
 
These distributions were created in August 2014. A new version will be available later in 2016.


== Download the SPEDAS executable, Version 1.00, August 2014 ==
== Download SPEDAS 2.00 Executables (June 2017) ==


The executable is a zip file that contains everything you need to run the SPEDAS GUI:
For users without IDL licenses, you can use the SPEDAS 2.00 executable files for Linux, Windows, and MacOS, which
allow access to the Graphical User Interface capabilities of SPEDAS, with no additional
IDL license required. 


    IDL 8.3
* [http://spedas.org/downloads/spedas_2_win64_85_94.zip SPEDAS 2.00, Windows 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 9.4 (~50 MB)]
        * [http://spedas.org/downloads/spedas_10_win64_83_93b.zip Download the SPEDAS 1.0 Executable, Windows 64bit, IDL 8.3, Geopack 9.3 (52 MB)]
* [http://spedas.org/downloads/spedas_2_mac64_85_94.zip SPEDAS 2.00, MacOs 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 9.4 (~65 MB)]
        * [http://spedas.org/downloads/spedas_10_mac64_83_93b.zip Download the SPEDAS 1.0 Executable, MacOs 64bit, IDL 8.3, Geopack 9.3 (60 MB)]
* [http://spedas.org/downloads/spedas_2_linux64_85_94.zip SPEDAS 2.00, Linux 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 9.4 (~65 MB)]
        * [http://spedas.org/downloads/spedas_10_linux64_83_93b.zip Download the SPEDAS 1.0 Executable, Linux 64bit, IDL 8.3, Geopack 9.3 (70 MB)]
* [http://spedas.org/downloads/spedas_2_linux64_85_76.zip SPEDAS 2.00, Linux 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 7.6 (~65 MB) - built with Geopack 7.6 for CentOS (there are problems with Geopack 9.4 on CentOS)]
        * [http://spedas.org/downloads/spedas_10_linux64_83_76b.zip Download the SPEDAS 1.0 Executable, Linux 64bit, IDL 8.3, Geopack 7.6 (70 MB)]


    IDL 7.1
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.
        * [http://spedas.org/downloads/spedas_10_win64_71_93b.zip Download the SPEDAS 1.0 Executable, Windows 64bit, IDL 7.1, Geopack 9.3 (34 MB)]
        * [http://spedas.org/downloads/spedas_10_mac64_71_93b.zip Download the SPEDAS 1.0 Executable, MacOs 64bit, IDL 7.1, Geopack 9.3 (48 MB)]
        * [http://spedas.org/downloads/spedas_10_linux64_71_93b.zip Download the SPEDAS 1.0 Executable, Linux 64bit, IDL 7.1, Geopack 9.3 (53 MB)]
        * [http://spedas.org/downloads/spedas_10_linux64_71_76b.zip Download the SPEDAS 1.0 Executable, Linux 64bit, IDL 7.1, Geopack 7.6 (53 MB)]


== Download the SPEDAS save file, Version 1.00, August 2014 ==
== Download the SPEDAS save file, Version 2.00 (June 2017) ==


The SPEDAS save file requires the run-time [http://www.harrisgeospatial.com/Support/HelpArticles/TabId/185/ArtMID/800/ArticleID/12395/The-IDL-Virtual-Machine.aspx IDL Virtual Machine (VM)] which has to be downloaded for free from Exelis. There are limitations using the VM compared to the full IDL.  
The SPEDAS save file requires the run-time [http://www.harrisgeospatial.com/Support/SelfHelpTools/HelpArticles/HelpArticles-Detail/TabId/2718/ArtMID/10220/ArticleID/17309/The-IDL-Virtual-Machine.aspx 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.  


  * [http://spedas.org/downloads/spedas_10_savefile_83b.zip Download the SPEDAS 1.00 savefile (14 MB)]
  * [http://spedas.org/downloads/spedas_2_savefile_85.zip SPEDAS 2.00, IDL Savefile (17 MB)]


To run SPEDAS using the IDL virtual machine,  
To run SPEDAS using the IDL virtual machine,  
Line 88: Line 92:
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.
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 sav files can be found here:
Further information for loading IDL save files can be found here:
http://www.exelisvis.com/docs/StartingVirtualMachineApplication.html
http://harrisgeospatial.com/docs/StartingVirtualMachineApplication.html
 
 
= Troubleshooting and special considerations =
 
 


= Installation on a Mac =
== 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.  
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.8 or later, from here: http://www.xquartz.org/
* Download and install XQuartz 2.7.8 or later, from here: http://www.xquartz.org/
* Run the commands in the following page: [http://spedas.org/wiki/index.php?title=Known_Issues_macOS Known Issues in macOS]
* Download and install Java for OS X 2015-001, from here: https://support.apple.com/kb/DL1572
* 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.  
* 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/PH14369?locale=en_US   
** Instructions can be found here: https://support.apple.com/kb/PH14369?locale=en_US   
** Another way to override these warnings is described here: https://www.mcvsd.org/tips/powerteacher/osx_unidentified_developers.html
** 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) <code>spedas_v_2</code> directory from Downloads to your Desktop.
* Open a terminal and type the following:
<code>cd Desktop/spedas_v_2/spd_gui<br>
sudo xattr -r -d com.apple.quarantine spedas.app<br>
(enter your password)<br>
open ./spedas.app</code>
 
 
== 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 administration permissions, then we either have to log in as administrator, or perhaps contact the system administrator for the PC we are using.
 
[[File:Windows10_permissions.PNG||border|center|Request for administrator permission in Windows]]
 
== Resolving graphics problems on Windows 10 ==
 
If you experience any graphics problems on Windows 10, for example if the titles or labels are not visible in the plots because the font background color is not transparent any more, try the following:
 
* Go into the IDL Preferences (IDL Workbench: Window->Preferences->IDL->Graphics) and change Graphics to Software Rendering. If this fixes the problem then it is likely an issue with an outdated graphics driver for your system, try to update the graphics driver.
* If it doesn't fix the problem, try launching IDL in "Windows 7 Compatibility Mode" or something similar. Then try your plot over again.
 
 
= Running SPEDAS for the first time =
= 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.  
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.  


[[File:configuration_settings.png|200px|thumb|left|SPEDAS Configuration Settings]]
[[File:configuration_settings.png||border|center|SPEDAS Configuration Settings]]

Revision as of 18:39, 14 November 2017

*New* SPEDAS 2.00 released (June 2017)

The QA process for SPEDAS 2.00 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 2.00 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 separetely install the IDL Virtual Machine (VM) and use the save file we provide, see below.


If you have an IDL license

Download SPEDAS 2.00 (June 2017)

If you have an IDL license, you can download the SPEDAS 2.00 release, which contains the full source code:

* SPEDAS 2.00, IDL source code (~33 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 2.00 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 2.00 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 9.4 version.

* 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

The GEOPACK dlm files can also be downloaded here: GEOPACK dlm files

IDL CDF library

We recommend downloading and installing the most recent version (3.6.4) of the CDF DLM for IDL from NASA:

* Download the CDF Library

Installation is similar to Geopack library instalation: 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 CDF you have, by typing this at the IDL command prompt: help, 'cdf', /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:

  1. Download the SPEDAS executable (for Linux, MacOS, or Windows), or
  2. Download the SPEDAS save file (for Solaris or other operating systems).

Download SPEDAS 2.00 Executables (June 2017)

For users without IDL licenses, you can use the SPEDAS 2.00 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 2.00, Windows 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 9.4 (~50 MB)
* SPEDAS 2.00, MacOs 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 9.4 (~65 MB)
* SPEDAS 2.00, Linux 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 9.4 (~65 MB)
* SPEDAS 2.00, Linux 64bit executable with IDL 8.5.1, CDF 3.6.4, Geopack 7.6 (~65 MB) - built with Geopack 7.6 for CentOS (there are problems with Geopack 9.4 on CentOS)

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 2.00 (June 2017)

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 2.00, IDL Savefile (17 MB)

To run SPEDAS using the IDL virtual machine,

  1. start the IDL virtual machine executable
  2. click through the splash screen to get to the file selection dialog
  3. navigate to the SPEDAS installation
  4. 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.

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_2 directory from Downloads to your Desktop.
  • Open a terminal and type the following:

cd Desktop/spedas_v_2/spd_gui
sudo xattr -r -d com.apple.quarantine spedas.app
(enter your password)
open ./spedas.app


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 administration permissions, then we either have to log in as administrator, or perhaps contact the system administrator for the PC we are using.

Request for administrator permission in Windows
Request for administrator permission in Windows

Resolving graphics problems on Windows 10

If you experience any graphics problems on Windows 10, for example if the titles or labels are not visible in the plots because the font background color is not transparent any more, try the following:

  • Go into the IDL Preferences (IDL Workbench: Window->Preferences->IDL->Graphics) and change Graphics to Software Rendering. If this fixes the problem then it is likely an issue with an outdated graphics driver for your system, try to update the graphics driver.
  • If it doesn't fix the problem, try launching IDL in "Windows 7 Compatibility Mode" or something similar. Then try your plot over again.


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.

SPEDAS Configuration Settings
SPEDAS Configuration Settings