SOFTWARE INSTALLATION

Software Installation Instructions

Although there are some differences on Windows and UNIX platforms, the basic procedure is as follows:

  1. Install IDL (Version 6.0 or later)
  2. Install SSW (including at least the hessi, spex, and xray branches)
  3. Customize the setup for RHESSI analysis
  4. Configure automatic updates

The hessi SSW directory contains two versions of the RHESSI software. This is accomplished by either including (the default) or removing the hessi/atest directory which contains modified versions of routines elsewhere in the hessi tree.

  • Development version - less stable but always up-to-date (default, recommended)
  • Release version - more stable and consistent, but does not contain recent features and bug fixes.  To use the release version, remove the atest directory from your IDL path by typing hsi_remove_atest after starting IDL (but before running any RHESSI programs).

If you experience a problem during installation, you might find the solution in the RHESSI Data Analysis Software FAQ.

The SSW installation instructions include instructions for both Windows and Unix installations.  They are also summarized here:

Windows-specific instructions

  • Installation
    • Use the SSW installation form to select instruments (at least hessi, spex, xray), generate, and download an installation script.
    • Transfer your customized ZIP installation package to a local disk (a hyper-link to the ZIP file will show up after you submit your installation FORM)
    • UnZip (Extract All) the ZIP file into an empty folder, using WinZip or equivalent Windows application.
    • Execute (via click) the setup.bat (setup.bat is one of the extracted files)
  • Configuration
    • Configure your SSWIDL by editing $SSW/site/setup/sswidl.bat to include the SSW instruments of your choice and set a personal startup file (optional).
    • Copy the RHESSI and any other instrument startup files you want to modify from the instrument setup branch to $SSW/site/setup and edit. For example, copy $SSW/hessi/setup/setup.hessi_env to $SSW/site/setup, and edit as instructed in the file. The importance of this step is that it defines the HSI_DATA_ARCHIVE and HSI_DATA_USER environment variables which are needed to tell the RHESSI software where to find the data files. (Click here for instructions on accessing the data files.)
    • Click sswidl.bat in your $SSW/site/setup directory to start IDL.
  • Updating
    • Click $SSW/site/setup/daily.bat to update SSW any time.
    • Or run ssw_upgrade anytime from within SSWIDL via ssw_upgrade, [/inst1, /inst2, ...,] /spawn, /loud, /passive_ftp
    • Schedule automatic updates using the Windows Task Scheduler
      • Create Task button on right, In General Tab: Name: SSW Update Click Run whether user is logged on or not
      • In Triggers Tab: Click New... Click Daily Enter the time of day to run every day (like 4:00 AM)
      • In Actions Tab: Click New... In Program/script field, type: C:\ssw\site\setup\daily.bat (or wherever your ssw is located) Click OK.
      • Enter user name and password to run task under.
      • Next time you start the Task Scheduler, you will see the SSW Update task listed in the Task Scheduler Library. To edit the SSW Update job, right click it in the Task Scheduler Library and click Properties

UNIX-specific instructions

  • Installation
    • Use the SSW installation form to select instruments (at least hessi, spex, xray), generate, and download an installation script
    • Transfer your customized script to a local disk (a link to the script will show up after you submit your installation FORM)
    • Execute the script using the C-Shell % csh -f scriptname , and follow the instructions to execute the script.
  • Configuration
    • Copy the RHESSI setup file, $SSW/hessi/setup/setup.hessi_env, (and any other instrument startup files that need modifications) to your $HOME directory and edit it as instructed in the file itself. (If your system administrator has already copied this file to your $SSW/site/setup directory and customized it for your environment, you may not need to do this). The importance of this step is that it defines the HSI_DATA_ARCHIVE and HSI_DATA_USER environment variables which are needed to tell the RHESSI software where to find the data files. (Click here for instructions on accessing the data files.)
    • Modify your .login (or equivalent) to include lines similar to the following:
         setenv SSW /usr/local/ssw
         setenv SSW_INSTR 'hessi xray spex'
         source $SSW/gen/setup/setup.ssw
      These lines define the location of your SSW tree, select which instruments you want to use in IDL, and run the setup script to run the individual setup scripts for the selected instruments. Run the script (e.g. source .login) or log into a new session to run the script.
    • Type sswidl to start IDL with SSW (or sswidlde to start IDLDE with SSW).
  • Updating
    • Run ssw_upgrade anytime from within SSWIDL via ssw_upgrade, [/inst1, /inst2, ...,] /spawn, /loud, /passive_ftp
    • Schedule a cron job to run go_update_ssw
      • Edit the file $SSW/site/setup/setup.ssw_upgrade to include (or delete) the instruments or packages to update
      • Create a cron entry like the following (to run every day at 02:43 AM in this case):
           43 02 * * * /LOCALSSW/gen/bin/ssw_batch go_update_ssw /LOCALSSW/site/setup/update_ssw.log
      • Or if the cron entry needs some local setup, create a file that looks like this and call it, e.g. ssw_update:
          #!/bin/csh
          setenv SSW /data/ssw
          setenv ssw_passive_ftp 1
          source $SSW/gen/setup/setup.ssw
          $SSW/gen/bin/ssw_batch go_update_ssw $SSW/site/setup/update_ssw.log
        where setenv SSW points to your location of the SSW tree, and create a cron entry like the following::
           43 02 * * * /YOURPATH/update_ssw /YOURPATH/update_ssw.log 2>&1