Update documentation

Jürgen Knödlseder
1 parent 82b4fc00
Showing 5 changed files with 26 additions and 19 deletions
doc/source/quickstart.rst
doc/source/user_manual/getting.rst
doc/source/user_manual/introduction.rst
doc/source/user_manual/modules/uml_vo.png
doc/source/user_manual/modules/vo.rst
@@ -8,7 +8,7 @@ GammaLib comes with a Python interface, and as first step you should
 verify that the Python interfaces workes correctly. You do this by
 typing::
-   >>> from gammalib import *
+   >>> import gammalib
 If everything works fine you should just get a new Python prompt after
 importing GammaLib. If you get an error message, make sure that you've
@@ -22,7 +22,7 @@ up the environment as described
 Now try::
-   >>> models = GModels()
+   >>> models = gammalib.GModels()
    >>> print(models)
    === GModels ===
    Number of models ..........: 0
@@ -33,11 +33,11 @@ container.
 Now let's append a model to this container. For this, type::
-    >>> pos = GSkyDir()
+    >>> pos = gammalib.GSkyDir()
     >>> pos.radec_deg(83.6331, 22.0145)
-    >>> spatial = GModelSpatialPointSource(pos)
-    >>> spectral = GModelSpectralPlaw(1.0, -2.0, GEnergy(100, 'MeV'))
-    >>> model = GModelSky(spatial, spectral)
+    >>> spatial = gammalib.GModelSpatialPointSource(pos)
+    >>> spectral = gammalib.GModelSpectralPlaw(1.0, -2.0, gammalib.GEnergy(100, 'MeV'))
+    >>> model = gammalib.GModelSky(spatial, spectral)
     >>> models.append(model)
     >>> print(models)
     === GModels ===
@@ -101,7 +101,7 @@ typing::
 and you can load it from an XML file in memory using::
-   >>> new_models = GModels('test.xml')
+   >>> new_models = gammalib.GModels('test.xml')
    >>> print(new_models)
 The last print command is to convince yourself that the models have been
@@ -10,7 +10,7 @@ to compile and to install GammaLib.
 You will need the following to build the software:
--  About 100 MB of free disk space.
+-  About 200 MB of free disk space.
 -  An ANSI C++ compiler. We recommend building GammaLib with the GNU g++
    compiler.
@@ -144,8 +144,8 @@ https://sourceforge.net/projects/gammalib/. The code can be downloaded
 from this site by clicking on the download button. Alternatively, the
 code can be downloaded and unpacked from the UNIX prompt using::
-    $ wget --no-check-certificate https://downloads.sourceforge.net/project/gammalib/gammalib/gammalib-00-08-00.tar.gz
-    $ tar xfz gammalib-00-08-00.tar.gz
+    $ wget --no-check-certificate https://downloads.sourceforge.net/project/gammalib/gammalib/gammalib-00-10-00.tar.gz
+    $ tar xfz gammalib-00-10-00.tar.gz
 The GammaLib source code can also be cloned using git. This method is
 recommended if you plan to contribute to the development of the GammaLib
@@ -201,17 +201,20 @@ follows::
       * FITS I/O support             (yes)   /usr/local/gamma/lib /usr/local/gamma/include
       * Readline support             (yes)    
       * Ncurses support              (yes)   
+      * Make Python binding          (yes)   use swig for updates
       * Python                       (yes)
       * Python.h                     (yes)
+      * Python wrappers              (yes)
       * swig                         (yes)
-      * Make Python bindings         (yes)
       * Multiwavelength interface    (yes)
       * Fermi-LAT interface          (yes)
       * CTA interface                (yes)
-      * Doxygen                      (yes)   /usr/local/bin/doxygen
+      * COMPTEL interface            (yes)
+      * Doxygen                      (yes)   /opt/local/bin/doxygen
       * Perform NaN/Inf checks       (yes)   (default)
       * Perform range checking       (yes)   (default)
       * Optimize memory usage        (yes)   (default)
+      * Enable OpenMP                (yes)   (default)
       - Compile in debug code        (no)    (default)
       - Enable code for profiling    (no)    (default)
@@ -409,7 +412,7 @@ instrument dependent modules are enabled), you should see the following
 message in your terminal::
     ===================
-    All 19 tests passed
+    All 20 tests passed
     ===================
 (Note that the exact number of tests that is conducted depends on the 
@@ -37,7 +37,7 @@ version 3. The latest source code can be downloaded from
 https://sourceforge.net/projects/gammalib/ which also provides bug
 trackers and mailing lists. Further information and documentation on
 GammaLib can be found on http://gammalib.sourceforge.net/. The present document
-applies to GammaLib version 0.8.
+applies to GammaLib version 0.10.
 GammaLib is designed to compile on any POSIX compliant platform. So far, 
 GammaLib has been successfully compiled and tested on Mac OS X, OpenBSD, OpenSolaris
@@ -91,7 +91,7 @@ correspond to the folders in the source code distribution):
 GammaLib can be used as C++ application program interface (API) or as a Python
 module (provided that Python is installed on your system). The GammaLib Python
-bindings were built using `swig <http://www.swig.org/>`_ version 2.0.8, and are
+bindings were built using `swig <http://www.swig.org/>`_ version 3.0.2, and are
 shipped together with the source code. This enables using all
 GammaLib functionalities from within Python.
@@ -7,15 +7,19 @@ Overview
 ~~~~~~~~
 The VO module provides classes that interface GammaLib to the Virtual 
-Observatory infrastructure. So far the module contains :doxy:`GVOClient`
-as only class, which implements a client for the Virtual Observatory.
+Observatory infrastructure. So far the module contains the :doxy:`GVOClient`
+and the :doxy:`GVOHub` classes. :doxy:`GVOClient` implements a 
+Virtual Observatory client while :doxy:`GVOHub` implement a hub for
+inter-client communication.
+If a client needs to connect to a Hub and no Hub is currently running
+on the system, the client will launch it's own Hub.
-:ref:`fig_uml_vo` present an overview over the C++ classes of the VO
+:ref:`fig_uml_vo` presents an overview over the C++ classes of the VO
 module and their relations.
 .. _fig_uml_vo:
 .. figure:: uml_vo.png
-   :width: 17%
+   :width: 30%
    VO module