From b5fa37653610c537fecd018f8862e040e7c472aa Mon Sep 17 00:00:00 2001 From: Jesse Mapel Date: Tue, 19 Mar 2019 09:32:37 -0700 Subject: [PATCH] Cleaned up data area wording in install guide (#3170) --- .../documents/InstallGuide/InstallGuide.xml | 550 +++++++++--------- 1 file changed, 285 insertions(+), 265 deletions(-) diff --git a/isis/src/docsys/documents/InstallGuide/InstallGuide.xml b/isis/src/docsys/documents/InstallGuide/InstallGuide.xml index 32b7056fb5..5c3123886e 100644 --- a/isis/src/docsys/documents/InstallGuide/InstallGuide.xml +++ b/isis/src/docsys/documents/InstallGuide/InstallGuide.xml @@ -95,7 +95,8 @@ you must not upgrade the ISIS Data Files!!! python $CONDA_PREFIX/scripts/isis3VarInit.py --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. + 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, @@ -188,313 +189,332 @@ is a popular choice and may be downloaded below.
  • PuTTY - an SSH and telnet client for the Windows platform.
    • -

    Mission Requirements

    -

    ISIS3 supports many planetary missions; in fact, over 40 different instruments including some - flown as early as the 1960s. Ancillary data are required to process images from these instruments. For example, translation - definition files to help convert from PDS format to ISIS cubes, dark current and flat file images for radiometric - calibration, and large quantities of SPICE files (spacecraft pointing and position) for map projecting images. - If you plan to work with data from all missions, then the download will require about 180 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 which can reduce the download size to 10 GB. When downloading ISIS, you will have the option of - choosing which mission data to acquire as well as if you only want the translation and calibration files and not - SPICE files. -

    + +

    The ISIS3 Data Area

    -

    DTM Requirements

    -

    The strength of ISIS3 lies in its capabilities for planetary cartography. - The image orthorectification process is improved if a digital - terrain model (DTM) is used. The DTMs can be quite large and take some time to download. They exist for - many planetary bodies (e.g., the Moon, Mars, etc.). Therefore, there are options for selecting which DTMs to download - if you are only working with a particular target body. +

    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 Download

    +

    Full ISIS3 Data Area Download

    -

    - 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 click here. - To download all ISIS3 data files, continue reading. -

    -

    - To download all ISIS3 data (approximately 180 GB), enter the following commands at the command prompt: +

    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 .
+      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 mission - data areas. -

    +

    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. -

    -
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/base data/
-
    + +

    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 data areas. One way you can save time and space is to not download the SPICE data - for the mission you need. If you chose 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. -

    +

    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 new service, without having to download all the SPICE data, add the - following argument to the mission-specific rsync command: -

    -
    -            --exclude='kernels'
-
    -

    - For example: rsync -azv --exclude='kernels' --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/cassini data/ -

    - - - 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): -

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

    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. - -

    - Cassini Mission (kernels can be excluded): -

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

    - Chandrayaan Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/chandrayaan1 data/
-
    + 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: +

    - -

    - Clementine Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/clementine1 data/
-
    + 
    +      --exclude='kernels'
+
    +

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

    - -

    - Dawn Mission (kernels can be excluded): -

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

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

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

    - Galileo Mission (kernels can be excluded): -

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

    - Hayabusa Mission (kernels can be excluded): -

    - - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/hayabusa data/
-        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/hayabusa2 data/
-
    + 
    +      cd $ISIS3DATA
+      rsync -azv --exclude='kernels' --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/cassini .
+
    -

    - Juno Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/juno data/
-
    + + 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. + - -

    - Kaguya Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/kaguya data/
-
    + +

    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 .
+
    - -

    - Lunar Orbiter Mission (kernels can be excluded): -

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

    - Lunar Reconnaissance Orbiter Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/lro data/
-
    + +

    Cassini Mission (kernels can be excluded): +

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

    - Mars Exploration Rover Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mer data/
-
    - + +

    Chandrayaan Mission (kernels can be excluded): +

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

    - Mariner10 Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mariner10 data/
-
    + +

    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 .
+
    -

    - Messenger Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/messenger data/
-
    + +

    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 .
+
    -

    - Mars Express Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mex data/
-
    + +

    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 .
+
    -

    - Mars Global Surveyor Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mgs data/
-
    + +

    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 Reconnaissance Orbiter Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/mro data/
-
    + +

    Mars Exploration Rover Mission (kernels can be excluded): +

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

    - Mars Odyssey Mission (kernels can be excluded): -

    - 
    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/odyssey data/
-
    + +

    Mariner10 Mission (kernels can be excluded): +

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

    - Near Mission (kernels can be excluded): -

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

    - New Horizons Mission (kernels can be excluded): -

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

    - Odyssey Mission (kernels can be excluded): -

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

    - Rolo Mission (kernels can be excluded): -

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

    - Rosetta Mission (kernels can be excluded): -

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

    - Smart1 Mission (kernels can be excluded): -

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

    - Viking Mission (kernels can be excluded): -

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

    - Voyager Mission (kernels can be excluded): -

    - + +

    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): + 

    -        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/voyager1 data/
-        rsync -azv --delete --partial isisdist.astrogeology.usgs.gov::isis3data/data/voyager2 data/
+        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?

    -- GitLab