Commit 8368864d2d46df84b9c71bc83fad12fcb943dae1
1 parent
363d3700
Update release documentation.
Showing
4 changed files
with
32 additions
and
12 deletions
ChangeLog
NEWS
README
| 1 | 1 | ctools information |
| 2 | 2 | ================== |
| 3 | -Version: 00-07-00 (November 29th, 2013) | |
| 3 | +Version: 00-07-00 (18 January 2014) | |
| 4 | 4 | Author: Juergen Knodlseder (jurgen.knodlseder@irap.omp.eu) |
| 5 | 5 | GammaLib dependency: 00-08-00 |
| 6 | 6 | |
| ... | ... | @@ -29,10 +29,10 @@ See the files "NEWS" and "ChangeLog". |
| 29 | 29 | What are the ctools anyway? |
| 30 | 30 | =========================== |
| 31 | 31 | ctools are ftools-like executable for the scientific analysis of |
| 32 | -CTA observations. They are based on GammaLib, a versatile toolbox | |
| 32 | +CTA observations. They are based on GammaLib, a versatile toolbox | |
| 33 | 33 | for the high-level analysis of astronomical gamma-ray data. |
| 34 | 34 | |
| 35 | -The following tools are so far available: | |
| 35 | +The following tools are available: | |
| 36 | 36 | |
| 37 | 37 | ctbin - event binning |
| 38 | 38 | ctlike - maximum likelihood model fitting |
| ... | ... | @@ -49,10 +49,11 @@ https://cta-redmine.irap.omp.eu/projects/ctools - for ctools development |
| 49 | 49 | http://gammalib.sourceforge.net - for GammaLib documentation |
| 50 | 50 | https://sourceforge.net/projects/gammalib/ - for GammaLib downloads |
| 51 | 51 | |
| 52 | + | |
| 52 | 53 | Prerequisites |
| 53 | 54 | ============= |
| 54 | -ctools require GammaLib. Please refer to http://gammalib.sourceforge.net | |
| 55 | -for instructions about how to install GammaLib. The GammaLib code can | |
| 55 | +ctools require GammaLib. Please refer to http://gammalib.sourceforge.net | |
| 56 | +for instructions about how to install GammaLib. The GammaLib code can | |
| 56 | 57 | be downloaded from https://sourceforge.net/projects/gammalib/. |
| 57 | 58 | |
| 58 | 59 | Once GammaLib is properly installed, make sure that you added the setup |
| ... | ... | @@ -164,12 +165,31 @@ To be written ... |
| 164 | 165 | |
| 165 | 166 | Documentation |
| 166 | 167 | ============= |
| 167 | -To be written ... | |
| 168 | +The doc directory (usually at /usr/local/gamma/share/doc/ctools) | |
| 169 | +contains the most recent set of updated documentation for this release. | |
| 170 | +A detailed documentation can be created by typing: | |
| 171 | + | |
| 172 | + % make doc | |
| 173 | + | |
| 174 | +before installing the library. Two types of documentation exist: | |
| 175 | +* code documentation | |
| 176 | +* user documentation | |
| 177 | + | |
| 178 | +Code documentation is created using Doxygen. You need Doxygen on your | |
| 179 | +system to generate the code documentation. This includes man pages. | |
| 180 | +Doxygen can be obtained from http://www.stack.nl/~dimitri/doxygen/. | |
| 181 | + | |
| 182 | +User documentation is created using Sphinx. You need Sphinx on your | |
| 183 | +system to generate the user documentation. Sphinx can be obtained | |
| 184 | +from http://sphinx-doc.org/install.html. | |
| 168 | 185 | |
| 169 | 186 | |
| 170 | 187 | Bug reports |
| 171 | 188 | =========== |
| 172 | -To be written ... | |
| 189 | +To report or search for bugs, please use the ctools Bug Tracker at | |
| 190 | +https://cta-redmine.irap.omp.eu/projects/ctools. Before using the | |
| 191 | +tracker, please read | |
| 192 | +https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Submission_guidelines | |
| 173 | 193 | |
| 174 | 194 | |
| 175 | 195 | Known problems |
| ... | ... | @@ -177,9 +197,9 @@ Known problems |
| 177 | 197 | Solaris |
| 178 | 198 | Although ctools compile on Solaris using the Sun compiler, there are |
| 179 | 199 | problems with global symbols in the shared GammaLib library that prevent |
| 180 | - the model registry to work correctly. Furthermore, GammaLib is not able | |
| 200 | + the model registry to work correctly. Furthermore, GammaLib is not able | |
| 181 | 201 | to catch its own exceptions, which prevents the FITS interface to work |
| 182 | - correctly. Possible it will work using gcc on Solaris, yet this has not | |
| 202 | + correctly. Possible it will work using gcc on Solaris, yet this has not | |
| 183 | 203 | so far been tested. |
| 184 | 204 | |
| 185 | 205 | ... | ... |
configure.ac
| ... | ... | @@ -2,7 +2,7 @@ |
| 2 | 2 | # Configuration for ctools - a set of tools for science analysis of CTA # |
| 3 | 3 | # data # |
| 4 | 4 | # ------------------------------------------------------------------------- # |
| 5 | -# Copyright (C) 2011-2013 Juergen Knoedlseder # | |
| 5 | +# Copyright (C) 2011-2014 Juergen Knoedlseder # | |
| 6 | 6 | # ------------------------------------------------------------------------- # |
| 7 | 7 | # # |
| 8 | 8 | # This program is free software: you can redistribute it and/or modify # | ... | ... |