Commit f68a241a59198f691951abc5a091391d7541e86c
1 parent
8da85de6
update
Showing
1 changed file
with
92 additions
and
27 deletions
README
| 1 | -This is GammaLib version 0.2.0 | |
| 2 | -============================== | |
| 1 | +ctatools information | |
| 2 | +==================== | |
| 3 | +Version: 01-00-00 (January 31, 2011) | |
| 4 | +Author: Juergen Knodlseder (knodlseder@cesr.fr) | |
| 5 | +GammaLib dependency: 00-04-05 | |
| 3 | 6 | |
| 4 | 7 | |
| 5 | 8 | License information |
| 6 | -------------------- | |
| 7 | - | |
| 8 | -To be writted ... | |
| 9 | +=================== | |
| 10 | +To be written ... | |
| 9 | 11 | |
| 10 | 12 | |
| 11 | 13 | What's new in this release? |
| 12 | ---------------------------- | |
| 14 | +=========================== | |
| 15 | +See the files "NEWS" and "ChangeLog". | |
| 13 | 16 | |
| 14 | -See the file "NEWS". | |
| 15 | 17 | |
| 18 | +What are the ctatools anyway? | |
| 19 | +============================= | |
| 20 | +ctatools are ftools-like executable for the scientific analysis of | |
| 21 | +CTA observations. They are based on GammaLib, a vesatile toolbox | |
| 22 | +for the high-level analysis of astronomical gamma-ray data. | |
| 16 | 23 | |
| 17 | -What is the GammaLib anyway? | |
| 18 | ----------------------------- | |
| 24 | +The following tools are so far available: | |
| 19 | 25 | |
| 20 | -The GammaLib is a vesatile toolbox for the high-level analysis of | |
| 21 | -astronomical gamma-ray data. It is implemented as a C++ library | |
| 22 | -that is fully scriptable in the Python scripting language. The library | |
| 23 | -provides core functionalities such as data input and output, interfaces | |
| 24 | -for parameter specifications, and a reporting and logging interface. | |
| 25 | -It implements instruments specific functionalities such as instrument | |
| 26 | -response functions and data formats. Instrument specific functionalities | |
| 27 | -share a common interface to allow for extension of the GammaLib to | |
| 28 | -include new gamma-ray instruments. The GammaLib provides an abstract | |
| 29 | -data analysis framework that enables simultaneous multi-mission analysis. | |
| 26 | + ctobssim - simulation of CTA observations | |
| 27 | + ctselect - event selection | |
| 28 | + ctbin - event binning | |
| 29 | + ctlike - maximum likelihood model fitting | |
| 30 | 30 | |
| 31 | 31 | |
| 32 | 32 | Web sites |
| 33 | ---------- | |
| 33 | +========= | |
| 34 | +http://gammalib.sourceforge.net - for GammaLib documentation | |
| 35 | +https://sourceforge.net/projects/gammalib/ - for GammaLib downloads | |
| 36 | + | |
| 37 | + | |
| 38 | +Prerequisites | |
| 39 | +============= | |
| 40 | +ctatools require GammaLib. Please refer to http://gammalib.sourceforge.net | |
| 41 | +for instructions about how to install GammaLib. The GammaLib code can | |
| 42 | +be downloaded from https://sourceforge.net/projects/gammalib/. | |
| 43 | + | |
| 44 | +Once GammaLib is properly installed, make sure that the environment | |
| 45 | +variables are set correctly: | |
| 46 | + | |
| 47 | + export PYTHONPATH=/usr/local/gamma/lib/python2.5/site-packages:$PYTHONPATH export LD_LIBRARY_PATH=/usr/local/gamma/lib:$LD_LIBRARY_PATH export PKG_CONFIG_PATH=/usr/local/gamma/lib/pkgconfig:$PKG_CONFIG_PATH | |
| 48 | + | |
| 49 | +This is needed as GammaLib is installed by default in /usr/local/gamma and | |
| 50 | +not in /usr/local (this may be reconsidered eventually). | |
| 51 | + | |
| 52 | + | |
| 53 | +Unix Installation | |
| 54 | +================= | |
| 55 | +To build and install ctatools, simply type the following: | |
| 56 | + | |
| 57 | + % ./configure | |
| 58 | + % make | |
| 59 | + % make install | |
| 60 | + | |
| 61 | +By default ctatools installs itself in /usr/local/gamma. If you need to | |
| 62 | +install ctatools in a different location or in your home directory, use | |
| 63 | +the --prefix option to ./configure. For example: | |
| 64 | + | |
| 65 | + % ./configure --prefix=/home/yourname/projects | |
| 66 | + % make | |
| 67 | + % make install | |
| 34 | 68 | |
| 35 | -http://gammalib.sourceforge.net | |
| 69 | +The file INSTALL details more about using configure. Also try | |
| 70 | + | |
| 71 | + % ./configure --help. | |
| 72 | + | |
| 73 | + | |
| 74 | +Macintosh OS X Installation | |
| 75 | +============================ | |
| 76 | +ctatools are known to work on various flavors of OS X. Follow the Unix | |
| 77 | +installation instructions above. | |
| 78 | + | |
| 79 | + | |
| 80 | +Solaris Installation | |
| 81 | +==================== | |
| 82 | +ctatools compile on Solairs, but there is an issue with using it as a | |
| 83 | +shared library (see "Known problems" below). | |
| 84 | + | |
| 85 | + | |
| 86 | +Getting started | |
| 87 | +=============== | |
| 88 | +To be written ... | |
| 89 | + | |
| 90 | + | |
| 91 | +Documentation | |
| 92 | +============= | |
| 93 | +To be written ... | |
| 36 | 94 | |
| 37 | 95 | |
| 38 | 96 | Bug reports |
| 39 | ------------ | |
| 97 | +=========== | |
| 98 | +To be written ... | |
| 40 | 99 | |
| 41 | -To report or search for bugs, please use the GammaLib Bug Tracker at | |
| 42 | -https://sourceforge.net/tracker/?group_id=282143&atid=1196795. | |
| 43 | 100 | |
| 101 | +Known problems | |
| 102 | +============== | |
| 103 | +Solaris | |
| 104 | + Although ctatools compile on Solaris using the Sun compiler, there are | |
| 105 | + problems with global symbols in the shared GammaLib library that prevent | |
| 106 | + the model registry to work correctly. Furthermore, GammaLib is not able | |
| 107 | + to catch its own exceptions, which prevents the FITS interface to work | |
| 108 | + correctly. If GammaLib is linked statically | |
| 44 | 109 | |
| 45 | -Contact | |
| 46 | -------- | |
| 47 | 110 | |
| 48 | -To get in touch with the GammaLib developers and to contribute to the | |
| 111 | +Contact | |
| 112 | +======= | |
| 113 | +To get in touch with the ctatools developers and to contribute to the | |
| 49 | 114 | project please contact Juergen Knoedlseder <knodlseder@cesr.fr>. | ... | ... |