Installing CIAO 4.0

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.

Downloading the Software

To install CIAO, you need the following packages from the CIAO download pages:

• Binaries: ciao-4.0-bin-<component>-<OSname>.tar.gz

  Contains the CIAO tools, libraries, parameter files, and help files. Also contains the pre-compiled off-the-shelf (OTS) programs required to run CIAO. There are five components in CIAO 4.0: core, tools, chips, sherpa, and obsvis.

  CIAO 4.0.1 (optional, all platforms): there is a platform-independent patch for the ObsVis proposal planning tool: ciao-4.0.1-bin-obsvis.tar.gz. This is an optional installation.

  CIAO 4.0.2 (Mac OS X 10.5 Intel): to run CIAO on 10.5 (Leopard), you must install the CIAO 4.0.2 patch as well. The patch is optional for 10.4 (Tiger) Intel machines. The patch files are:

  ciao-4.0.2-patch-bin-chips-osxi.tar.gz
  ciao-4.0.2-patch-bin-core-osxi.tar.gz
  ciao-4.0.2-patch-bin-obsvis-osxi.tar.gz
  ciao-4.0.2-patch-bin-tools-osxi.tar.gz
  

• Chandra Calibration Database (CALDB)

• Contributed science scripts: CIAO_4.0_scripts.tar

Save the tarfiles to a location that is accessible from where you wish to install CIAO. These files were used to install CIAO on a Fedora Core machine:

unix% ls -1
CIAO_4.0_scripts.tar
acis_bkgrnd_3.0.0.tar.gz
caldb_3.4.2_main.tar.gz
ciao-4.0.1-bin-obsvis.tar
ciao-4.0-bin-chips-fc4.tar.gz
ciao-4.0-bin-core-fc4.tar.gz
ciao-4.0-bin-obsvis-fc4.tar.gz
ciao-4.0-bin-sherpa-fc4.tar.gz
ciao-4.0-bin-tools-fc4.tar.gz

CALDB

It is suggested that you install the CALDB before starting the CIAO installation, as CIAO has to be linked to the location of those files. Installation instructions are available on the CALDB website:

• Installing (or upgrading) the CALDB

For this thread, we assume that the database is installed in the /soft directory:

/soft/CALDB/

Installing the CIAO Software

unix% gunzip *gz

unix% ls -1
CIAO_4.0_scripts.tar
ciao-4.0.1-bin-obsvis.tar
ciao-4.0-bin-chips-fc4.tar
ciao-4.0-bin-core-fc4.tar
ciao-4.0-bin-obsvis-fc4.tar
ciao-4.0-bin-sherpa-fc4.tar
ciao-4.0-bin-tools-fc4.tar

unix% cd /soft/

unix% pwd
/soft

unix% gtar xf /some/path/ciao-4.0-bin-chips-fc4.tar 

unix% gtar xf /some/path/ciao-4.0-bin-core-fc4.tar 

unix% gtar xf /some/path/ciao-4.0-bin-obsvis-fc4.tar

unix% gtar xf /some/path/ciao-4.0-bin-sherpa-fc4.tar 

unix% gtar xf /some/path/ciao-4.0-bin-tools-fc4.tar 

unix% ls ciao-4.0
bin/           doc/            param/
binexe/        help/           quickhelp/
config/        include/        README
config.guess*  INSTALL_BINARY  README.cycle9
config.h.in    install-sh*     README.obsvis
config.sub*    INSTALL_SOURCE  share/
configure*     lib/            test/
configure.in*  LICENSE         VERSION
COPYING*       LICENSE.SAO     VERSION.prop_tk
COPYING.LIB*   Makefile
data/          ots/

unix% cd ciao-4.0/

unix% ./configure
Running CXC configure, v4.2.5
checking build system type... x86_64-unknown-linux-gnu
checking host system type... x86_64-unknown-linux-gnu
checking target system type... x86_64-unknown-linux-gnu
checking for more... /bin/more
checking for main in -lpthread... no
  --with-imagerdir not specified, defaulting to /soft/ciao-4.0/ots/bin
configure: creating ./config.status
config.status: creating config/system/CXCdefaults
config.status: creating bin/ciao_setup.sh
config.status: creating bin/ciao.sh
config.status: creating bin/ciao.csh
config.status: creating bin/ciao.ksh
config.status: creating bin/ciao.bash
config.status: creating test/smoke/bin/setup.sh
config.status: creating test/Makefile

unix% pwd
/soft/ciao-4.0/

unix% ln -s /soft/CALDB CALDB

unix% ls
bin/           data/           Makefile
binexe/        doc/            ots/
config/        help/           param/
config.guess*  include/        quickhelp/
config.h.in    INSTALL_BINARY  README
config.sub*    install-sh*     README.cycle9
configure*     INSTALL_SOURCE  share/
configure.in*  lib/            test/
COPYING*       LICENSE         VERSION
COPYING.LIB*   LICENSE.SAO     VERSION.prop_tk

unix% ciao

Overlay the CIAO 4.0.1 patch (Optional)

The 4.0.1 patch is installed from the same location as the CIAO installation. In our example, this directory is /soft/; if you do not recall where your root directory is, start CIAO and type:

unix% cd $ASCDS_INSTALL

unix% cd ..

unix% pwd
/soft/

From this directory, untar the patch file:

unix% tar xf /some/path/ciao-4.0.1-bin-obsvis.tar

Next, run the patch configuration script:

unix% cd ciao-4.0/

unix% ./configure
Running CXC configure, v4.2.6
checking build system type... x86_64-unknown-linux-gnu
checking host system type... x86_64-unknown-linux-gnu
checking target system type... x86_64-unknown-linux-gnu
checking for more... /bin/more
checking for main in -lpthread... no
  --with-imagerdir not specified, defaulting to /soft/ciao-4.0/ots/bin
configure: creating ./config.status
config.status: creating config/system/CXCdefaults
config.status: creating bin/ciao_setup.sh
config.status: creating bin/ciao.sh
config.status: creating bin/ciao.csh
config.status: creating bin/ciao.ksh
config.status: creating bin/ciao.bash
config.status: creating bin/setup_obsvis.sh
config.status: creating bin/setup_obsvis.csh
config.status: creating test/smoke/bin/setup.sh
config.status: creating test/Makefile

The 4.0.1 patch is now installed. When you start CIAO, the version number indicates this:

CIAO configuration is complete...
 CIAO version     :  CIAO 4.0.1 Thursday, February 14, 2008
 Proposal Toolkit version :  Cycle 10 Thursday, December 6, 2007
 bin dir          :  /soft/ciao-4.0/bin

Overlay the CIAO 4.0.2 patch (Mac OS X Intel only)

The CIAO 4.0.2 patch is for Mac OS X Intel machines only. It is required for 10.5 (Leopard) and optional for 10.4 (Tiger).

The patch unpacks into the "ciao-4.0" directory where CIAO is installed. In our example, this directory is located within /soft/; if you do not recall where your CIAO installation directory is, start CIAO and type:

unix% cd $ASCDS_INSTALL

unix% cd ..

unix% pwd
/soft/

From this directory, untar the patch files:

unix% tar xf /some/path/ciao-4.0.2-patch-bin-chips-osxi.tar

unix% tar xf /some/path/ciao-4.0.2-patch-bin-core-osxi.tar

unix% tar xf /some/path/ciao-4.0.2-patch-bin-obsvis-osxi.tar

unix% tar xf /some/path/ciao-4.0.2-patch-bin-tools-osxi.tar

Next, run the patch script.

unix% cd ciao-4.0/

unix% ./ciao_patch.sh

This installs the updated CIAO files in the correct directories. The files that are replaced are renamed ".<filename>_CIAO_4.0"; refer to the 4.0.2 README for more information.

Run the CIAO configuration script again:

Running CXC configure, v4.2.6
checking build system type... i386-apple-darwin9.2.2
checking host system type... i386-apple-darwin9.2.2
checking target system type... i386-apple-darwin9.2.2
checking for more... /usr/bin/more
checking for main in -lpthread... no
  --with-imagerdir not specified, defaulting to /export/ciao-4.0/ots/bin
configure: creating ./config.status
config.status: creating config/system/CXCdefaults
config.status: creating bin/ciao_setup.sh
config.status: creating bin/ciao.sh
config.status: creating bin/ciao.csh
config.status: creating bin/ciao.ksh
config.status: creating bin/ciao.bash
config.status: creating bin/setup_obsvis.sh
config.status: creating bin/setup_obsvis.csh
config.status: creating test/smoke/bin/setup.sh
config.status: creating test/Makefile

The patch is now installed. When you start CIAO, the version number indicates this:

CIAO configuration is complete...
 CIAO version     :  CIAO 4.0.2 Friday, March 28, 2008
 Proposal Toolkit version :  Cycle 10 Thursday, December 6, 2007
 bin dir          :  /soft/ciao-4.0/bin

Contributed Science Scripts

The contributed science scripts are written and maintained by local CIAO users at the CXC. More information on each of the scripts is available from the CIAO 4.0 Contributed Scripts Page. Check that page for announcements about new scripts and updates to existing ones.

The CIAO_4.0_scripts.tar file is designed to be unpacked in $ASCDS_INSTALL, the root directory of the CIAO installation. In our example, this directory is /soft/ciao-4.0; if you do not recall where your root directory is, start CIAO and type "cd $ASCDS_INSTALL" to get there.

unix% cd /soft/ciao-4.0

Since this is a new CIAO directory (i.e. not a patch to an existing version of CIAO), we do not need to worry about uninstalling old scripts.

Unpack the script tarfile:

unix% tar xvf /some/path/CIAO_4.0_scripts.tar
contrib/Changes.CIAO_scripts
contrib/README_CIAO_scripts
contrib/VERSION.CIAO_scripts

...

contrib/bin/tg_bkg
contrib/doc/xml/tg_bkg.xml
contrib/uninstall_4.0_scripts

The tarfile contains a VERSION.CIAO_scripts file. Compare the timestamp in this file to the "Last Updated" date on the Scripts page to determine when you need to update your local scripts installation.

Create the Help File Indexes

In order for CIAO to be able to access the help files packaged with the software, it is necessary to create the ahelp database indexes. This step must be run by the user who owns the CIAO installation.

Start CIAO and run ahelp -r:

unix% ciao
CIAO configuration is complete...
 CIAO version     :  CIAO 4.0.1 Thursday, February 14, 2008
 Proposal Toolkit version :  Cycle 10 Thursday, December 6, 2007
 bin dir          :  /soft/ciao-4.0/bin

unix% ahelp -r

Processing file '/soft/ciao-4.0/doc/xml/ChipsId.xml'...OK

Processing file '/soft/ciao-4.0/doc/xml/Attributes.xml'...OK

Processing file '/soft/ciao-4.0/doc/xml/ChipsDictionary.xml'...OK

....

Processed Files  : 744
Succeeded Files  : 744
Failed Files     : 0
Purged Duplicates: 0

Creating Key Indexes...DONE
Subject DB Size: 1200

Creating Context Indexes...DONE
Context DB Size: 1200

Creating Crossreference DB...DONE
Crossreferences DB Size: 13991

Creating Seealso  DB...DONE
Seealso DB Size: 1569

Run the Smoke Tests

A set of smoke tests are packaged with CIAO 4.0. The tests are designed to spot-check the installation for critical problems, not to run a complete regression test of the system. The output created by the new installation of CIAO is compared against a baseline set of files included in the package.

The runtime for the smoke tests varies based on platform: 5-10 minutes on a 3GHz Linux machine and on order of 30 minutes on a 1GHz Solaris machine. Some of the tests launch ChIPS windows and GUI applications, such as peg; these applications will be closed automatically when the test is complete.

unix% cd $ASCDS_INSTALL/test
unix% pwd
/soft/ciao-4.0/test

unix% make -k test |& tee ~/ciao_test.log

PATH=${PWD}/smoke/bin:${PATH} && \
        export PATH && \
        make test-ui test-chips test-sherpa \
                test-tools test-dm test-crates
make[1]: Entering directory `/soft/ciao-4.0/test'

Running test peg-smoke001


export PATH && \
make test-ui test-chips  \
        test-tools test-dm test-crates

Running test ui-peg1
Successfully completed running ui-peg1
ui-peg1 completed SUCCESSFULLY
...

A successful test prints a message:

<testname> completed SUCCESSFULLY

or

PASS: Test <testname> completed SUCCESSFULLY

An unsuccessful test will report:

<testname> FAILED
 Review /tmp/smoke/<testname>/diff.log for details

The smoke tests do not currently print a summary of successful and failed tests. Review the log file or screen output to be certain that none of the tests failed.

Running test prism-smoke002
/soft/ciao-4.0/ots/bin/python: line 5: 11900 Terminated            
  
${EXE} "$@"
prism-smoke002 completed SUCCESSFULLY

Running test ui-prism2
sh: line 1: kill: (26687) - No such process
ui-prism2 completed SUCCESSFULLY

Running test chips-smoke005
chips-smoke005 completed SUCCESSFULLY
make[1]: Target `test-chips' not remade because of errors.

Clean Up the Tarfiles

Finally, you may delete the tarfiles from the original download directory:

unix% rm /some/path/ciao*tar

unix% rm /some/path/CIAO_4.0_scripts.tar

Notes