Home
About ISIS
Support
Download

ISIS 3

Documentation
Tutorials
Technical Documents

ISIS 2

Documentation
Tutorials
Technical Documents
USGS

ISIS 3 Documentation


Installing ISIS

Downloading and installing ISIS3

Home

Overview

This installation guide is for ISIS3 users interested in installing ISIS3 (3.6.0)+ through conda. If you are a developer, we refer you to our GitHub repository.

ISIS3 Installation With Conda

  1. Download either the Anaconda or Miniconda installation script for your OS platform. Anaconda is a much larger distribtion of packages supporting scientific python, while Miniconda is a minimal installation and not as large: Anaconda installer, Miniconda installer
  2. If you are running on some variant of Linux, open a terminal window in the directory where you downloaded the script, and run the following commands. In this example, we chose to do a full install of Anaconda, and our OS is Linux-based. Your file name may be different depending on your environment.
              chmod +x Anaconda3-5.2.0-Linux-x86_64.sh
              ./Anaconda3-5.2.0-Linux-x86_64.sh
            
    This will start the Anaconda installer which will guide you through the installation process.
  3. If you are running Mac OS X, a pkg file (which looks similar to Anaconda3-5.3.0-MacOSX-x86_64.pkg) will be downloaded. Double-click on the file to start the installation process.
  4. After the installation has finished, open up a bash prompt in your terminal window.
  5. Next setup your Anaconda environment for ISIS3. In the bash prompt, run the following commands:
              #Create a new conda environment to install ISIS3 in
              conda create -n isis3 python=3.6
    
              #Activate the environment
              #Depending on your OS, you may need to use conda activate isis3 instead
              source activate isis3
    
              #Add the following channels to the environment
              conda config --env --add channels conda-forge
              conda config --env --add channels usgs-astrogeology
    
              #Verify you have the correct channels:
              conda config --show channels
    
              #You should see:
    
              channels:
                 - usgs-astrogeology
                 - conda-forge
                 - defaults
    
              #The order is important.  If conda-forge is before usgs-astrogeology, you will need to run:
    
              conda config --env --add channels usgs-astrogeology
            
  6. The environment is now ready to download ISIS3 and its dependencies:
              conda install -c usgs-astrogeology isis3
            
  7. Finally, setup the environment variables:
              #Execute the ISIS3 variable initialization script with default arguments.
              #This script prepares default values for:  $ISISROOT/$ISIS3DATA/$ISIS3TESTDATA
    
              python $CONDA_PREFIX/scripts/isis3VarInit.py
            
    Executing this script with no arguments will result in $ISIS3DATA=$CONDA_PREFIX/data, and $ISIS3TESTDATA=$CONDA_PREFIX/testdata. The user can specify different directories for both of these optional values:
              python $CONDA_PREFIX/scripts/isis3VarInit.py --data-dir=[path to data directory]  --test-dir=[path to test data directory]
            
    More information about the ISIS3DATA environment variable and the ISIS3 Data Area can be found here. Now everytime the isis3 environment is activated, $ISISROOT, $ISIS3DATA, and $ISIS3TESTDATA will be set to the values passed to isis3VarInit.py. This does not happen retroactively, re-activate the isis3 envionment with the following command:
              #Depending on your OS, you may need to use conda activate isis3 instead
              source activate isis3
            

Operating System Requirements

ISIS3 runs on many UNIX variants. ISIS does not run natively on MS Windows, although it has been successfully run on Windows 10 using the Windows Subsystem for Linux (WSL). Instructions for doing this can be found here. The UNIX variants ISIS3 has been successfully built on are:

ISIS3 may be run on other Linux or macOS operating systems then those listed above, but it has not been tested and is not supported.

Hardware Requirements

Here are the minimum hardware requirements

To build and compile ISIS3 requires following the instructions listed below, which are given on the GitHub wiki page for the ISIS3 project:

Running ISIS3 on Windows 10

While the ISIS3 development team has not examined these instructions for correctness or completeness, they appear to have successfully worked for a number of ISIS3 users within the USGS who run Windows. Thanks for these instructions are directed towards Trent Hare who maintains an excellent and thoughtful blog on Planetary GIS Science.

Setting Up X11 forwarding on Windows with Putty and Xming

Some ISIS3 users prefer to run ISIS3 in Windows, but SSH into a computer that is running ISIS3 and has enabled X11 forwarding. This requires the installation of an X server on Windows. Below are links to two popular choices in Astrogeology.

Additionally, a Windows SSH client is required to create an SSH connection. PuTTY is a popular choice and may be downloaded below.

The ISIS3 Data Area

Ancillary Data

Many ISIS3 applications require ancillary data. For example, ingestion applications require translation tables to convert labels, calibration applications require flat files to do flat field correct, and map projection applications require DTMs to accurately compute intersections. Due to its size, this data is stored in a separate directory called the ISIS3 Data Area. Any location can be used for the ISIS3 Data Area, the software simply requires that the ISIS3DATA environment variable is set to its location.

Structure of the ISIS3 Data Area

Under the root directory of the ISIS3 Data Area pointed to by the ISIS3DATA environment variable are a variety of sub-directories. Each mission supported by ISIS3 has a sub-directory that contains mission specific processing data such as flat files and mission specific SPICE. There are also data areas used by more generic applications. These sub-directories contain everything from templates to test data.

Size of the ISIS3 Data Area

If you plan to work with data from all missions, then the download will require about 520 GB for all the ancillary data. However, most of this volume is taken up by SPICE files. We have a SPICE Web service that can be used in lieu of downloading all of the SPICE files. This reduces the total download size to about 10 GB.

Full ISIS3 Data Area Download

The ISIS3 Data Area is hosted on rsync servers and not through conda channels like the ISIS3 binaries. This requires using the rsync command from within a terminal window within your Unix distribution, or from within WSL if running Windows 10. Downloading all mission data requires over 520 GB of disk space. If you want to acquire only certain mission data click here. To download all ISIS3 data files, continue reading.

To download all ISIS3 data, enter the following commands in the location where you want to install the ISIS3 Data Area:

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/ .
      

Note: The above command downloads all ISIS data including the required base data area and all of the optional missiondata areas.

Partial Download of ISIS3 Base Data (Required)

The base data area is separate from the source code. This data area is crucial to ISIS3 and must be downloaded.

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/base .
      

Partial Download of Mission Specific Data

There are many missions supported by ISIS. If you are only working with a few missions then you should download only those specific sub-directories of the ISIS3 Data Area. One way you can save time and space is to not download the SPICE data for the mission you need. If you choose to not download the SPICE data, read the next section about the SPICE Web Service that provides instructions for excluding the SPICE kernels. Otherwise jump to the mission specific sections.

ISIS SPICE Web Service

ISIS can now use a service to retrieve the SPICE data for all instruments ISIS supports via the internet. To use this service instead of your local SPICE data, click the WEB check box in the spiceinit program GUI or type spiceinit web=yes at the command line. Using the ISIS SPICE Web Service will significantly reduce the size of the downloads from our data area. If you want to use this service, without having to download all the SPICE data, add the following argument to the mission-specific rsync command:

      --exclude='kernels'
      

For example, the following command will download the Cassini mission data except for SPICE kernels:

      cd $ISIS3DATA
      rsync -azv --exclude='kernels' --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/cassini .
      
WARNING: Some instruments require mission data to be present for calibration, which may not be supported by the SPICE Web Server exclusively, and some programs that are designed to run an image from ingestion through the mapping phase do not have an option to use the SPICE Web Service. For information specific to an instrument, see the documentation for radiometric callobration programs.

Apollo Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/apollo15 .
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/apollo16 .
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/apollo17 .
      

Cassini Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/cassini .
      

Chandrayaan Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/chandrayaan1 .
      

Clementine Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/clementine1 .
      

Dawn Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/dawn .
      

ExoMars Trace Gas Orbiter Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/tgo .
      

Galileo Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/galileo .
      

Hayabusa Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/hayabusa .
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/hayabusa2 .
      

Juno Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/juno .
      

Kaguya Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/kaguya .
      

Lunar Orbiter Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/lo .
      

Lunar Reconnaissance Orbiter Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/lro .
      

Mars Exploration Rover Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mer .
      

Mariner10 Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mariner10 .
      

Messenger Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/messenger .
      

Mars Express Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mex .
      

Mars Global Surveyor Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mgs .
      

Mars Reconnaissance Orbiter Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mro .
      

Mars Odyssey Mission (kernels can be excluded):

        cd $ISIS3DATA
        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/odyssey .
        

Near Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/near .
      

New Horizons Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/newhorizons .
      

Odyssey Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/odyssey .
      

Rolo Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/rolo .
      

Rosetta Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/rosetta .
      

Smart1 Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/smart1 .
      

Viking Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/viking1 .
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/viking2 .
      

Voyager Mission (kernels can be excluded):

      cd $ISIS3DATA
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/voyager1 .
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/voyager2 .
      

Installing older versions of ISIS

How do I install ISIS2?

If you are looking for ISIS2, please refer to the ISIS 2 Installation Guide for instructions on downloading and installing ISIS 2.

How do I install ISIS3.5.2 or earlier?

If you are looking for a version of ISIS3 prior to 3.6.0, please refer to the Legacy ISIS3 Installation Guide for instructions on downloading and installing ISIS3, versions prior to 3.6.0.


Document History

Kristin Berry2018-08-28Original Version
Tyler Wilson along with the ASC Development Team2018-09-26Updated version to incorporate installation through Conda
Tyler Wilson2018-10-01Updated version after feedback was received from outside users.