Commit 9ad8e7b5 authored by Tyler Wilson's avatar Tyler Wilson
Browse files

More updates to the Installation Guide.

parent 311fc8c2
Loading
Loading
Loading
Loading
+55 −26
Original line number Diff line number Diff line
@@ -24,9 +24,47 @@ you must <em>not</em> upgrade the ISIS Data Files!!!
-->
  <h2>Overview</h2>

  <p>
    This installation guide is for ISIS3 users interested in installing ISIS3 through conda, or compiling on their own systems using cmake.  
    If you are a developer, we refer you to our <a href="https://github.com/USGS-Astrogeology/ISIS3">GitHub repository.</a>
  </p>


  <h3>ISIS3 Installation With Conda</h3>
    <p>The instructions for this are still being worked out.</p>
    <ol>
      <li>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: 
      <a href="https://www.anaconda.com/download">Anaconda installer</a>, <a href="https://conda.io/miniconda.html">Miniconda installer</a></li>
      <li>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):</li>
        <pre>
          chmod +x Anaconda3-5.2.0-Linux-x86_64.sh
          ./Anaconda3-5.2.0-Linux-x86_64.sh          
        </pre>
        This will start the Anaconda installer which will guide you through the installation process.
      <li>After the installation has finished, open up a bash prompt in your terminal window.</li>
      <li>Create a new environment for your ISIS3 installation:
        <pre>
          #Add the following channels to the Anaconda installation
          conda config --add channels conda-forge
          conda config --add channels usgs-astrogeology

          #Create a new conda environment to install ISIS3 in
          conda create -n isis3alpha

          #Activate the environment
          source activate isis3alpha

          #Download the ISIS3 version with label alpha
          conda install -c usgs-astrogeology/label/alpha isis3

          #Set the ISISROOT variable
          export ISISROOT=$CONDA_PREFIX
          
          #Execute the ISIS3 startup script
          source $CONDA_PREFIX/scripts/isis3Startup.sh

        </pre>
      </li>
    </ol>
  <h3>Operating System Requirements</h3>
  <p>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
@@ -42,7 +80,7 @@ you must <em>not</em> upgrade the ISIS Data Files!!!
    </ul>


    <p>ISIS3 is also build and tested nightly on the following operating systems.</p>
    <p>ISIS3 is also built and tested nightly on the following operating systems.</p>

    <ul>
      <li>Ubuntu 14.04.3 LTS</li>
@@ -60,15 +98,12 @@ you must <em>not</em> upgrade the ISIS Data Files!!!
    <ul>
      <li>64-bit (x86) processors</li>
      <li>2 GB RAM</li>
      <li>2.5 GB for ISIS3 binaries</li>
      <li>2.5 GB of disk space for ISIS3 binaries</li>
      <li>10 GB to 510 GB disk space for ISIS3 data</li>
      <li>10 GB to many TB disk space for processing images</li>
      <li>A quality graphics card</li>
    </ul>
<p>Note: More processors, memory, disk storage, and an additional graphcis card
  (to support the use of two monitors at one time) may be useful depending on
  the complexity of your processing requirements.
</p>

    
<A NAME="RunningOnWindows"> </A>
<h3>Running ISIS3 on Windows 10</h3>
@@ -129,7 +164,6 @@ is a popular choice and may be downloaded below.
   the GitHub wiki page for the ISIS3 project:
  <ul>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Building-ISIS3-with-cmake#getting-started-with-github">Getting Started With GitHub</a></li>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Building-ISIS3-with-cmake#anaconda-and-isis3-dependencies">Installing Anaconda and satisfying ISIS3 Dependencies</a></li>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Building-ISIS3-with-cmake#building-isis3">Building ISIS3 With cmake</a></li>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Building-ISIS3-with-cmake#new-environmental-variable-meanings">New ISIS3 environmental variables and their meanings</a></li>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Building-ISIS3-with-cmake#custom-data-and-test-data-directories">Custom data and test directories</a></li>
@@ -140,26 +174,23 @@ is a popular choice and may be downloaded below.
  </ul>
</p>

<h3>Links for Developers</h3>

  <ul>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Developer-Checklists">ISIS3 Developer Checklist</a></li>
    <li><a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Managing-Custom-ISIS-Dependencies-(WIP)">Managing Custom ISIS3 Dependencies</a></li>
  </ul>

<h3>Full ISIS3 Data Download</h3>

<p>
    If you have the disk space and network speed, you may want to download all of the ISIS data areas which
    includes all missions supported by ISIS.   This takes over 130 GB of disk space!  If you only have a 10 Mbps
    network connection it will take nearly two days to download.  If you want to acquire only certain mission data
     <a href="#MissionSpecific">click here</a>.   To download all ISIS3 data files continue reading.
    Mission data is hosted on rsync servers and not through conda channels like the ISIS3 distribution.
    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 130 GB of disk space.
    If you want to acquire only certain mission data <a href="#MissionSpecific">click here</a>.
    To download all ISIS3 data files, continue reading.
</p>
<p>
    Remember to use the following command from the same directory you ran the previous rsync
    command. In the example it was "/work1/isis3".
    To download all ISIS3 data, enter the following commands at the command prompt:

</p>
      <pre>
      mkdir isis3data
      cd isis3data
      rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data .
      </pre>
<p>
@@ -234,8 +265,6 @@ is a popular choice and may be downloaded below.
        <pre>
        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/cassini data/
        </pre>


        <A NAME="ChandrayaanMission"> </A>
<p>
  Chandrayaan Mission (kernels can be excluded):
@@ -466,7 +495,7 @@ is a popular choice and may be downloaded below.

  <history>
    <change name="Kristin Berry" date="2018-08-28">Original Version</change>
    <change name ="Tyler Wilson" date="2018-09-26">Added links to installation instructions on the ISIS3 GitHub Wiki</change>
    <change name ="Tyler Wilson" date="2018-09-26">Updated version with coordinated input from the ASC Development Team</change>
  </history>


@@ -475,9 +504,9 @@ is a popular choice and may be downloaded below.
    <brief>Downloading and installing ISIS3</brief>
    <description>
      This document describes how to download/compile and install a
      binary version of ISIS3.
      binary version of ISIS3 as well
    </description>
    <author>Kristin Berry</author>
    <author>ASC Development Team</author>
    <date>2018-08-28</date>
  </bibliography>
</documentation>