.. _IDL_Tomography:      https://github.com/CARS-UChicago/IDL_tomography
.. _IDL_Imaging:         https://github.com/CARS-UChicago/IDL_tomography
.. _IDL:                 https://www.nv5geospatialsoftware.com/Products/IDL
.. _tomo_display.zip:    https://cars.uchicago.edu/data/tomography/tomo_display/tomo_display.zip
.. _IDL_Register:        https://portal.nv5geospatialsoftware.com/auth/sign-up

Installation
============
The following instructions are for installation for sites who have an IDL license which will use the full version of IDL
and for those without a license which will use the IDL Virtual Machine.

This software can be installed on Linux and Windows.  
A computer with at least 32 GB of RAM, at least 8 cores, and a fast solid-state hard disk for the data
is recommended.

Install IDL
~~~~~~~~~~~
All sites must install IDL_, whether they will use the licensed version or the Virtual Machine. 
You should `register on the NV5 Geospatial site 
<https://portal.nv5geospatialsoftware.com/auth/sign-up>`__ 
and then you can download the software and follow the installation instructions. 
If you want to get started immediately with the IDL Virtual Machine you can 
`download IDL here <https://cars.uchicago.edu/data/idl>`__,
but you should also register with NV5.

Install IDL_Tomography
~~~~~~~~~~~~~~~~~~~~~~
- Create a directory that will contain the IDL tomography routines. This might be ``C:\\GSECARS_tomography`` on Windows
  or ``/home/myaccount/GSECARS_tomography`` on Linux.
- When using licensed version of IDL:

  - Clone the IDL_Tomography_ and IDL_Imaging_ repositories into that directory. 
    For example:
    ::
    
      >mkdir ~/GSECARS_tomography
      >cd ~/GSECARS_tomography
      >git clone https://github.com/CARS-UChicago/IDL_Tomography
      >git clone https://github.com/CARS-UChicago/IDL_Imaging  
  - Add the directory you created to the IDL_PATH. 

    - In the IDLDE use ``Window/Preferences/IDL/Paths`` to add that directory to the IDL Path, and check the box 
      to also search subdirectories.
    - Alternatively you can set the IDL_PATH environment variable to 
      e.g. ``<IDL_DEFAULT>:+/home/myaccount/GSECARS_tomography``.
      The + symbol means to search subdirectories.
- When using the IDL Virtual Machine

  - Create a subdirectory in ``GSECARS_tomography`` called ``IDL_tomography``.
  - Download tomo_display.zip_ to ``GSECARS_tomography\IDL_Tomography`` and unzip it there.
  - On Linux define the environment variable ``TOMO_RECON_SHARE`` to point to the complete path to ``tomoRecon_linux_x86_64.so``, 
    and the environment variable ``GRIDREC_SHARE`` to point to the complete path to ``GridrecIDL_linux-x86_64.so``.
    These are contained in the IDL_Tomography directory created above.
    Put commands like this in your bash startup script:
    ::

      export TOMO_RECON_SHARE=/home/myaccount/GSECARS_tomography/IDL_Tomography/tomoRecon_linux_x86_64.so
      export GRIDREC_SHARE=/home/myaccount/GSECARS_tomography/IDL_Tomography/GridrecIDL_linux_x86_64.so
  - On Windows define the environment variable ``TOMO_RECON_SHARE`` to point to the complete path to ``tomoRecon_Win32_x86_64.dll``,
    and the environment variable ``GRIDREC_SHARE`` to point to the complete path to ``GridrecIDL_Win32_x86_64.dll``.
    These are contained in the IDL_Tomography directory created above. 
    This can be done with ``Control Panel/System/Advanced/Environment Variables``.
- On Windows add the IDL_tomography folder to your PATH environment variable.
  This can be done with ``Control Panel/System/Advanced/Environment Variables``.
  This is necessary for IDL to find libfftw3f-3.dll.
- On Linux make sure the fftw-devel package is installed.  This is required for reconstruction.