Patching CIAO 4.0 to CIAO 4.0.1

CIAO 4.0 Science Threads

Overview

Last Update: 26 Feb 2008 - consistently use "/soft" as the installation directory

Synopsis:

How to patch CIAO 4.0 to 4.0.1.

This thread assumes that you already have CIAO 4.0 installed. If you don't, follow the Installing CIAO 4.0 thread. That thread includes the patch installation, so you do not need to return to this thread.

Proceed to the HTML or hardcopy (PDF: A4 | letter) version of the thread.

Downloading the Patch File
Installing the Patch
Reindexing the Help Files
Run the ObsVis Smoke Tests
Clean Up the Tarfiles
Notes
- Known Conflicts
- Usage and Licensing
History

Downloading the Patch File

The CIAO 4.0.1 patch is available from the CIAO download pages. There is a single platform-independent patch file for the ObsVis proposal planning tool: ciao-4.0.1-bin-obsvis.tar.gz .

Save the tarfile to a location that is accessible from where you wish to install CIAO and unzip it:

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

Installing the Patch

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 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 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

Reindexing the Help Files

The patch file contains an ObsVis help file not available in the CIAO 4.0 distribution. In order for CIAO to be able to access the file, it is necessary to regenerate the ahelp indexes.

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 '/data/ciao-4.0/doc/xml/ChipsId.xml'...OK

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

Processing file '/data/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 ObsVis Smoke Tests

A set of ObsVis smoke tests are packaged with the CIAO 4.0.1 patch. These instructions show how to run just the ObsVis tests, not the full set of CIAO smoke tests.

These tests take just a few minutes to run. They launch ObsVis and ds9 windows, which will be closed automatically when the test is complete.

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

unix% make test-obsvis |& tee ~/obsvis_test.log

Running test obsvis-smoke001
obsvis-smoke001 completed SUCCESSFULLY

...

Running test obsvis-smoke012
obsvis-smoke012 completed SUCCESSFULLY

A successful test prints a message:

obsvis-smoke<NNN> completed SUCCESSFULLY

An unsuccessful test will report:

obsvis-smoke<NNN> FAILED
 Review /tmp/smoke/obsvis-smoke<NNN>/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.

Clean Up the Tarfiles

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

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

Notes

Known Conflicts

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

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.0 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.

History

22 Feb 2008	original version: new for CIAO 4.0.1
26 Feb 2008	consistently use "/soft" as the installation directory