Synopsis
Check that the CIAO and CALDB installations are up to date.
Syntax
check_ciao_version
Description
The check_ciao_version tool allows users to easily check that the CIAO and CIAO Calibration Database (CALDB) installations are up to date. It compares the dates of the installed components against the latest-released versions and prints out those elements that need upgrading. The script requires internet access since it has to download information from the CXC web site.
Tool behavior
The tool prints messages to the screen and exits with a status of 0 when everything is up to date or non-zero when something needs updating.
How do I upgrade my system: conda
The 'conda update' command can be used to update a conda-installed version of CIAO, and the script will detail the necessary arguments.
How do I upgrade my system: ciao-install
If the tool finds that your CIAO or CALDB installations are out of date then it will point you to the ciao-install download page, from which the ciao-install script can be downloaded. This script will perform the necessary updates.
Limitations
The tool does not
- check that the components are installed correctly;
- check for any optional CALDB components, such as the ACIS background files (for the ciao-install case, it does with the conda install).
The CALDB check matches that done by the "--latest" flag of check_ciao_caldb, but it does not do the validation check that check_ciao_caldb does.
Examples
Example 1
unix% check_ciao_version
Up to date: conda
If the installations are up to date then you will see something like the following:
CIAO (installed via conda) is up to date.
Out of date
If there is an out of date component then you will see something like:
There is one package that need updating:
ciao-contrib : 4.15.2 -> 4.15.3
The update can be checked with:
conda update ciao-contrib --no-deps \
-c https://cxc.cfa.harvard.edu/conda/ciao \
-c conda_forge \
--dry-run
and then repeated without the '--dry-run' option to make the change.
Example 2
unix% check_ciao_version
Up to date: ciao-install
If the installations are up to date then you will see something like the following:
The CIAO installation at /soft/ciao is up to date. The CALDB installation at /soft/ciao/CALDB (link to /data/CALDB/ciao) is up to date.
The actual output will vary depending on where (and how) CIAO and CALDB where installed.
Out of date
If there is an out of date component then you will see something like:
The CIAO installation at /usr/local/ciao-4.16 is up to date.
The CALDB installation at /usr/local/ciao-4.16/CALDB
has version: 4.10.5
latest is: 4.10.7
Please use the ciao-install script from
https://cxc.harvard.edu/ciao/download/ciao-install.html
to update your CIAO installation.
or
Using the CIAO installation at /opt/local/ciao-4.15
The following package:
contrib : 21 Jun 2023
needs updating to:
contrib : 21 Aug 2023
The CALDB installation at /opt/local/ciao-4.15/CALDB is up to date.
Please use the ciao-install script from
https://cxc.harvard.edu/ciao/download/ciao_install.html
to update your CIAO installation.
Changes in the scripts 4.16.0 (December 2023) release
The script has been updated to support the new version of ciao-install and initial support for using mamba or micromamba to install CIAO.
Changes in the scripts 4.14.0 (December 2021) release
When there is an update for a conda installation the script will report the command needed to install it.
Changes in the scripts 4.13.1 (March 2021) release
Fix bug affecting ciao-install installations when checking CALDB version.
Changes in the scripts 4.13.0 (December 2020) release
The script has improved handling of the conda installation path.
Changes in the scripts 4.12.1 (December 2019) release
The script has been updated to work with CIAO installations made with the conda package manner as well as with ciao-install, although support should be considered experimental.
Changes in the scripts 4.8.1 (December 2015) release
The code has been updated to avoid warning messages from NumPy version 1.9. There is no difference to how the script behaves.
Changes in the scripts 4.6.2 (February 2014) release
The script no longer exits with an error when version files contain multiple lines, as with VERSION_graphics file in CIAO 4.6.
Changes in the April 2011 Release
The check_ciao_version script was added in this release.
About Contributed Software
This tool is not an official part of the CIAO release but is made available as "contributed" software via the CIAO scripts page. Please see this page for installation instructions.
Bugs
See Also
- tools::utilities
- check_ciao_caldb