CIAO

CIAO unpacks into a directory called ciao-<version>/, i.e. ciao-4.2 for this release. If the current version of CIAO were to be installed into /usr/local/, the full path to CIAO would be /usr/local/ciao-4.2/. This directory (/usr/local/ciao-4.2/) is referred to as the root directory of CIAO in the rest of this thread. It is also the value that the $ASCDS_INSTALL environment variable is set to once CIAO has been started.

In the rest of this thread we will assume CIAO is being installed into /soft/.

CALDB

CALDB may be installed in two ways:

• within the CIAO installation, in the directory $ASCDS_INSTALL/CALDB
• in a separate directory, in which case $ASCDS_INSTALL/CALDB will be a soft link to the actual CALDB location.

This thread assumes that you have installed 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

Installing CIAO as the root user

It is is strongly suggested that CIAO be installed as a non-privileged user and not as the root user. If CIAO must be installed in a directory owned by root and you are following the manual process, then

1. unpack CIAO as root (so creating the ciao-4.2/ directory);
2. use the chown utility to change ownership of this directory to the installer's username.

1. Change to the CIAO installation directory

The CIAO 4.2 tarfiles create a directory named ciao-4.2 for the software installation. It is not necessary to create the CIAO directory before starting the installation.

Move to the directory in which you would like the root of the CIAO installation to be located. If you are installing the software for a local network, this directory must also be visible to all potential CIAO users.

This installation will be done in the /soft directory:

unix% cd /soft/

2. Unpack CIAO 4.2

From the CIAO location just chosen, untar the CIAO 4.2 binary packages. (If you prefer more screen output, add the "v" option to the gtar command.)

Solaris users must use GNU tar, as shown in this example (see the system requirements page). Users on other platforms who don't have gtar installed can use tar with the same "xzf" options.

unix% pwd
/soft

unix% gtar xzf /soft/download/ciao-4.2-bin-chips-Linux.tar.gz

unix% gtar xzf /soft/download/ciao-4.2-bin-core-Linux.tar.gz

unix% gtar xzf /soft/download/ciao-4.2-bin-graphics-Linux.tar.gz

unix% gtar xzf /soft/download/ciao-4.2-bin-obsvis-Linux.tar.gz

unix% gtar xzf /soft/download/ciao-4.2-bin-prism-Linux.tar.gz

unix% gtar xzf /soft/download/ciao-4.2-bin-sherpa-Linux.tar.gz

unix% gtar xzf /soft/download/ciao-4.2-bin-tools-Linux.tar.gz

When all the files are unpacked, the CIAO directory will look like:

unix% ls ciao-4.2
COPYING*                VERSION_core            configure.in*
COPYING.LIB*            VERSION_obsvis          data/
INSTALL_BINARY          VERSION_prism           doc/
INSTALL_SOURCE          VERSION_sherpa          include/
LICENSE                 VERSION_tools           install-sh*
LICENSE.SAO             bin/                    lib/
Makefile                binexe/                 ots/
README                  config/                 param/
README.obsvis           config.guess*           share/
VERSION                 config.h.in             test/
VERSION.prop_tk         config.sub*
VERSION_chips           configure*

3. 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.2 Contributed Scripts Page. Check that page for announcements about new scripts and updates to existing ones.

In CIAO 4.2, the contributed tarfile is designed to be unpacked from the same directory as the CIAO software. (Prior to CIAO 4.2, the scripts had to be unpacked from within the CIAO installation.)

unix% pwd
/soft/

Unpack the script tarfile:

unix% tar xzvf /soft/download/ciao-4.2-contrib-14Dec2009.tar.gz
./ciao-4.2/
./ciao-4.2/contrib/
./ciao-4.2/contrib/Changes.CIAO_scripts
./ciao-4.2/contrib/README_CIAO_scripts
./ciao-4.2/contrib/VERSION.CIAO_scripts
./ciao-4.2/contrib/bin/
./ciao-4.2/contrib/bin/acis_bkgrnd_lookup

...

./ciao-4.2/contrib/share/slsh/local-packages/sherpa_primini.sl
./ciao-4.2/contrib/sherpacl/
./ciao-4.2/contrib/sherpacl/sherpacl

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.

4. Run the configuration script

Run the CIAO configuration script:

unix% cd ciao-4.2/

unix% ./configure
Running CXC configure, v4.3.10
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.2/ots/bin
configure: creating ./config.status
config.status: creating bin/ciao_setup.sh
config.status: creating ots/lib/python2.6/config/Makefile
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 bin/setup_chips.sh
config.status: creating bin/setup_chips.csh
config.status: creating bin/setup_sherpa.sh
config.status: creating bin/setup_sherpa.csh
config.status: creating bin/setup_tools.sh
config.status: creating bin/setup_tools.csh
config.status: creating bin/ciao-python-fix
config.status: creating test/smoke/bin/setup.sh
config.status: creating test/Makefile
config.status: creating ots/etc/pango/pangorc
config.status: creating ots/etc/pango/pango.modules
config.status: creating ots/etc/gtk-2.0/gtk.immodules
config.status: creating ots/etc/gtk-2.0/gdk-pixbuf.loaders

5. Link to CALDB

Create a link to the calibration data, changing the path to match your system installation:

unix% pwd
/soft/ciao-4.2/

unix% ln -s /soft/CALDB CALDB

At this point, your directory should look like:

unix% ls
CALDB@                  VERSION_core            configure*
COPYING*                VERSION_obsvis          configure.in*
COPYING.LIB*            VERSION_prism           contrib/
INSTALL_BINARY          VERSION_sherpa          data/
INSTALL_SOURCE          VERSION_tools           doc/
LICENSE                 bin/                    include/
LICENSE.SAO             binexe/                 install-sh*
Makefile                config/                 lib/
README                  config.guess*           ots/
README.obsvis           config.h.in             param/
VERSION                 config.log              share/
VERSION.prop_tk         config.status*          test/
VERSION_chips           config.sub*

6. Create a CIAO alias

It is strongly suggested that you create a CIAO alias before continuing.

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.

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.

Downloading the CALDB: FTP passive mode

Some users are unable to download the CALDB via ciao-install or wget. This is because the user's FTP has defaulted to extended passive mode for the file transfer. Extended passive mode is not supported for the Archive web server, which hosts the CALDB tarfiles.

The workaround is for users to create a $HOME/.netrc file containing the following:

default
macdef init
epsv4 off

Note that there is a blank line after the "epsv4 off" entry.

Using the "--no-passive-ftp" flag with wget may also resolve the issue.

Solaris: "@LongLink" file

If a file named "@LongLink" is created when the tarfiles are unpacked on Solaris, it is an indication that tar was used instead of GNU tar ("gtar").

As noted in the System Requirements section, Solaris users must use gtar to unpack the files. If native Solaris tar is used, some of the test filenames will be truncated.

Known Conflicts

There are some known conflicts between CIAO and other software or system libraries and tools. They are documented in the following webpages:

• "Watch Out" List

• Other Software Packages bug page

Usage and Licensing

All non-OTS source code will be freely available in support of any CIAO release. The software is subject to Smithsonian Institution Copyright, a statement of which can be found in the headers of the source files, as well as at $ASCDS_INSTALL/LICENSE.SAO.

CIAO 4.2 is further governed by the GNU General Public License ($ASCDS_INSTALL/COPYING) and/or the GNU Library General Public License ($ASCDS_INSTALL/COPYING.LIB), both of which are bundled with the software.