Quick Start: Running ciao-install

Just looking for a reminder on how to run the ciao-install script? Here is it:

unix% bash /<path>/ciao-install

For a detailed description of running the script, read the rest of this thread.

System Requirements

CIAO is supported on a number of operating systems, which are listed on the Platform Support page. Certain system requirements are necessary to successfully install and run CIAO; review these system requirements before continuing with the installation.

Download the ciao-install script

The ciao-install script been greatly enhanced for CIAO 4.2. The script now:

• downloads the selected tarfiles for the specified platform
• unpacks and installs the CIAO software and CALDB
• runs the "smoke tests" to spot-check the installation for critical problems

Before continuing, download the ciao-install script.

Where should CIAO and CALDB be installed?

The CIAO software package and the Chandra Calibration Database (CALDB) can be installed in any location and do not need to be installed with root or super-user privileges.

Installing the CIAO Software

In this example, the CALDB will be installed as a subdirectory of CIAO. If you want your CALDB to be in a different location, refer to "How to install the CALDB in an independent directory".

ciao-install may be run from any location. It prompts for required information. Here are the prompts and sample answers for a user named "ciaouser"; each prompt is explained in the following section:

unix% bash /<path>/ciao-install
ciao-install v1.0
Requested packages: sherpa chips tools prism obsvis contrib CALDB_main
Script log file is /home/ciaouser/ciao-install-09-12-16.13.40.22.log
Download directory for tar files (/home/ciaouser): /soft/download
CIAO installation directory (/usr): /soft
Run smoke tests? (y|n) (y): 
Save these settings? (y|n) (y): 

Note that tab completion may be used at these prompts.

sherpa chips tools prism obsvis contrib CALDB_main

Download directory for tar files (/home/ciaouser): /soft/download

CIAO installation directory (/usr): /soft

Run smoke tests? (y|n) (y): 

Save these settings? (y|n) (y): 

At this point, the script begins to download the software tarfiles and install them (e.g. gunzip and untar them). The name, filesize, and download location of each file is printed to the screen:

Downloading file ciao-control (1 Kb) to /soft/download/
Downloading file ciao-4.2-bin-core-Linux64.tar.gz (255 Mb) to /soft/download/
Verifying file ciao-4.2-bin-core-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-core-Linux64.tar.gz to /soft/
Downloading file ciao-4.2-bin-sherpa-Linux64.tar.gz (208 Mb) to /soft/download/
Verifying file ciao-4.2-bin-sherpa-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-sherpa-Linux64.tar.gz to /soft/
Downloading file ciao-4.2-bin-chips-Linux64.tar.gz (67 Mb) to /soft/download/
Verifying file ciao-4.2-bin-chips-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-chips-Linux64.tar.gz to /soft/
Downloading file ciao-4.2-bin-tools-Linux64.tar.gz (74 Mb) to /soft/download/
Verifying file ciao-4.2-bin-tools-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-tools-Linux64.tar.gz to /soft/
Downloading file ciao-4.2-bin-prism-Linux64.tar.gz (946 Kb) to /soft/download/
Verifying file ciao-4.2-bin-prism-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-prism-Linux64.tar.gz to /soft/
Downloading file ciao-4.2-bin-obsvis-Linux64.tar.gz (307 Kb) to /soft/download/
Verifying file ciao-4.2-bin-obsvis-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-obsvis-Linux64.tar.gz to /soft/
Downloading file ciao-4.2-bin-graphics-Linux64.tar.gz (32 Mb) to /soft/download/
Verifying file ciao-4.2-bin-graphics-Linux64.tar.gz
Installing file /soft/download/ciao-4.2-bin-graphics-Linux64.tar.gz to /soft/
Downloading file caldb_4.3.1_main.tar.gz (2 Gb) to /soft/download/
Verifying file caldb_4.3.1_main.tar.gz
Installing file /soft/download/caldb_4.3.1_main.tar.gz to /soft/ciao-4.2/CALDB
Downloading file ciao-4.2-contrib-14Dec2009.tar.gz (191 Kb) to /soft/download/
Verifying file ciao-4.2-contrib-14Dec2009.tar.gz
Installing file /soft/download/ciao-4.2-contrib-14Dec2009.tar.gz to /soft/

If you get an error about being unable to download the CALDB files, please refer to the Downloading the CALDB: FTP passive mode note at the end of this thread.

After the files are downloaded and unpacked, the script configures CIAO and reindexes the CIAO help files ("ahelp"). The reindexing step takes a few minutes:

running chcon to allow CIAO to work with SELinux
Running configure ./configure
Re-indexing ahelp system (be patient!)
Creating binary compiled python modules

The 'running chcon' line only appears on Linux installations. It indicates that the installation has been updated to run under Security-Enhanced Linux, if is installed on your system.

The script will then run the smoke tests. Since the smoke tests include tests of a number of the GUI applications in CIAO, windows will appear and disappear during these tests. This can make using your computer difficult, since these windows may take the mouse focus or overlap your working windows.

The screen output provides a count of how many tests have been run:

Running smoke tests
 Requested test suite includes 42 tests
   [1/42] Running test prism-smoke001 ... PASS
   [2/42] Running test prism-smoke002 ... PASS
   [3/42] Running test ahelp-smoke001 ... PASS
   [4/42] Running test obsvis-smoke004 ... PASS
   [5/42] Running test chips-smoke001 ... PASS
   [6/42] Running test chips-smoke002 ... PASS
...

This will continue until all the tests have finished, at which point you should see

   [40/42] Running test tools-dmstat-smoke001 ... PASS
   [41/42] Running test tools-dmstat-smoke002 ... PASS
   [42/42] Running test tools-dmstat-smoke003 ... PASS

All smoke tests completed:  PASS 
*************************************************************
Smoke tests complete. All tests passed!
Processing complete!
Script Log file is /home/ciaouser/ciao-install-09-12-16.13.40.22.log

Verifying test successes

A successful test is logged with a "... PASS", while an unsuccessful test reports:

   [7/42] Running test <testname> ... FAIL
         Review /tmp/smoke.username/<testname>/diff.log for details

The smoke tests print a summary of successful and failed tests. If all tests were successful:

All smoke tests completed:  PASS 
*************************************************************
Smoke tests complete. All tests passed!

or if any failed:

 1 out of 42 smoke tests FAILED.

       !! CIAO MAY HAVE FAILED TO INSTALL PROPERLY !!
 Please check http://cxc.harvard.edu/ciao4.2/bugs/smoke.html
 for a list of known issues before contacting the Help Desk.

Known Smoke Test Issues

There is a bug page for known smoke test issues. If you experience a problem that isn't listed there, submit it to Helpdesk.

You can now proceed to the checking the CALDB installation step.

How to Install the CALDB in an Independent Directory

Prior to CIAO 4.2, ciao-install had to be run twice to install the CALDB in a separate directory. The script now only has to be run once, with both the CIAO and CALDB installation directories specified.

The destination directory for the CALDB must exist before running ciao-install. In this example, we want to install the CALDB into /soft/CALDB. The directory is created, then --caldb switch is used to set this location in ciao-install.

unix% mkdir /soft/CALDB

unix% bash /<path>/ciao-install --caldb /soft/CALDB
ciao-install v1.0
Requested packages: sherpa chips tools prism obsvis contrib CALDB_main
Script log file is /home/ciaouser/ciao-install-09-12-16.09.32.06.log
Download directory for tar files (/home/ciaouser): /soft/download
CIAO installation directory (/usr): /soft
Run smoke tests? (y|n) (y): 
Save these settings? (y|n) (y): 

ciao-install is run one time: it installs the CIAO software in /soft, installs the CALDB in /soft/CALDB, and links CIAO to the CALDB directory. It then runs the smoke tests, as described in detail in the "Installing the Software: CALDB within CIAO" section.

Check the CALDB installation

The scripts package contains the check_ciao_caldb tool which performs a simple test of the Chandra CALDB installation.

After starting CIAO, running the tool should produce screen output like the following:

unix% ls -1 /soft/ciao-4.2/CALDB/
data/
docs/
software/
unix% check_ciao_caldb
 CALDB environment variable = /soft/ciao-4.2/CALDB
             CALDB version = 4.2.2
             release date  = 2010-04-19T19:00:00 UTC
CALDB query completed successfully.

If CALDB is installed in a different location, the check_ciao_caldb output will include the line:

CALDB environment variable = /soft/ciao-4.2/CALDB
        which is a link to = /soft/CALDB/

For a more-thorough validation please follow the chkcif steps described on the download CALDB page.

Clean Up

Finally, you may delete the tarfiles from the original download directory. For this example we would say:

unix% cd /soft/download
unix% rm ciao-4.2*gz
unix% rm caldb_4.2_main.tar.gz 
unix% rm ciao-install

You may also delete the log file(s) - e.g. ~/ciao-install-<pid>.log - once you have reviewed them for errors.

Create a CIAO alias

It is strongly suggested that you create an alias to make it easy to set up and use CIAO.

The alias syntax depends on the shell (tcsh, csh, bash); see this FAQ for help in determining which shell you are using.

• csh/tcsh users should add the following to their $HOME/.cshrc file.

  alias ciao "source /soft/ciao-4.2/bin/ciao.csh"
  

• bash users should add the following to their $HOME/.bashrc file.

  alias ciao=". /soft/ciao-4.2/bin/ciao.bash"
  

• ksh users should add the following to their $HOME/.login file.

  alias ciao=". /soft/ciao-4.2/bin/ciao.ksh"
  

More information is given in the Running CIAO section of the Starting CIAO thread.

Once the alias is defined, you will be able to simply type

unix% ciao

and CIAO will be setup and ready to use in that window.

Notes

ERROR: Unable to retrieve ftp://cda.harvard.edu/pub/arcftp/caldb_4/caldb_4.3.1_main.tar.gz
ERROR: Unable to download caldb_4.3.1_main.tar.gz
ERROR: Bad Download. Please try again. If the problem continues Please contact the CfA helpdesk. 

default
macdef init
epsv4 off