diff --git a/isis/scripts/isis3VarInit.py b/isis/scripts/isis3VarInit.py index ec6431691f..122d23f0ae 100755 --- a/isis/scripts/isis3VarInit.py +++ b/isis/scripts/isis3VarInit.py @@ -1,14 +1,24 @@ #!/usr/bin/env python + import argparse import os import sys -#Author: Tyler Wilson -#Date : 2018-10-05 -#Description: This script sets ISISROOT/ISIS3DATA/ISIS3TESTDATA for the user and is executed -#within the conda environment created for the ISIS3 installation. -#The data directory and test directory are optional command line arguments. If the user chooses -#not to set them, they will both be placed created on the same level as the $ISISROOT directory -#within the conda environment. + +########################################################################################################## +# Author: Tyler Wilson +# Date : 2018-10-05 +# Description: This script sets ISISROOT/ISIS3DATA/ISIS3TESTDATA for the user and is executed +# within the conda environment created for the ISIS3 installation. +# The data directory and test directory are optional command line arguments. If the user chooses +# not to set them, they will both be placed created on the same level as the $ISISROOT directory +# within the conda environment. +# History: +# Author: Tyler Wilson +# Date: 2018-11-01 +# Description: Removed a pair of lines which were causing output errors on Mac OS X and were not +# required anyway. +# +########################################################################################################## parser = argparse.ArgumentParser(description='Usage: ./isis3VarInit --data_dir --test_dir "+isisroot+"/etc/conda/activate.d/env_vars.sh") -os.popen("echo -n '' >"+isisroot+"/etc/conda/deactivate.d/env_vars.sh") os.popen('touch '+isisroot+'/etc/conda/activate.d/env_vars.sh') os.popen('touch '+isisroot+'/etc/conda/activate.d/env_vars.sh') diff --git a/isis/src/docsys/documents/InstallGuide/InstallGuide.xml b/isis/src/docsys/documents/InstallGuide/InstallGuide.xml index f473584fd5..e7b56bfdb4 100644 --- a/isis/src/docsys/documents/InstallGuide/InstallGuide.xml +++ b/isis/src/docsys/documents/InstallGuide/InstallGuide.xml @@ -34,43 +34,74 @@ you must not upgrade the ISIS Data Files!!!
  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. -
  3. 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.
  4. +
  5. 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.
  6. -          chmod +x Anaconda3-5.2.0-Linux-x86_64.sh
    -          ./Anaconda3-5.2.0-Linux-x86_64.sh          
    +          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.
  7. After the installation has finished, open up a bash prompt in your terminal window.
  8. -
  9. Create a new environment for your ISIS3 installation: +
  10. 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.
  11. +
  12. Again from within a terminal window, create a new environment for your ISIS3 installation:
    -          #Add the following channels to the Anaconda installation
    -          conda config --add channels conda-forge, usgs-astrogeology
    -          
    +          #Add the following channels to the Anaconda installation
    +          conda config --add channels conda-forge
    +          conda config --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 --add channels usgs-astrogeology
    +
     
    -          #Create a new conda environment to install ISIS3 in
    -          conda create -n isis3
    +          #Create a new conda environment to install ISIS3 in.
    +          conda create -n isis3
     
    -          #Activate the environment
    -          source activate isis3
    +          #Activate the environment
    +          source activate isis3
     
    -          #Download the ISIS3 version
    -          conda install -c usgs-astrogeology isis3
    +          #Download the ISIS3 version
    +          conda install -c usgs-astrogeology isis3
               
    -          #Execute the ISIS3 variable initialization script with default arguments.
    -          #This script prepares default values for:  $ISISROOT/$ISIS3DATA/$ISIS3TESTDATA
    +          #Execute the ISIS3 variable initialization script with default arguments.
    +          #This script prepares default values for:  $ISISROOT/$ISIS3DATA/$ISIS3TESTDATA
     
    -          python $CONDA_PREFIX/scripts/isis3VarInit.py
    +          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:
     
    -         ./$CONDA_PREFIX/scripts/isis3VarInit --data-dir=[path to data directory]  --test-dir=[path to test data directory]
    +         ./$CONDA_PREFIX/scripts/isis3VarInit --data-dir=[path to data directory]  --test-dir=[path to test data directory]
     
    +         
    +         Directions for running rsync to download ISIS3 data can be found here.
    +
    +
    +          #Run the source activate command a second time to process the changes:
    +
    +          source activate isis3
    +
    +          To avoid having to do this every time you open a new terminal window, we suggest adding the following lines to the end of your .bashrc file 
    +          (if running a variant of Linux) to ensure that conda is in your PATH variable.  If you are running Mac OS X, these lines would be appended
    +          to the end of your .bash_profile file:
    +
    +          
    +          source activate isis3
    +          python $CONDA_PREFIX/scripts/isis3VarInit.py
    +          source activate isis3
     
    -          #Run the source activate command a second time to process the changes:
     
    -          source activate isis3
     
             
  13. @@ -173,7 +204,7 @@ is a popular choice and may be downloaded below.

    - +

    Full ISIS3 Data Download

    @@ -494,6 +525,7 @@ is a popular choice and may be downloaded below. Original Version Updated version to incorporate installation through Conda + Updated version after feedback was received from outside users.