Commit 7ea90070870612e20a7d275b9e10e89a9139df8c

Authored by knodlseder
1 parent 4910a009

updated for gammalib-00-04-10

ChangeLog
1 -2011-07-14 Juergen Knoedlseder <knodlseder@cesr.fr> 1 +2011-07-20 Juergen Knoedlseder <knodlseder@cesr.fr>
2 2
3 * Version 0.4.10 released 3 * Version 0.4.10 released
4 ========================= 4 =========================
1 -New Features and Important Changes in GammaLib 00-04-09 1 +New Features and Important Changes in GammaLib 00-04-10
2 2
3 Author(s) : Juergen Knoedlseder 3 Author(s) : Juergen Knoedlseder
4 4
5 -July 9th, 2011 5 +July 20, 2011
6 6
7 7
8 1. Introduction 8 1. Introduction
@@ -12,15 +12,22 @@ This document briefly summarizes module by module the most important changes mad @@ -12,15 +12,22 @@ This document briefly summarizes module by module the most important changes mad
12 12
13 2. Configuration 13 2. Configuration
14 ----------------- 14 -----------------
15 -Remove pkg-config usage from configure.ac as this introduced somas  
16 -on Mac OS X systems (by default there is no pkg-config on Mac OS X). 15 +The configuration script aborts now if no C++ compiler is found.
17 16
18 -Add --enable-nan-check option and add option configuration information  
19 -to configuration summary screen dump. 17 +pkg-config was reintroduced for finding the cfitsio library, but
  18 +it's only used if pkg-config is available. This may help to
  19 +increase the portability to various platforms, although problems
  20 +with incorrect pkg-config files have been encountered on some
  21 +distributions (OpenSUSE).
20 22
21 -Test for presence of Python.h and build Python binding only if the  
22 -file exists. This should resolve installation issues on systems that  
23 -do not have the Python development package installed. 23 +The configuration script now also handles fitsio.h headers found in
  24 +specific subdirectory (which is needed to compile on OpenSUSE and
  25 +Scientific Linux).
  26 +
  27 +Set the installation directory as the default runtime library
  28 +directory for Python. This solves a `make check' problem that occurred
  29 +on some distributions because it could not find the cfitsio
  30 +library that was installed in that location.
24 31
25 32
26 3. Application module 33 3. Application module
@@ -40,17 +47,17 @@ None @@ -40,17 +47,17 @@ None
40 47
41 6. Model module 48 6. Model module
42 --------------- 49 ---------------
43 -Add NaN/Inf check to various spatial and spectral models. 50 +None
44 51
45 52
46 7. Numerics module 53 7. Numerics module
47 ------------------ 54 ------------------
48 -Add NaN/Inf check to GIntegral class. 55 +None
49 56
50 57
51 8. Observation module 58 8. Observation module
52 --------------------- 59 ---------------------
53 -Add NaN/Inf check to GResponse and GObservation class. 60 +None
54 61
55 62
56 9. Optimization module 63 9. Optimization module
@@ -60,20 +67,7 @@ None @@ -60,20 +67,7 @@ None
60 67
61 10. Sky module 68 10. Sky module
62 -------------- 69 --------------
63 -Replaced the IDL based World Coordinate System code by wcslib based code.  
64 -This improves performance and accuracy of the coordinate transformation  
65 -and corrects a bug in the LONPOLE/LATPOLE keywords that were written in  
66 -the earlier version into the FITS file.  
67 -  
68 -Introduced GWcslib base class for projections that are wcslib based.  
69 -All code adapted from wcslib goes into that class. Not all functionality  
70 -has yet been ported from wcslib to GammaLib, but the essential things  
71 -for creating, writing and reading WCS compliant FITS files is there.  
72 -  
73 -Introduced a World Coordinate System registry for easy extension of the  
74 -set of projections.  
75 -  
76 -Added the following projection types: AZP, STG, TAN 70 +Use now GWcsRegistry for alloc_wcs().
77 71
78 72
79 11. Support module 73 11. Support module
@@ -98,10 +92,4 @@ None @@ -98,10 +92,4 @@ None
98 92
99 15. CTA interface 93 15. CTA interface
100 ----------------- 94 -----------------
101 -Added a simple offset angle dependence to the CTA response. The effective  
102 -area is assumed to vary following exp(-0.5*theta^4/sigma^2), where theta  
103 -is the offset angle of the photon arrival direction in the camera system  
104 -and sigma is a parameter that is set by default to 3.0 deg^2. No energy  
105 -dependence has been assumed in the offset angle variation.  
106 -  
107 -Add NaN/Inf check to various classes. 95 +None
1 GammaLib information 1 GammaLib information
2 ==================== 2 ====================
3 -Version: 00-04-09 (July 8, 2011) 3 +Version: 00-04-10 (July 20, 2011)
4 Author: Juergen Knodlseder (knodlseder@cesr.fr) 4 Author: Juergen Knodlseder (knodlseder@cesr.fr)
5 5
6 6
@@ -64,16 +64,17 @@ directory as a shared library by typing: @@ -64,16 +64,17 @@ directory as a shared library by typing:
64 GammaLib can also benefit from the presence of the readline library 64 GammaLib can also benefit from the presence of the readline library
65 that provides line-editing and history capabilities for text input 65 that provides line-editing and history capabilities for text input
66 (GammaLib offers however also full functionality without having 66 (GammaLib offers however also full functionality without having
67 -readline installed). readline can be downloaded from  
68 -http://ftp.gnu.org/gnu/readline/ 67 +readline installed). readline requires the ncurses library. Both
  68 +libraries can be downloaded from http://ftp.gnu.org/gnu/.
69 69
70 70
71 -Unix Installation  
72 -=================  
73 -To build and install GammaLib, simply type the following: 71 +Linux Installation
  72 +==================
  73 +To build, verify and install GammaLib, simply type the following:
74 74
75 % ./configure 75 % ./configure
76 % make 76 % make
  77 + % make check
77 % make install 78 % make install
78 79
79 By default GammaLib installs itself in /usr/local/gamma. If you need to 80 By default GammaLib installs itself in /usr/local/gamma. If you need to
@@ -82,31 +83,61 @@ the --prefix option to ./configure. For example: @@ -82,31 +83,61 @@ the --prefix option to ./configure. For example:
82 83
83 % ./configure --prefix=/home/yourname/projects 84 % ./configure --prefix=/home/yourname/projects
84 % make 85 % make
  86 + % make check
85 % make install 87 % make install
86 88
87 The file INSTALL details more about using configure. Also try 89 The file INSTALL details more about using configure. Also try
88 90
89 % ./configure --help. 91 % ./configure --help.
90 92
  93 +The `make check' command will run an extensive unit test to verify that
  94 +GammaLib was correctly built. Make sure that all tests were successful.
  95 +
91 96
92 Macintosh OS X Installation 97 Macintosh OS X Installation
93 ============================ 98 ============================
94 -GammaLib is known to work on various flavors of OS X. Follow the Unix 99 +GammaLib is known to work on various flavors of OS X. Follow the
  100 +Linux installation instructions above.
  101 +
  102 +
  103 +BSD Installation
  104 +================
  105 +GammaLib has been tested on FreeBSD successfully. Follow the Linux
95 installation instructions above. 106 installation instructions above.
96 107
97 108
98 Solaris Installation 109 Solaris Installation
99 ==================== 110 ====================
100 -GammaLib compiles on Solairs, but there is an issue with using it as a  
101 -shared library (see "Known problems" below). 111 +GammaLib compiles on Solaris and openSolaris using the GNU compiler
  112 +collection. Follow the Linux installation instructions above.
  113 +GammaLib also compiles using the Sun Studio compiler, but due to
  114 +some unexpected handling of global variables, it is not fully
  115 +working (see "Known problems" below).
  116 +Please note that these is also a cfitsio problem on Solaris, please
  117 +refer to the section "Known problems" for more information.
  118 +
  119 +
  120 +Window Installation
  121 +===================
  122 +There have been no efforts so far to compile GammaLib under Windows.
102 123
103 124
104 Testing 125 Testing
105 ======= 126 =======
106 -If you want to test GammaLib before installation, type the following: 127 +After building and before installing GammaLib, you should run the
  128 +extensive unit test by typing:
107 129
108 % make check 130 % make check
109 131
  132 +If everything works successfully you should see
  133 +
  134 + ===================
  135 + All 14 tests passed
  136 + ===================
  137 +
  138 +at the end of the test. If no Python support was compiled in, the
  139 +number of tests performed will be reduced by one.
  140 +
110 141
111 Setting up your environment 142 Setting up your environment
112 =========================== 143 ===========================
@@ -151,11 +182,17 @@ and inst/cat/test. @@ -151,11 +182,17 @@ and inst/cat/test.
151 182
152 Documentation 183 Documentation
153 ============= 184 =============
154 -The doc directory contains the most recent set of updated documentation  
155 -for this release. The documentation is available in PDF format. 185 +The doc directory (usually at /usr/local/gamma/share/doc/gammalib)
  186 +contains the most recent set of updated documentation for this release.
  187 +A detailed documentation can be created using Doxygen by typing:
  188 +
  189 + % make doxygen
  190 +
  191 +before installing the library. Doxygen can be obtained from
  192 +http://www.stack.nl/~dimitri/doxygen/
156 193
157 This is a development release and the documentation is largely, but 194 This is a development release and the documentation is largely, but
158 -not entirely up to date. We are working on it. Please be patient or 195 +not entirely up to date. We are working on it. Please be patient or
159 volunteer to help. 196 volunteer to help.
160 197
161 198
@@ -167,13 +204,69 @@ https://sourceforge.net/tracker/?group_id=282143&amp;atid=1196795. @@ -167,13 +204,69 @@ https://sourceforge.net/tracker/?group_id=282143&amp;atid=1196795.
167 204
168 Known problems 205 Known problems
169 ============== 206 ==============
  207 +Python support
  208 + GammaLib comes with Python wrappers so that all classes can be
  209 + directly used from Python. To compile-in Python support, GammaLib
  210 + needs the Python.h header file, which on many distributions is not
  211 + installed by default.
  212 + To make Python.h available, install the Python developer package
  213 + in your distribution. Otherwise you will not be able to use GammaLib
  214 + from Python.
  215 +
  216 +Readline support
  217 + Many distributions do not have the readline header files and symbolic
  218 + link to the shared library set up by default. The same is true for the
  219 + ncurses library that is needed by readline. To properly compile-in
  220 + readline support in GammaLib, make sure that the redline header files
  221 + exist and that the symbolic links are set. In many distributions,
  222 + the shared redline and ncurses are located in /lib, while the symbolic
  223 + links are in /usr/lib. Make sure that you have symbolic links with
  224 + names
  225 +
  226 + libreadline.so
  227 + libncurses.so
  228 +
  229 + Symbolic links with an additional number attached, such as
  230 + libreadline.so.6 or libncurses.so.5 (which are found in many
  231 + distributions in the /lib directory) are not sufficient.
  232 + In many distributions, the appropriate headers and symbolic links
  233 + are installed if the proper readline and ncurses developer
  234 + packages are installed.
  235 +
170 Solaris 236 Solaris
171 - Although GammaLib compiles on Solaris using the Sun compiler, there are 237 + Although GammaLib builds on Solaris using the Sun compiler, there are
172 problems with global symbols in the shared library that prevent the 238 problems with global symbols in the shared library that prevent the
173 model registry to work correctly. Furthermore, GammaLib is not able 239 model registry to work correctly. Furthermore, GammaLib is not able
174 to catch its own exceptions, which prevents the FITS interface to work 240 to catch its own exceptions, which prevents the FITS interface to work
175 - correctly. Possible it will work using gcc on Solaris, yet this has not  
176 - so far been tested. 241 + correctly.
  242 + GammaLib has however been built and tested successfully using the GNU
  243 + compiler, and this is the only build method that is currently supported.
  244 + Problems have also been encountered when compiling cfitsio versions
  245 + more recent than 3.250. The problems have been reported to the cfitsio
  246 + developer team, and are likely to be solved in the future. For the
  247 + time being, it is recommended to use cfitsio version 3.250 on Solaris.
  248 +
  249 +OpenSolaris
  250 + On OpenSolaris, the same problems concerning the SunStudio compiler
  251 + occur as for Solaris, and also here, the GNU compiler is the recommended
  252 + tool to build GammaLib. Also here, cfitsio version 3.250 is the
  253 + recommended library as more recent version feature relocation
  254 + problems. GammaLib has been tested using gcc 4.3.2 on
  255 + OpenSolaris 2009.06. Make sure to create the symbolic links
  256 +
  257 + ln -s /usr/bin/gcc4.3.2 /usr/bin/gcc
  258 + ln -s /usr/bin/g++4.3.2 /usr/bin/g++
  259 +
  260 + which are not there by default to avoid excess warnings during
  261 + compilation.
  262 + For OpenSolaris 2009.06, no readline package is available, hence
  263 + readline support is not readily available. Readline support can however
  264 + be enabled by directly installing the GNU ncurses and readline packages
  265 + from source (http://ftp.gnu.org/gnu). This has been done successfully
  266 + on OpenSolaris 2009.06 for ncurses-5.9 and readline-6.2. Make sure
  267 + to specify the `--with-shared' option when configuring ncurses, so
  268 + that the shared library will be built and installed. Otherwise,
  269 + relocation errors may occur during compilation of GammaLib.
177 270
178 271
179 Contact 272 Contact
doc/html/about.html
@@ -4,7 +4,6 @@ @@ -4,7 +4,6 @@
4 4
5 <link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css"> 5 <link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css">
6 </head> 6 </head>
7 -  
8 <body> 7 <body>
9 <p class="Header">About</p> 8 <p class="Header">About</p>
10 <p style="padding-top: 0pt; text-align: left;" class="Body"> 9 <p style="padding-top: 0pt; text-align: left;" class="Body">
@@ -22,9 +21,9 @@ data analysis framework that enables simultaneous multi-mission @@ -22,9 +21,9 @@ data analysis framework that enables simultaneous multi-mission
22 analysis.</p> 21 analysis.</p>
23 <br> 22 <br>
24 <p style="padding-top: 0pt; text-align: left;" class="Body">The 23 <p style="padding-top: 0pt; text-align: left;" class="Body">The
25 -GammaLib project has been initiated by J. Knรถdlseder from the  
26 -Insitut de Recherche en Astrophysique et Planรฉtologie  
27 -(IRAP), a mixed CNRS / Universitรฉ Paul Sabatier laboratory 24 +GammaLib project has been initiated by J. Kn&ouml;dlseder from the
  25 +Insitut de Recherche en Astrophysique et Plan&eacute;tologie
  26 +(IRAP), a mixed CNRS / Universit&eacute; Paul Sabatier laboratory
28 in Toulouse, France.</p> 27 in Toulouse, France.</p>
29 <br> 28 <br>
30 <p style="padding-top: 0pt; text-align: left;" class="Body">As 29 <p style="padding-top: 0pt; text-align: left;" class="Body">As
@@ -57,4 +56,9 @@ Source Lines of Code (SLOC)&lt;/td&gt; @@ -57,4 +56,9 @@ Source Lines of Code (SLOC)&lt;/td&gt;
57 </tbody> 56 </tbody>
58 </table> 57 </table>
59 <br> 58 <br>
  59 +<hr size="1">
  60 +<p class="Body">Last updated by: J&uuml;rgen
  61 +Kn&ouml;dlseder 20 July
  62 +2011
  63 +</p>
60 </body></html> 64 </body></html>
61 \ No newline at end of file 65 \ No newline at end of file
doc/html/documentation.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 -<html>  
3 -<head> 2 +<html><head>
  3 +<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>Documentation</title>
4 4
5 -  
6 -  
7 - <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">  
8 -  
9 -  
10 -  
11 -  
12 -  
13 - <title>Documentation</title>  
14 - <link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css"> 5 +<link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css">
15 </head> 6 </head>
16 7
17 -  
18 <body> 8 <body>
19 -  
20 -  
21 <p class="Header">Documentation</p> 9 <p class="Header">Documentation</p>
22 -  
23 -  
24 -<p style="padding-top: 0pt; text-align: left;" class="Body"><a href="doxygen/index.html">GammaLib code documentation (generated by Doxygen)</a> 10 +<p style="padding-top: 0pt; text-align: left;" class="Body"><a href="doxygen/index.html">GammaLib code documentation
  11 +(generated by Doxygen)</a>
25 </p> 12 </p>
26 -  
27 -  
28 -<br>  
29 -  
30 -  
31 <br> 13 <br>
32 -  
33 -  
34 -</body>  
35 -</html> 14 +<hr size="1">
  15 +<p class="Body">Last updated by: J&uuml;rgen
  16 +Kn&ouml;dlseder 20 July
  17 +2011
  18 +</p>
  19 +</body></html>
36 \ No newline at end of file 20 \ No newline at end of file
doc/html/doxygen.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 -<html>  
3 -<head>  
4 -  
5 - <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">  
6 - <title>Doxygen</title>  
7 -  
8 -  
9 - <link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css">  
10 -  
11 - <meta content="Jurgen Knodlseder" name="author">  
12 -  
13 - <meta content="No Doxygen installed page" name="description">  
14 -  
15 - <meta http-equiv="Refresh" content="30"> 2 +<html><head>
  3 +<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>Doxygen</title>
16 4
  5 +<link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css">
  6 +<meta content="Jurgen Knodlseder" name="author">
  7 +<meta content="No Doxygen installed page" name="description">
  8 +<meta http-equiv="Refresh" content="30">
17 </head> 9 </head>
18 10
19 -  
20 <body> 11 <body>
21 -  
22 <p class="Header">Doxygen</p> 12 <p class="Header">Doxygen</p>
23 -  
24 <p style="padding-top: 0pt; text-align: left;" class="Body">There 13 <p style="padding-top: 0pt; text-align: left;" class="Body">There
25 seems to be no Doxygen documentation installed for GammaLib. 14 seems to be no Doxygen documentation installed for GammaLib.
26 </p> 15 </p>
27 -  
28 <br> 16 <br>
29 -  
30 <p style="padding-top: 0pt; text-align: left;" class="Body">To 17 <p style="padding-top: 0pt; text-align: left;" class="Body">To
31 install Doxygen documentation, make sure that <a href="http://www.stack.nl/%7Edimitri/doxygen/" target="_blank">Doxygen</a> 18 install Doxygen documentation, make sure that <a href="http://www.stack.nl/%7Edimitri/doxygen/" target="_blank">Doxygen</a>
32 is installed on your system. If installed, then type the following in 19 is installed on your system. If installed, then type the following in
33 the GammaLib source directory: 20 the GammaLib source directory:
34 </p> 21 </p>
35 -  
36 <p class="Code">&gt; ./configure<br> 22 <p class="Code">&gt; ./configure<br>
37 -  
38 &gt; make doxygen<br> 23 &gt; make doxygen<br>
39 -  
40 &gt; make doxygen-install 24 &gt; make doxygen-install
41 </p> 25 </p>
42 -  
43 <p style="padding-top: 0pt; text-align: left;" class="Body"> 26 <p style="padding-top: 0pt; text-align: left;" class="Body">
44 Now the Doxygen documentation should be installed on your system. To 27 Now the Doxygen documentation should be installed on your system. To
45 -verify if this is indeed the case, simply reload this page (or wait for 30 seconds). 28 +verify if this is indeed the case, simply reload this page (or wait for
  29 +30 seconds).
46 </p> 30 </p>
47 -  
48 -<br>  
49 -  
50 <br> 31 <br>
51 -  
52 -</body>  
53 -</html> 32 +<hr size="1">
  33 +<p class="Body">Last updated by: J&uuml;rgen
  34 +Kn&ouml;dlseder 20 July
  35 +2011
  36 +</p>
  37 +</body></html>
54 \ No newline at end of file 38 \ No newline at end of file
doc/html/home.html
@@ -2,7 +2,8 @@ @@ -2,7 +2,8 @@
2 <html><head> 2 <html><head>
3 <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>Home</title> 3 <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>Home</title>
4 4
5 -<link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css"></head> 5 +<link rel="stylesheet" type="text/css" media="screen,print" href="gammalib.css">
  6 +</head>
6 <body> 7 <body>
7 <p class="Header">GammaLib</p> 8 <p class="Header">GammaLib</p>
8 <p style="padding-top: 0pt; text-align: left;" class="Body"> 9 <p style="padding-top: 0pt; text-align: left;" class="Body">
@@ -20,9 +21,14 @@ data analysis framework that enables simultaneous multi-mission @@ -20,9 +21,14 @@ data analysis framework that enables simultaneous multi-mission
20 analysis.</p> 21 analysis.</p>
21 <br> 22 <br>
22 <p style="padding-top: 0pt; text-align: left;" class="Body">GammaLib 23 <p style="padding-top: 0pt; text-align: left;" class="Body">GammaLib
23 -is free software distributed under the <a href="http://www.gnu.org/licenses/gpl.html" target="_blank">GNU GPL 24 +is free software distributed under the <a href="http://www.gnu.org/licenses/gpl.html" target="_blank">GNU
  25 +GPL
24 license version 3</a>. 26 license version 3</a>.
25 </p> 27 </p>
26 <br> 28 <br>
27 -<br> 29 +<hr size="1">
  30 +<p class="Body">Last updated by: J&uuml;rgen
  31 +Kn&ouml;dlseder 20 July
  32 +2011
  33 +</p>
28 </body></html> 34 </body></html>
29 \ No newline at end of file 35 \ No newline at end of file
doc/html/installation.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 -<html>  
3 -<head>  
4 -  
5 - <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">  
6 - <title>Installation</title>  
7 -  
8 -  
9 - <link href="gammalib.css" media="screen,print" type="text/css" rel="stylesheet"> 2 +<html><head>
  3 +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"><title>Installation</title>
10 4
  5 +<link href="gammalib.css" media="screen,print" type="text/css" rel="stylesheet">
11 </head> 6 </head>
12 7
13 -  
14 <body> 8 <body>
15 -  
16 <p class="Header">Installation</p> 9 <p class="Header">Installation</p>
17 -  
18 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Getting_GammaLib"> 10 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Getting_GammaLib">
19 Getting GammaLib 11 Getting GammaLib
20 </a><br> 12 </a><br>
21 -  
22 </p> 13 </p>
23 -  
24 <p style="padding-top: 0pt; text-align: left;" class="Body"> 14 <p style="padding-top: 0pt; text-align: left;" class="Body">
25 <a href="#Prerequisites">Prerequisites</a></p> 15 <a href="#Prerequisites">Prerequisites</a></p>
26 -  
27 <p style="padding-top: 0pt; text-align: left;" class="Body"> 16 <p style="padding-top: 0pt; text-align: left;" class="Body">
28 <a href="#Building_GammaLib">Building GammaLib</a></p> 17 <a href="#Building_GammaLib">Building GammaLib</a></p>
29 -  
30 <p style="padding-top: 0pt; text-align: left;" class="Body"> 18 <p style="padding-top: 0pt; text-align: left;" class="Body">
31 <a href="#Testing_GammaLib">Testing GammaLib</a></p> 19 <a href="#Testing_GammaLib">Testing GammaLib</a></p>
32 -  
33 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Installing_GammaLib">Installing GammaLib</a></p> 20 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Installing_GammaLib">Installing GammaLib</a></p>
34 -  
35 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Setting_up_your_environment">Setting up your 21 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Setting_up_your_environment">Setting up your
36 environment</a></p> 22 environment</a></p>
37 -  
38 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Installing_documentation">Installing documentation</a></p> 23 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#Installing_documentation">Installing documentation</a></p>
39 -  
40 <p style="padding-top: 0pt; text-align: left;" class="Body"> 24 <p style="padding-top: 0pt; text-align: left;" class="Body">
41 <a href="#Known_Problems">Known Problems</a></p> 25 <a href="#Known_Problems">Known Problems</a></p>
42 -  
43 <p style="padding-top: 0pt; text-align: left;" class="Body"> 26 <p style="padding-top: 0pt; text-align: left;" class="Body">
44 <a href="#Getting_Help">Getting Help</a></p> 27 <a href="#Getting_Help">Getting Help</a></p>
45 -  
46 <br> 28 <br>
47 -  
48 <p style="padding-top: 0pt; text-align: left;" class="Body"><span style="font-weight: bold;"> 29 <p style="padding-top: 0pt; text-align: left;" class="Body"><span style="font-weight: bold;">
49 -Note:</span> These installation instructions apply to  
50 -GammaLib-00-04-06 and  
51 -later. 30 +Note:</span> These installation instructions apply to <span style="font-family: Courier New,Courier,monospace;">gammalib-00-04-10</span>
  31 +and
  32 +later.&nbsp;<span style="font-family: Courier New,Courier,monospace;">gammalib-00-04-10</span>
  33 +has been built, installed and tested successfully&nbsp;on Debian,
  34 +Ubuntu,
  35 +Mandriva, OpenSUSE, Scientific Linux, CentOS, gentoo, Mac OS X,
  36 +FreeBSD, and OpenSolaris (using gcc), so hopefully it also installs on
  37 +your distribution. In case you encounter problems, please post a report
  38 +on the bug tracker on <a href="https://sourceforge.net/projects/gammalib/" target="_blank">https://sourceforge.net/projects/gammalib/</a>
  39 +or send an e-mail to the
  40 +<a href="mailto:gammalib-users@lists.soureforge.net">gammalib-users@lists.sourceforge.net</a>
  41 +mailing list.
52 </p> 42 </p>
53 -  
54 <br> 43 <br>
55 -  
56 <br> 44 <br>
57 -  
58 <p class="Title"><a name="Getting_GammaLib"></a>Getting 45 <p class="Title"><a name="Getting_GammaLib"></a>Getting
59 GammaLib</p> 46 GammaLib</p>
60 -  
61 <p style="padding-top: 0pt; text-align: left;" class="Body"> 47 <p style="padding-top: 0pt; text-align: left;" class="Body">
62 The latest version of the GammaLib source code, documentation, and 48 The latest version of the GammaLib source code, documentation, and
63 example programs are available on the World-Wide Web from <a href="https://sourceforge.net/projects/gammalib/" target="_blank">https://sourceforge.net/projects/gammalib/</a>. 49 example programs are available on the World-Wide Web from <a href="https://sourceforge.net/projects/gammalib/" target="_blank">https://sourceforge.net/projects/gammalib/</a>.
64 </p> 50 </p>
65 -  
66 <br> 51 <br>
67 -  
68 <br> 52 <br>
69 -  
70 <p class="Title"><a name="Prerequisites"></a>Prerequisites</p> 53 <p class="Title"><a name="Prerequisites"></a>Prerequisites</p>
71 -  
72 <p style="padding-top: 0pt; text-align: left;" class="Body"> 54 <p style="padding-top: 0pt; text-align: left;" class="Body">
73 -GammaLib should compile on every modern Unix system <span style="font-weight: bold;">without any need to  
74 -install other libraries</span>. 55 +GammaLib should compile on every modern Unix system without any need to
  56 +install other libraries. To enable support for FITS file handling,
  57 +however, <span style="font-weight: bold;">the cfitsio
  58 +library
  59 +from HEASARC needs to be installed</span>. cfitsio
  60 +exists on many distributions as a prebuilt library, so in general you
  61 +can
  62 +directly install it using your package manager. Make sure that you
  63 +install the library and the development package, as the cfitsio header
  64 +file (which usually comes in the development package) is needed to
  65 +compiling GammaLib.</p>
75 <br> 66 <br>
76 -  
77 -<br>  
78 -  
79 -To enable support for FITS file handling, however, the cfitsio library  
80 -from HEASARC needs to be installed. cfitsio can be downloaded from 67 +<p style="padding-top: 0pt; text-align: left;" class="Body">If
  68 +cfitsio is not available as a prebuilt package, or if you encounter
  69 +some
  70 +problems with the prebuilt package, cfitsio can be downloaded from
81 <a href="http://heasarc.gsfc.nasa.gov/fitsio" target="_blank">http://heasarc.gsfc.nasa.gov/fitsio</a> 71 <a href="http://heasarc.gsfc.nasa.gov/fitsio" target="_blank">http://heasarc.gsfc.nasa.gov/fitsio</a>
82 -and detailed installation instructions can be found there.  
83 -If cfitsio does not already exist on your system, we recommend  
84 -installation of cfitsio  
85 -in the default GammaLib install directory as a shared library by 72 +and be installed from the source (for details, please refer to the
  73 +installation
  74 +instructions on the
  75 +<a href="http://heasarc.gsfc.nasa.gov/fitsio" target="_blank">HESEARC</a>
  76 +site).
  77 +We recommend installation of cfitsio in the default GammaLib install
  78 +directory as a shared library by
86 typing: 79 typing:
87 </p> 80 </p>
88 -  
89 <p class="Code">&gt; ./configure 81 <p class="Code">&gt; ./configure
90 --prefix=/usr/local/gamma<br> 82 --prefix=/usr/local/gamma<br>
91 -  
92 &gt; make shared<br> 83 &gt; make shared<br>
93 -  
94 &gt; make install 84 &gt; make install
95 </p> 85 </p>
96 -  
97 <p style="padding-top: 0pt; text-align: left;" class="Body"> 86 <p style="padding-top: 0pt; text-align: left;" class="Body">
98 GammaLib can also benefit from the presence of the readline library 87 GammaLib can also benefit from the presence of the readline library
99 that provides line-editing 88 that provides line-editing
100 and history capabilities for text input (GammaLib offers however also 89 and history capabilities for text input (GammaLib offers however also
101 full functionality without having 90 full functionality without having
102 readline installed). 91 readline installed).
103 -readline can be downloaded from  
104 -<a href="http://ftp.gnu.org/gnu/readline/" target="_blank">http://ftp.gnu.org/gnu/readline/</a> 92 +readline (which depends on ncurses) is available on most system as a
  93 +prebuilt library, so also here we recommend to use your package manager
  94 +to install the libraries. Also here, the readline (and ncurses)
  95 +development packages are required, so that the header files become
  96 +available and the symbolic links are set correctly.</p>
  97 +<p style="padding-top: 0pt; text-align: left;" class="Body"></p>
  98 +<p style="padding-top: 0pt; text-align: left;" class="Body">If
  99 +readline and ncurses are not available as a prebuilt package, or if you
  100 +encounter some problems with the prebuilt packages, both libraries can
  101 +be downloaded from <a href="http://ftp.gnu.org/gnu/" target="_blank">http://ftp.gnu.org/gnu/</a>.
105 </p> 102 </p>
106 -  
107 <br> 103 <br>
108 -  
109 <br> 104 <br>
110 -  
111 <p class="Title"><a name="Building_GammaLib"></a>Building 105 <p class="Title"><a name="Building_GammaLib"></a>Building
112 GammaLib</p> 106 GammaLib</p>
113 -  
114 <p style="padding-top: 0pt; text-align: left;" class="Body"> 107 <p style="padding-top: 0pt; text-align: left;" class="Body">
115 Download the latest source tarball, save it in an appropriate location, 108 Download the latest source tarball, save it in an appropriate location,
116 and type</p> 109 and type</p>
117 -  
118 <p class="Code"> 110 <p class="Code">
119 &gt; tar xvfz GammaLib-XX-XX-XX.tar.gz 111 &gt; tar xvfz GammaLib-XX-XX-XX.tar.gz
120 </p> 112 </p>
121 -  
122 <p style="padding-top: 0pt; text-align: left;" class="Body"> 113 <p style="padding-top: 0pt; text-align: left;" class="Body">
123 where <span style="font-family: Courier New,Courier,monospace;">XX-XX-XX</span> 114 where <span style="font-family: Courier New,Courier,monospace;">XX-XX-XX</span>
124 is the version number of the library. 115 is the version number of the library.
125 Step in the created directory using 116 Step in the created directory using
126 </p> 117 </p>
127 -  
128 <p class="Code"> 118 <p class="Code">
129 -&gt; cd GammaLib-XX-XX-XX 119 +&gt; cd gammalib-XX-XX-XX
130 </p> 120 </p>
131 -  
132 <p style="padding-top: 0pt; text-align: left;" class="Body"> 121 <p style="padding-top: 0pt; text-align: left;" class="Body">
133 and build GammaLib by typing</p> 122 and build GammaLib by typing</p>
134 -  
135 <p class="Code"> 123 <p class="Code">
136 &gt; ./configure<br> 124 &gt; ./configure<br>
137 -  
138 &gt; make 125 &gt; make
139 </p> 126 </p>
140 -  
141 <p style="padding-top: 0pt; text-align: left;" class="Body"> 127 <p style="padding-top: 0pt; text-align: left;" class="Body">
142 at the operating system prompt. 128 at the operating system prompt.
143 The configuration command customizes the Makefiles for the particular 129 The configuration command customizes the Makefiles for the particular
@@ -161,11 +147,9 @@ argument should be @@ -161,11 +147,9 @@ argument should be
161 given, 147 given,
162 for example: 148 for example:
163 </p> 149 </p>
164 -  
165 <p class="Code"> 150 <p class="Code">
166 &gt; ./configure --prefix=/usr/local 151 &gt; ./configure --prefix=/usr/local
167 </p> 152 </p>
168 -  
169 <p style="padding-top: 0pt; text-align: left;" class="Body"> 153 <p style="padding-top: 0pt; text-align: left;" class="Body">
170 If cfitsio and/or readline is not installed in a standard location for 154 If cfitsio and/or readline is not installed in a standard location for
171 libraries (such 155 libraries (such
@@ -175,45 +159,32 @@ the appropriate location(s) can be specified using the &lt;span style=&quot;font-family: @@ -175,45 +159,32 @@ the appropriate location(s) can be specified using the &lt;span style=&quot;font-family:
175 (for the library directory) and <span style="font-family: Courier New,Courier,monospace;">CPPFLAGS</span> 159 (for the library directory) and <span style="font-family: Courier New,Courier,monospace;">CPPFLAGS</span>
176 (for the include directory) options: 160 (for the include directory) options:
177 </p> 161 </p>
178 -  
179 <p class="Code"> 162 <p class="Code">
180 &gt; ./configure LDFLAGS='-L/opt/local/lib' 163 &gt; ./configure LDFLAGS='-L/opt/local/lib'
181 CPPFLAGS='-I/opt/local/include' 164 CPPFLAGS='-I/opt/local/include'
182 </p> 165 </p>
183 -  
184 <p style="padding-top: 0pt; text-align: left;" class="Body">A 166 <p style="padding-top: 0pt; text-align: left;" class="Body">A
185 full list of configuration options can be found using</p> 167 full list of configuration options can be found using</p>
186 -  
187 <p class="Code"> 168 <p class="Code">
188 &gt; ./configure --help 169 &gt; ./configure --help
189 </p> 170 </p>
190 -  
191 <br> 171 <br>
192 -  
193 <br> 172 <br>
194 -  
195 <p class="Title"><a name="Testing_GammaLib"></a>Testing 173 <p class="Title"><a name="Testing_GammaLib"></a>Testing
196 GammaLib</p> 174 GammaLib</p>
197 -  
198 <p style="padding-top: 0pt; text-align: left;" class="Body"> 175 <p style="padding-top: 0pt; text-align: left;" class="Body">
199 GammaLib should be tested by typing:</p> 176 GammaLib should be tested by typing:</p>
200 -  
201 <p class="Code"> 177 <p class="Code">
202 &gt; make check 178 &gt; make check
203 </p> 179 </p>
204 -  
205 <p style="padding-top: 0pt; text-align: left;" class="Body"> 180 <p style="padding-top: 0pt; text-align: left;" class="Body">
206 This will execute an extensive testing suite that should terminate with 181 This will execute an extensive testing suite that should terminate with
207 </p> 182 </p>
208 -  
209 <p class="Code"> 183 <p class="Code">
210 ===================<br> 184 ===================<br>
211 -  
212 All 14 tests passed<br> 185 All 14 tests passed<br>
213 -  
214 =================== 186 ===================
215 </p> 187 </p>
216 -  
217 <p style="padding-top: 0pt; text-align: left;" class="Body">Eventually, 188 <p style="padding-top: 0pt; text-align: left;" class="Body">Eventually,
218 loading the shared cfitsio and/or readline libraries may fail during 189 loading the shared cfitsio and/or readline libraries may fail during
219 the test if the libraries are not located in standard locations. In 190 the test if the libraries are not located in standard locations. In
@@ -221,48 +192,34 @@ this case, add the library directories to the &lt;span style=&quot;font-family: Courier @@ -221,48 +192,34 @@ this case, add the library directories to the &lt;span style=&quot;font-family: Courier
221 environment variables (<span style="font-family: Courier New,Courier,monospace;">DYLD_LIBRARY_PATH</span> 192 environment variables (<span style="font-family: Courier New,Courier,monospace;">DYLD_LIBRARY_PATH</span>
222 on Mac OS X), e.g. 193 on Mac OS X), e.g.
223 </p> 194 </p>
224 -  
225 <p class="Code"> 195 <p class="Code">
226 export LD_LIBRARY_PATH=/opt/local/lib:$LD_LIBRARY_PATH 196 export LD_LIBRARY_PATH=/opt/local/lib:$LD_LIBRARY_PATH
227 </p> 197 </p>
228 -  
229 <p style="padding-top: 0pt; text-align: left;" class="Body"> 198 <p style="padding-top: 0pt; text-align: left;" class="Body">
230 or 199 or
231 </p> 200 </p>
232 -  
233 <p class="Code"> 201 <p class="Code">
234 setenv LD_LIBRARY_PATH /opt/local/lib:$LD_LIBRARY_PATH 202 setenv LD_LIBRARY_PATH /opt/local/lib:$LD_LIBRARY_PATH
235 </p> 203 </p>
236 -  
237 <p style="padding-top: 0pt; text-align: left;" class="Body"> 204 <p style="padding-top: 0pt; text-align: left;" class="Body">
238 on C shell variants.</p> 205 on C shell variants.</p>
239 -  
240 <br> 206 <br>
241 -  
242 <br> 207 <br>
243 -  
244 <p class="Title"><a name="Installing_GammaLib"></a>Installing 208 <p class="Title"><a name="Installing_GammaLib"></a>Installing
245 GammaLib</p> 209 GammaLib</p>
246 -  
247 <span style="font-family: 'Arial','Arial','Arial',sans-serif;"></span> 210 <span style="font-family: 'Arial','Arial','Arial',sans-serif;"></span>
248 <p style="padding-top: 0pt; text-align: left;" class="Body"><span style="font-family: 'Arial','Arial','Arial',sans-serif;">I</span>nstall 211 <p style="padding-top: 0pt; text-align: left;" class="Body"><span style="font-family: 'Arial','Arial','Arial',sans-serif;">I</span>nstall
249 GammaLib by typing</p> 212 GammaLib by typing</p>
250 -  
251 <p class="Code"> 213 <p class="Code">
252 &gt;&nbsp;make install 214 &gt;&nbsp;make install
253 </p> 215 </p>
254 -  
255 <p style="padding-top: 0pt; text-align: left;" class="Body"> 216 <p style="padding-top: 0pt; text-align: left;" class="Body">
256 at the operating system prompt. 217 at the operating system prompt.
257 </p> 218 </p>
258 -  
259 <br> 219 <br>
260 -  
261 <br> 220 <br>
262 -  
263 <p class="Title"><a name="Setting_up_your_environment"></a>Setting 221 <p class="Title"><a name="Setting_up_your_environment"></a>Setting
264 up your environment</p> 222 up your environment</p>
265 -  
266 <p style="padding-top: 0pt; text-align: left;" class="Body"> 223 <p style="padding-top: 0pt; text-align: left;" class="Body">
267 Before using GammaLib you have to setup some environment variables. 224 Before using GammaLib you have to setup some environment variables.
268 This will be done automatically by an initialisation script that will 225 This will be done automatically by an initialisation script that will
@@ -270,44 +227,33 @@ be installed in the &lt;span style=&quot;font-family: Courier New,Courier,monospace;&quot;&gt;bi @@ -270,44 +227,33 @@ be installed in the &lt;span style=&quot;font-family: Courier New,Courier,monospace;&quot;&gt;bi
270 directory. Assuming that you have installed GammaLib in the default 227 directory. Assuming that you have installed GammaLib in the default
271 directory 228 directory
272 <span style="font-family: Courier New,Courier,monospace;">/usr/local/gamma</span> 229 <span style="font-family: Courier New,Courier,monospace;">/usr/local/gamma</span>
273 -you need to add the following to your <span style="font-family: Courier New,Courier,monospace;">.bashrc</span> 230 +you need to add the following to your <span style="font-family: Courier New,Courier,monospace;">$HOME/.bashrc</span>
274 or <span style="font-family: Courier New,Courier,monospace;">$HOME/.profile</span> 231 or <span style="font-family: Courier New,Courier,monospace;">$HOME/.profile</span>
275 script on a Linux 232 script on a Linux
276 machine: 233 machine:
277 </p> 234 </p>
278 -  
279 <p class="Code">export GAMMALIB=/usr/local/gamma<br> 235 <p class="Code">export GAMMALIB=/usr/local/gamma<br>
280 -  
281 source $GAMMALIB/bin/gammalib-init.sh 236 source $GAMMALIB/bin/gammalib-init.sh
282 </p> 237 </p>
283 -  
284 <p style="padding-top: 0pt; text-align: left;" class="Body">If 238 <p style="padding-top: 0pt; text-align: left;" class="Body">If
285 you use C shell or a variant then add the following to your 239 you use C shell or a variant then add the following to your
286 -<span style="font-family: Courier New,Courier,monospace;">.cshrc</span>  
287 -or <span style="font-family: Courier New,Courier,monospace;">.tcshrc</span> 240 +<span style="font-family: Courier New,Courier,monospace;">$HOME/.cshrc</span>
  241 +or <span style="font-family: Courier New,Courier,monospace;">$HOME/.tcshrc</span>
288 script: 242 script:
289 </p> 243 </p>
290 -  
291 <p class="Code">setenv GAMMALIB /usr/local/gamma<br> 244 <p class="Code">setenv GAMMALIB /usr/local/gamma<br>
292 -  
293 source $GAMMALIB/bin/gammalib-init.csh </p> 245 source $GAMMALIB/bin/gammalib-init.csh </p>
294 -  
295 <br> 246 <br>
296 -  
297 <br> 247 <br>
298 -  
299 <p class="Title"><a name="Installing_documentation"></a>Installing 248 <p class="Title"><a name="Installing_documentation"></a>Installing
300 documentation</p> 249 documentation</p>
301 -  
302 <p style="padding-top: 0pt; text-align: left;" class="Body"> 250 <p style="padding-top: 0pt; text-align: left;" class="Body">
303 The GammaLib web pages are shipped together with the source code and 251 The GammaLib web pages are shipped together with the source code and
304 will be installed in the directory <span style="font-family: Courier New,Courier,monospace;">$(prefix)/share/doc/gammalib/html</span>, 252 will be installed in the directory <span style="font-family: Courier New,Courier,monospace;">$(prefix)/share/doc/gammalib/html</span>,
305 where <span style="font-family: Courier New,Courier,monospace;">$(prefix)</span> 253 where <span style="font-family: Courier New,Courier,monospace;">$(prefix)</span>
306 is the installation base path, by default <span style="font-family: Courier New,Courier,monospace;">/usr/local/gamma</span>. 254 is the installation base path, by default <span style="font-family: Courier New,Courier,monospace;">/usr/local/gamma</span>.
307 </p> 255 </p>
308 -  
309 <br> 256 <br>
310 -  
311 <p style="padding-top: 0pt; text-align: left;" class="Body"> 257 <p style="padding-top: 0pt; text-align: left;" class="Body">
312 For developers, a more detailed documentation can be built from the 258 For developers, a more detailed documentation can be built from the
313 source code using Doxygen. Doxygen will scan the source files for code 259 source code using Doxygen. Doxygen will scan the source files for code
@@ -318,73 +264,110 @@ command. If you have not installed Doxygen on your machine, but you @@ -318,73 +264,110 @@ command. If you have not installed Doxygen on your machine, but you
318 need the development documentation, please visit <a href="http://www.stack.nl/%7Edimitri/doxygen/index.html" target="_blank">http://www.stack.nl/~dimitri/doxygen/index.html</a> 264 need the development documentation, please visit <a href="http://www.stack.nl/%7Edimitri/doxygen/index.html" target="_blank">http://www.stack.nl/~dimitri/doxygen/index.html</a>
319 to download and install the Doxygen package. 265 to download and install the Doxygen package.
320 </p> 266 </p>
321 -  
322 <br> 267 <br>
323 -  
324 <p style="padding-top: 0pt; text-align: left;" class="Body"> 268 <p style="padding-top: 0pt; text-align: left;" class="Body">
325 Once Doxygen is install, type the following to build and to install the 269 Once Doxygen is install, type the following to build and to install the
326 Doxygen documentation: 270 Doxygen documentation:
327 </p> 271 </p>
328 -  
329 <p class="Code">&gt; ./configure<br> 272 <p class="Code">&gt; ./configure<br>
330 -  
331 &gt; make doxygen<br> 273 &gt; make doxygen<br>
332 -  
333 &gt; make doxygen-install 274 &gt; make doxygen-install
334 </p> 275 </p>
335 -  
336 <p style="padding-top: 0pt; text-align: left;" class="Body"> 276 <p style="padding-top: 0pt; text-align: left;" class="Body">
337 The Doxygen documentation will be installed into 277 The Doxygen documentation will be installed into
338 <span style="font-family: Courier New,Courier,monospace;">$(prefix)/share/doc/gammalib/html/doxygen</span> 278 <span style="font-family: Courier New,Courier,monospace;">$(prefix)/share/doc/gammalib/html/doxygen</span>
339 and can be browsed using a regular web browser. 279 and can be browsed using a regular web browser.
340 </p> 280 </p>
341 -  
342 <br> 281 <br>
343 -  
344 <p style="padding-top: 0pt; text-align: left;" class="Body"> 282 <p style="padding-top: 0pt; text-align: left;" class="Body">
345 To check <span style="font-family: Courier New,Courier,monospace;">man</span> 283 To check <span style="font-family: Courier New,Courier,monospace;">man</span>
346 support, type for example 284 support, type for example
347 </p> 285 </p>
348 -  
349 <p class="Code">&gt; man GObservations 286 <p class="Code">&gt; man GObservations
350 </p> 287 </p>
351 -  
352 <p style="padding-top: 0pt; text-align: left;" class="Body"> 288 <p style="padding-top: 0pt; text-align: left;" class="Body">
353 and you should see the documentation for the <span style="font-family: Courier New,Courier,monospace;">GObservations</span> 289 and you should see the documentation for the <span style="font-family: Courier New,Courier,monospace;">GObservations</span>
354 C++ class. 290 C++ class.
355 </p> 291 </p>
356 -  
357 <br> 292 <br>
358 -  
359 <br> 293 <br>
360 -  
361 <p class="Title"><a name="Known_Problems"></a>Known 294 <p class="Title"><a name="Known_Problems"></a>Known
362 Problems</p> 295 Problems</p>
363 -  
364 <p style="padding-top: 0pt; text-align: left;" class="Body"> 296 <p style="padding-top: 0pt; text-align: left;" class="Body">
365 -<span style="font-weight: bold; font-size: 14px;">Solaris</span> 297 +<span style="font-weight: bold; font-size: 14px;">Python
  298 +support</span>
366 <br> 299 <br>
367 -  
368 -GammaLib has been compiled successfully on Solaris 2.10 using the Sun  
369 -Studio compiler. However, when linked as a shared library, symbols are  
370 -not globally exported. This prevents the GammaLib library from catching  
371 -its own exceptions and from registering models. Consequently, many unit  
372 -tests will fail. 300 +GammaLib comes with Python wrappers so that all classes can be
  301 +directly used from Python. To compile-in Python support, GammaLib
  302 +needs the <span style="font-family: Courier New,Courier,monospace;">Python.h</span>
  303 +header file, which on many distributions is not
  304 +installed by default.
  305 +To make <span style="font-family: Courier New,Courier,monospace;">Python.h</span>
  306 +available, install the Python developer package
  307 +in your distribution using the package manager. Otherwise you will not
  308 +be able to use GammaLib
  309 +from Python.
  310 +</p>
373 <br> 311 <br>
374 - 312 +<p style="padding-top: 0pt; text-align: left;" class="Body">
  313 +<span style="font-weight: bold; font-size: 14px;">Mac OS X</span>
375 <br> 314 <br>
376 -  
377 -Using gcc (version 3.4.3), GammaLib works correctly on Solaris 2.10,  
378 -yet loading GammaLib as a Python module fails. 315 +The Python development package is not installed as default on Mac
  316 +OS X, and consequently, the <span style="font-family: Courier New,Courier,monospace;">Python.h</span>
  317 +header file is missing that is
  318 +needed to compile in the Python bindings. The <span style="font-family: Courier New,Courier,monospace;">configure</span>
  319 +script recognises this fact and adjust the build procedure accordingly,
  320 +but you
  321 +will not be able to use GammaLib from Python. So better install the
  322 +Python development package before installing&nbsp;GammaLib (see
  323 +above).</p>
  324 +<p style="padding-top: 0pt; text-align: left;" class="Body">It
  325 +was also reported that adding of&nbsp;<span style="font-family: Courier New,Courier,monospace;">export
  326 +MACOSX_DEPLOYMENT_TARGET=10.6</span> to the <span style="font-family: Courier New,Courier,monospace;">$HOME/.bashrc</span>
  327 +file was necessary one
  328 +some Mac OS X 10.6 installations to make&nbsp;GammaLib compile.<br>
  329 +</p>
  330 +<br>
  331 +<p style="padding-top: 0pt; text-align: left;" class="Body"><span style="font-weight: bold; font-size: 14px;">Solaris</span>
  332 +<br>
  333 +Although&nbsp;GammaLib builds on Solaris using the Sun compiler,
  334 +there are
  335 +problems with global symbols in shared libraries and exception
  336 +catching, which prevents the FITS interface to work
  337 +correctly.&nbsp;GammaLib has however been built and tested
  338 +successfully
  339 +using the GNU
  340 +compiler, and this is the only build method that is currently
  341 +supported.
  342 +Problems have also been encountered when compiling cfitsio versions
  343 +more recent than 3.250. The problems have been reported to the cfitsio
  344 +developer team, and are likely to be solved in the future. For the
  345 +time being, it is recommended to use cfitsio version 3.250 on Solaris.
  346 +</p>
  347 +<br>
  348 +<p style="padding-top: 0pt; text-align: left;" class="Body"><span style="font-weight: bold; font-size: 14px;">OpenSolaris</span>
  349 +<br>
  350 +On OpenSolaris, the same problems concerning the SunStudio compiler
  351 +occur as for Solaris, and also here, the GNU compiler is the
  352 +recommended
  353 +tool to build&nbsp;GammaLib. Also here, cfitsio version 3.250 is
  354 +the
  355 +recommended library as more recent version feature relocation
  356 +problems.&nbsp;GammaLib has been tested using gcc 4.3.2 on
  357 +OpenSolaris
  358 +2009.06. Make sure to create the symbolic links
  359 +</p>
  360 +<p class="Code">ln -s /usr/bin/gcc4.3.2 /usr/bin/gcc<br>
  361 +ln -s /usr/bin/g++4.3.2 /usr/bin/g++</p>
  362 +<p style="padding-top: 0pt; text-align: left;" class="Body">
  363 +which are not there by default to avoid excess warnings during
  364 +compilation.
379 </p> 365 </p>
380 -  
381 <br> 366 <br>
382 -  
383 <br> 367 <br>
384 368
385 <p class="Title"><a name="Getting_Help"></a>Getting 369 <p class="Title"><a name="Getting_Help"></a>Getting
386 Help</p> 370 Help</p>
387 -  
388 <p style="padding-top: 0pt; text-align: left;" class="Body"> 371 <p style="padding-top: 0pt; text-align: left;" class="Body">
389 Any questions, bug reports, or suggested enhancements related to 372 Any questions, bug reports, or suggested enhancements related to
390 GammaLib should be submitted 373 GammaLib should be submitted
@@ -393,6 +376,10 @@ or the @@ -393,6 +376,10 @@ or the
393 <a href="mailto:gammalib-users@lists.soureforge.net">gammalib-users@lists.sourceforge.net</a> 376 <a href="mailto:gammalib-users@lists.soureforge.net">gammalib-users@lists.sourceforge.net</a>
394 mailing list. 377 mailing list.
395 </p> 378 </p>
396 -  
397 -</body>  
398 -</html> 379 +<br>
  380 +<hr size="1">
  381 +<p class="Body">Last updated by: J&uuml;rgen
  382 +Kn&ouml;dlseder 20 July
  383 +2011
  384 +</p>
  385 +</body></html>
399 \ No newline at end of file 386 \ No newline at end of file
doc/html/quickstart.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 -<html>  
3 -<head>  
4 -  
5 - <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">  
6 - <title>Getting Started</title>  
7 -  
8 -  
9 - <link href="gammalib.css" media="screen,print" type="text/css" rel="stylesheet"> 2 +<html><head>
  3 +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"><title>Getting Started</title>
10 4
  5 +<link href="gammalib.css" media="screen,print" type="text/css" rel="stylesheet">
11 </head> 6 </head>
12 7
13 -  
14 <body> 8 <body>
15 -  
16 <p class="Header">Getting started</p> 9 <p class="Header">Getting started</p>
17 -  
18 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#First%20steps%20with%20GammaLib"> 10 <p style="padding-top: 0pt; text-align: left;" class="Body"><a href="#First%20steps%20with%20GammaLib">
19 First steps with GammaLib</a><br> 11 First steps with GammaLib</a><br>
20 -  
21 <a href="#Getting_Help"> 12 <a href="#Getting_Help">
22 Getting Help</a> 13 Getting Help</a>
23 </p> 14 </p>
24 -  
25 <br> 15 <br>
26 -  
27 <p class="Title"><a name="First steps with GammaLib"></a>First 16 <p class="Title"><a name="First steps with GammaLib"></a>First
28 steps with GammaLib</p> 17 steps with GammaLib</p>
29 -  
30 <p style="padding-top: 0pt; text-align: left;" class="Body">GammaLib 18 <p style="padding-top: 0pt; text-align: left;" class="Body">GammaLib
31 -comes with a Python interface, and as first step you should verify that the 19 +comes with a Python interface, and as first step you should verify that
  20 +the
32 Python interfaces workes correctly. You do this by typing: 21 Python interfaces workes correctly. You do this by typing:
33 </p> 22 </p>
34 -  
35 <p class="Code">&gt; python<br> 23 <p class="Code">&gt; python<br>
36 -  
37 &gt;&gt;&gt; from gammalib import *<br> 24 &gt;&gt;&gt; from gammalib import *<br>
38 -  
39 &gt;&gt;&gt; 25 &gt;&gt;&gt;
40 </p> 26 </p>
41 -  
42 -<p style="padding-top: 0pt; text-align: left;" class="Body">If everything works fine you should just get a new Python prompt after importing GammaLib. 27 +<p style="padding-top: 0pt; text-align: left;" class="Body">If
  28 +everything works fine you should just get a new Python prompt after
  29 +importing GammaLib. If you get an error message, make sure that you've
  30 +setup correctly the GammaLib environment. You basically need the <span style="font-family: Courier New,Courier,monospace;">PYTHONPATH</span>
  31 +variable set to GammaLib's Python site-package, and you also have to
  32 +make sure that GammaLib and any dependent library (cfitsio, readline,
  33 +ncurses) is in the library load path (eventually you may need to adjust
  34 +<span style="font-family: Courier New,Courier,monospace;">LD_LIBRARY_PATH</span>).
  35 +This is all done automatically if you set up the environment as
  36 +described <a href="installation.html#Setting_up_your_environment">here</a>.</p>
  37 +<br>
  38 +<p style="padding-top: 0pt; text-align: left;" class="Body">Now
  39 +try:
43 </p> 40 </p>
44 - 41 +<p class="Code">&gt;&gt;&gt; models=GModels()<br>
  42 +&gt;&gt;&gt; print models<br>
  43 +=== GModels ===<br>
  44 +Number of models ..........: 0<br>
  45 +Number of parameters ......: 0<br>
  46 +&gt;&gt;&gt;
  47 +</p>
  48 +<p style="padding-top: 0pt; text-align: left;" class="Body">You
  49 +just alloacted
  50 +your first GammaLib object, which is an empty model container.</p>
45 <br> 51 <br>
46 - 52 +<p style="padding-top: 0pt; text-align: left;" class="Body">Now
  53 +let's append a model to this container. For this, type:
  54 +</p>
  55 +<p class="Code">&gt;&gt;&gt; pos = GSkyDir()<br>
  56 +&gt;&gt;&gt; pos.radec_deg(83.6331, 22.0145)<br>
  57 +&gt;&gt;&gt; spatial = GModelSpatialPtsrc(pos)<br>
  58 +&gt;&gt;&gt; spectral = GModelSpectralPlaw(1.0, -2.0)<br>
  59 +&gt;&gt;&gt; model = GModelPointSource(spatial, spectral)<br>
  60 +&gt;&gt;&gt; models.append(model)<br>
  61 +&gt;&gt;&gt; print models<br>
  62 +=== GModels ===<br>
  63 +Number of models ..........: 1<br>
  64 +Number of parameters ......: 6<br>
  65 +=== GModelPointSource ===<br>
  66 +Name ......................:<br>
  67 +Instruments ...............: all<br>
  68 +Model type ................: "SkyDirFunction" * "PowerLaw" * "Constant"<br>
  69 +Number of parameters ......: 6<br>
  70 +Number of spatial par's ...: 2<br>
  71 +&nbsp;RA .......................: 83.6331 deg (fixed,scale=1)<br>
  72 +&nbsp;DEC ......................: 22.0145 deg (fixed,scale=1)<br>
  73 +Number of spectral par's ..: 3<br>
  74 +&nbsp;Prefactor ................: 1 +/- 0 [0,infty[ ph/cm2/s/MeV
  75 +(free,scale=1,gradient)<br>
  76 +&nbsp;Index ....................: -2 +/- 0 [-10,10]
  77 +(free,scale=1,gradient)<br>
  78 +&nbsp;PivotEnergy ..............: 100 MeV (fixed,scale=1,gradient)<br>
  79 +Number of temporal par's ..: 1<br>
  80 +&nbsp;Constant .................: 1 (relative value)
  81 +(fixed,scale=1,gradient)<br>
  82 +&gt;&gt;&gt;
  83 +</p>
  84 +<p style="padding-top: 0pt; text-align: left;" class="Body">With
  85 +this
  86 +sequence of commands you first defined a sky direction in celestial
  87 +coordinates using <span style="font-family: Courier New,Courier,monospace;">GSkyDir</span>.
  88 +You may easily recognise that this is the position of the Crab. You
  89 +then used this position to define the spatial component of a sky model
  90 +using <span style="font-family: Courier New,Courier,monospace;">GModelSpatialPtsrc</span>.
  91 +As the name suggests, the spatial component is a point source. Next,
  92 +you defined the spectral component using <span style="font-family: Courier New,Courier,monospace;">GModelSpactralPlaw</span>:
  93 +a power law with normalisation of 1 and index of -2. Then, you combined
  94 +the spatial and spectral components in a point source model using <span style="font-family: Courier New,Courier,monospace;">GModelPointSource</span>.
  95 +And finally you appended the point source to the model container
  96 +allocated previously using the <span style="font-family: Courier New,Courier,monospace;">append</span>
  97 +method. When you then print the model container you see that is
  98 +contains now one model with 6 parameters. Among them, you find the
  99 +specified source position (parameters <span style="font-family: Courier New,Courier,monospace;">RA</span>
  100 +and <span style="font-family: Courier New,Courier,monospace;">DEC</span>),
  101 +the power law normalisation (parameter <span style="font-family: Courier New,Courier,monospace;">Prefactor</span>)
  102 +and the spectral index (parameter <span style="font-family: Courier New,Courier,monospace;">Index</span>).
  103 +In addition, the reference energy for the normalisation has been set
  104 +automatically to 100 MeV (parameter <span style="font-family: Courier New,Courier,monospace;">PivotEnergy</span>)
  105 +and the temporal component has been set by default to a constant
  106 +(parameter <span style="font-family: Courier New,Courier,monospace;">Constant</span>).</p>
  107 +<br>
  108 +<p style="padding-top: 0pt; text-align: left;" class="Body">Suppose
  109 +you want
  110 +to change one of these parameters, such as the <span style="font-family: Courier New,Courier,monospace;">PivotEnergy</span>
  111 +that you want
  112 +to set to 1 TeV. This can be done using:</p>
  113 +<p class="Code">&gt;&gt;&gt;
  114 +models[0]['PivotEnergy'].value(1.0e6)<br>
  115 +&gt;&gt;&gt; print models<br>
  116 +...<br>
  117 +&nbsp;PivotEnergy ..............: 1e+06 MeV (fixed,scale=1,gradient)<br>
  118 +...<br>
  119 +</p>
  120 +<p style="padding-top: 0pt; text-align: left;" class="Body">As
  121 +the units are MeV, we had to specify a value of 1e6 to set the
  122 +reference energy to 1 TeV. We did this by accessing the first model in
  123 +the container using <span style="font-family: Courier New,Courier,monospace;">models[0]</span>
  124 +(counting in GammaLib always starts from 0). Then we addressed the <span style="font-family: Courier New,Courier,monospace;">PivotEnergy</span>
  125 +parameter by specifying <span style="font-family: Courier New,Courier,monospace;">['PivotEnergy']</span>.
  126 +And finally we called the <span style="font-family: Courier New,Courier,monospace;">value</span>
  127 +method that sets the value of a particular parameter.</p>
  128 +<br>
  129 +<p style="padding-top: 0pt; text-align: left;" class="Body">After
  130 +all this
  131 +hard work, you may save your model into a XML file by typing:</p>
  132 +<p class="Code">&gt;&gt;&gt;
  133 +models.save('test.xml')<br>
  134 +&gt;&gt;&gt;<br>
  135 +</p>
  136 +<p style="padding-top: 0pt; text-align: left;" class="Body">and
  137 +you
  138 +can load it from an XML file in memory using</p>
  139 +<p class="Code">&gt;&gt;&gt;
  140 +newmodels=GModels('test.xml')<br>
  141 +&gt;&gt;&gt; print newmodels<br>
  142 +</p>
  143 +<p style="padding-top: 0pt; text-align: left;" class="Body">The
  144 +last
  145 +print command is to convince yourself that the models have been
  146 +loaded properly.</p>
  147 +<br>
  148 +<p style="padding-top: 0pt; text-align: left;" class="Body">Much
  149 +more is still to come. Please be a little bit patient, I'm working on
  150 +it. In the meantime you may check the <a href="doxygen.html">Doxygen
  151 +documentation</a> to see what classes and methods are available.</p>
47 <br> 152 <br>
48 -  
49 <p class="Title"><a name="Getting_Help"></a>Getting 153 <p class="Title"><a name="Getting_Help"></a>Getting
50 Help</p> 154 Help</p>
51 -  
52 <p style="padding-top: 0pt; text-align: left;" class="Body"> 155 <p style="padding-top: 0pt; text-align: left;" class="Body">
53 Any questions, bug reports, or suggested enhancements related to 156 Any questions, bug reports, or suggested enhancements related to
54 GammaLib should be submitted 157 GammaLib should be submitted
@@ -57,6 +160,10 @@ or the @@ -57,6 +160,10 @@ or the
57 <a href="mailto:gammalib-users@lists.soureforge.net">gammalib-users@lists.sourceforge.net</a> 160 <a href="mailto:gammalib-users@lists.soureforge.net">gammalib-users@lists.sourceforge.net</a>
58 mailing list. 161 mailing list.
59 </p> 162 </p>
60 -  
61 -</body>  
62 -</html> 163 +<br>
  164 +<hr size="1">
  165 +<p class="Body">Last updated by: J&uuml;rgen
  166 +Kn&ouml;dlseder 20 July
  167 +2011
  168 +</p>
  169 +</body></html>
63 \ No newline at end of file 170 \ No newline at end of file
gammalib.pc.in
@@ -6,7 +6,7 @@ includedir=${prefix}/include @@ -6,7 +6,7 @@ includedir=${prefix}/include
6 Name: GammaLib 6 Name: GammaLib
7 Description: Versatile toolbox for analysis of astronomical gamma-ray data 7 Description: Versatile toolbox for analysis of astronomical gamma-ray data
8 URL: http://gammalib.sourceforge.net/ 8 URL: http://gammalib.sourceforge.net/
9 -Version: 0.4.9 9 +Version: 0.4.10
10 Requires: 10 Requires:
11 Requires.private: @CFITSIO@ 11 Requires.private: @CFITSIO@
12 Conflicts: 12 Conflicts: