Skip to the navigation links
Last modified: 31 January 2023

URL: https://cxc.cfa.harvard.edu/ciao/download/index.html

Downloading CIAO 4.15.1 and CALDB 4.10.2

The download page provides the basic steps needed to install CIAO 4.15.1 and CALDB 4.10.2 into a new conda environment. For additional details, including how to upgrade an existing environment, users should read the Installing CIAO with conda thread.

Also be sure to review the list of known issues and conflicts with other packages on the conda installation bug page as well as the conda FAQs.

conda is the preferred method to install CIAO. Users who prefer to use the ciao-install script can skip to the bottom of this page; some users find this a simpler installation process if they do not need third-party applications such as astropy or scipy.

  1. Please be aware of the following issues before installing CIAO 4.15.1 (see the watchout page for more information):

  2. Verify conda version. Users should be using conda version 4.7.6 or newer.

    $ conda --version
    conda 4.8.3
    

    If conda is not installed - that is the following fails

    $ conda --version
    conda: Command not found.
    

    then users can install miniconda from the Anaconda website.

    [WARNING]
    Installation on Apple Silicon Systems

    Users of Apple Silicon-based systems (M1, M1 Pro/Max/Ultra, and M2) must use the Intel x86-64 MacOS distribution of Conda. The mid-May 2022 release of Anaconda introduced a native Apple Silicon ARM64 distribution which is incompatible with the current Conda CIAO distribution, and attempts to install with conda will fail due to missing packages.

  3. Install CIAO into a new conda environment.

    $ conda create -n ciao-4.15 \
      -c https://cxc.cfa.harvard.edu/conda/ciao \
      -c conda-forge \
      ciao sherpa ds9 ciao-contrib caldb_main marx
    

    CIAO-4.15.1 is available with Python 3.10, 3.9, or 3.8. The default will be determined based on the other packages available on conda-forge channel at the time of installation. To request a specific version, add python=3.8, python=3.9, or python=3.10 to the conda create line.

    Users may also wish to includes packages such as jupyter, astropy, and scipy into their new CIAO conda environment. The caldb_main package is the base CalDB, while the additional background files are contained in the acis_bkg_evt and hrc_bkg_evt packages. The caldb package is the entire CalDB which can be used in lieu of the three previously mentioned CalDB packages.

    [IMPORTANT]
    Upgrade CIAO 4.15 to CIAO 4.15.1

    Users who already have a CIAO 4.15 environment can upgrade it to CIAO 4.15.1 by updating the ciao, ciao-contrib, and ds9 packages:

    $ conda install -n ciao-4.15 \
      -c https://cxc.cfa.harvard.edu/conda/ciao \
      -c conda-forge \
      ciao=4.15.1 ds9=8.4.1 ciao-contrib=4.15.1
    

    or users can choose to create a separate environment for CIAO 4.15.1.

    [IMPORTANT]
    CIAO 4.15.1 requires conda-forge channel

    Updating to the latest version of XSpec requires CIAO to use a version of libgfortran which is not available in the default channel. Users will therefore need to include the conda-forge channel when they install CIAO 4.15.1.

    It is strongly recommended to create a new conda environment for CIAO 4.15.1 rather than trying to upgrade an environment containing an older version of CIAO.

    [TIP]
    Problem with downloading XSPEC models or CALDB

    Users experiencing problems downloading the CALDB files and/or the XSPEC model files can follow the Alternative download instructions.

  4. Activate the CIAO environment

    tcsh% conda activate ciao-4.15
      or
    bash$ source activate ciao-4.15
    

    By default, the terminal prompt will change to show the currently active conda environment. Users can also run the ciaover command to verify that they are setup correctly.

    # packages in environment at /export/miniconda/envs/ciao-4.15:
    #
    # Name                    Version                   Build  Channel
    caldb4                    0.1.0                    pypi_0    pypi
    ciao                      4.15.0          py310h50a7cbf_0    https://cxc.cfa.harvard.edu/conda/ciao
    ciao-contrib              4.15.0                     py_1    https://cxc.cfa.harvard.edu/conda/ciao
    ds9                       8.4                           0    https://cxc.cfa.harvard.edu/conda/ciao
    sherpa                    4.15.0                   pypi_0    pypi
    
    System information:
    Linux is_awesome.cfa.harvard.edu 3.10.0-1062.12.1.el7.x86_64 #1 SMP Tue Feb 4 23:02:59 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
    

    Users may want to create an alias so that they only need to type ciao to activate their environment.

    [NOTE]
    MARX setup

    If you installed marx then you should do the following, so that scripts such as simulate_psf and the dax options in DS9 will work correctly:

    $ conda env config vars set MARX_ROOT=$CONDA_PREFIX
    

    This command only needs to be run once.

    If you are going to be using marx directly then you can find the parameter files in the directory

    $CONDA_PREFIX/share/marx/pfiles
    
  5. Run the CIAO smoke tests:
    $ cd $ASCDS_INSTALL/test
    $ make
    

    If there are any errors reported during the smoke tests, users can check the smoke test bugs page for possible solutions.

  6. Finished! CIAO is now installed and you can being your data reduction and analysis work.

[NOTE]
conda is preferred installation method, ciao-install alternative

The CXC now suggests that users install CIAO using the conda package management system. This method allows users to more easily add 3rd party Python packages into their environment.

Alternatively, users can install CIAO using the ciao-install script. Follow this link for instructions:


[NOTE]
Would you like to receive Chandra and CIAO announcements?

Send an email message to: chandra-announce+subscribe@cfa.harvard.edu