- Version: 2.0.0.dev (3 June 2021)
- GammaLib dependency: 2.0.0.dev
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
ctools are ftools-like executable for the scientific analysis of Cherenkov telescope observations. They are based on GammaLib, a versatile toolbox for the high-level analysis of astronomical gamma-ray data.
The following tools are available:
ctbin - event binning ctbkgcube - generate a background cube ctbutterfly - create a butterfly ctcubemask - mask bins in binned analysis ctedispcube - generate energy dispersion cube cterror - likelihood profile error estimation ctexpcube - generate an exposure cube ctfindvar - search for source variability ctlike - maximum likelihood model fitting ctmapcube - generate sky map cube ctmodel - generation of model counts map ctobssim - simulation of CTA observations ctphase - computes the phase of each event ctprob - computes event probability for a given model ctpsfcube - generate a PSF cube ctselect - event selection ctskymap - CTA sky mapping tool cttsmap - generate a TS map ctulimit - compute upper limits
The following scripts are available:
csbkgmodel - generates background model for 3D analysis cscaldb - lists available instrument response functions csebins - generates energy boundaries for stacked analysis csinfo - checks ctools and GammaLib installations cslightcrv - computes light curve csmodelinfo - shows model container content csmodelmerge - merges several model containers into one file csmodelselect - select models from model definition file csmodelsois - generate map cube from subset of models csobsdef - generates observation definition file csobsinfo - shows observation container content csobsselect - select observations from observation definition file csphagen - generates PHA, ARF, RMF files based on source/background regions csphasecrv - computes phase curve cspull - generates pull distribution csresmap - generates residual map csresspec - generates residual spectrum csroot2caldb - creates a caldb entry from a ROOT file csscs - Performs spectral component separation cssens - computes CTA sensitivity csspec - computes spectral points cssrcdetect - detects sources in sky map cstsdist - generates Test Statistic distribution cstsmapmerge - merges slices from Test Statistic map computations cstsmapsplit - creates commands to split the Test Statistic map computations csviscube - computes visibility cube csworkflow - run an analysis workflow
ctools require GammaLib. Please refer to http://cta.irap.omp.eu/gammalib for instructions about how to install GammaLib.
Once GammaLib is properly installed, make sure that you added the setup script to your .bashrc or $HOME/.profile script:
export GAMMALIB=/usr/local/gamma source $GAMMALIB/bin/gammalib-init.sh
If you use C shell or a variant then add the following to your .cshrc or .tcshrc script:
setenv GAMMALIB /usr/local/gamma source $GAMMALIB/bin/gammalib-init.csh
If you have installed GammaLib in another directory than /usr/local/gamma, please adapt the path correspondingly.
If you really insist, you may install ctools in a directory different to that hosting GammaLib, but we highly recommend to install both packages together.
The easiest is to install ctools via conda. This also takes care of the installation of GammaLib. Assuming that you have installed anaconda, type the following:
$ conda config --append channels conda-forge $ conda config --append channels cta-observatory $ conda install ctools
To build and install ctools, simply type the following:
$ ./configure $ make $ make check $ make install
If the folder does not contain any
configure file, please run
By default ctools installs itself in /usr/local/gamma. If you need to install ctools in a different location or in your home directory, use the --prefix option to ./configure. For example:
$ ./configure --prefix=/home/yourname/projects $ make $ make check $ make install
The file INSTALL details more about using configure. Also try
$ ./configure --help.
make check command will run an extensive unit test to verify that
ctools was correctly built. Make sure that all tests were successful.
ctools is known to work on various flavors of Mac OS. To cope with different system versions and architectures, there are two Mac specific configure options:
$ ./configure --enable-universalsdk[=PATH]
creates a universal build of ctools. The optional argument specifies which MacOS SDK should be used to perform the build. This defaults to "/Developer/SDKs/MacOSX.10.4u.sdk". Specify "/" when building on a 10.5 system or higher, especially when building 64-bit code.
$ ./configure --with-univeral-archs=VALUE
specifies the kind of universal build that should be created. Possible values are: "32-bit", "3-way", "intel" or "all". By default, a "32-bit" build will be made. This option is only valid when "--enable-universalsdk" is specified.
These options are in particular needed if your Python architecture differs from the default architecture of your system. To examine the Python architecture you may type:
$ file `which python`
which will return the architectures that are compiled in the Mach-0 executable:
i386 32-bit intel ppc 32-bit powerpc ppc64 64-bit powerpc x86_64 64-bit intel
If Python is 32-bit (ppc, i386) but the compiler produces by default 64-bit code (ppc64, x86_64), the Python module will not work. Using
$ ./configure --enable-universalsdk=/
will force a universal 32-bit build which creates code for ppc and i386. If on the other hand Python is 64-bit (ppc64, x86_64) but the compiler produces by default 32-bit code (ppc, i386), the option
$ ./configure --enable-universalsdk=/ --with-univeral-archs=3-way
will generate a universal build which contains 32-bit and 64-bit code.
ctools has been tested on FreeBSD successfully. Follow the Linux installation instructions above.
ctools compile on Solairs, but there is an issue with using it as a shared library (see "Known problems" below).
On Windows ctools needs to be installed into a virtual machine running a Linux distribution.
If you want to test ctools before installation, type the following:
$ make check
Before using ctools you have to setup some environment variables. This will be done automatically by an initialisation script that will be installed in the bin directory.
Assuming that you have installed ctools in the default directory
/usr/local/gamma you need to add the following to your
$HOME/.profile script on a Linux machine:
export CTOOLS=/usr/local/gamma source $CTOOLS/bin/ctools-init.sh
If you use C shell or a variant then add the following to your
setenv CTOOLS /usr/local/gamma source $CTOOLS/bin/ctools-init.csh
See the online documentation at http://cta.irap.omp.eu/ctools.
The doc directory (usually at /usr/local/gamma/share/doc/ctools)
contains the most recent set of updated documentation for this release. A detailed documentation can be created by typing:
$ make doc
before installing the library. Two types of documentation exist:
- code documentation
- user documentation
Code documentation is created using Doxygen. You need Doxygen on your
system to generate the code documentation. This includes man pages.
Doxygen can be obtained from http://www.stack.nl/~dimitri/doxygen/.
User documentation is created using Sphinx. You need Sphinx on your system to generate the user documentation. Sphinx can be obtained from http://sphinx-doc.org/install.html.
To report or search for bugs, please use the ctools Bug Tracker at https://cta-redmine.irap.omp.eu/projects/ctools. Before using the tracker, please read https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Submission_guidelines
Although ctools compile on Solaris using the Sun compiler, there are problems with global symbols in the shared GammaLib library that prevent the model registry to work correctly. Furthermore, GammaLib is not able to catch its own exceptions, which prevents the FITS interface to work correctly. Possible it will work using gcc on Solaris, yet this has not so far been tested.
To get in touch with the ctools developers and to contribute to the project please contact Juergen Knoedlseder email@example.com.