Samuel Flis / gammalib

Commit 2a8f01d957cbd902c6c5bda4be059ccfa04d9f54

Authored by Jürgen Knödlseder
1 parent 26c8bcc2

Update User documentation

Inline Side-by-side
Showing 2 changed files with 34 additions and 32 deletions
doc/source/download.rst
  View file @2a8f01d
... ... @@ -14,10 +14,11 @@ Releases
14 14 --------
15 15  
16 16 The latest GammaLib release is
17   -`gammalib-1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
18   -(3 March 2017).
  17 +`gammalib-1.3.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.0.tar.gz>`_
  18 +(7 Juin 2017).
19 19  
20 20 To download an older release, click on the corresponding release number:
  21 +`1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
21 22 `1.1.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.1.0.tar.gz>`_
22 23 `1.0.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.0.1.tar.gz>`_
23 24 `1.0.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.0.0.tar.gz>`_
... ... @@ -41,11 +42,11 @@ To download an older release, click on the corresponding release number:
41 42 Development release
42 43 -------------------
43 44  
44   -The current GammaLib development release is ``gammalib-1.3.0.dev1``.
  45 +The current GammaLib development release is ``gammalib-1.4.0.dev1``.
45 46 This release reflects the status of the current ``devel`` branch of
46 47 the GammaLib git repository.
47 48  
48   -* `GammaLib <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.0.dev1.tar.gz>`_ source code tarball
  49 +* `GammaLib <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.0.dev1.tar.gz>`_ source code tarball
49 50  
50 51  
51 52 Git repository
... ...
doc/source/users/quickstart.rst
  View file @2a8f01d
... ... @@ -45,33 +45,33 @@ Now let&#39;s append a model to this container. For this, type:
45 45  
46 46 .. code-block:: python
47 47  
48   - >>> pos = gammalib.GSkyDir()
49   - >>> pos.radec_deg(83.6331, 22.0145)
50   - >>> spatial = gammalib.GModelSpatialPointSource(pos)
51   - >>> spectral = gammalib.GModelSpectralPlaw(1.0, -2.0, gammalib.GEnergy(100, 'MeV'))
52   - >>> model = gammalib.GModelSky(spatial, spectral)
53   - >>> models.append(model)
54   - >>> print(models)
55   - === GModels ===
56   - Number of models ..........: 1
57   - Number of parameters ......: 6
58   - === GModelSky ===
59   - Name ......................:
60   - Instruments ...............: all
61   - Instrument scale factors ..: unity
62   - Observation identifiers ...: all
63   - Model type ................: PointSource
64   - Model components ..........: "SkyDirFunction" * "PowerLaw" * "Constant"
65   - Number of parameters ......: 6
66   - Number of spatial par's ...: 2
67   - RA .......................: 83.6331 deg (fixed,scale=1)
68   - DEC ......................: 22.0145 deg (fixed,scale=1)
69   - Number of spectral par's ..: 3
70   - Prefactor ................: 1 +/- 0 [0,infty[ ph/cm2/s/MeV (free,scale=1,gradient)
71   - Index ....................: -2 +/- 0 [10,-10] (free,scale=-2,gradient)
72   - PivotEnergy ..............: 100 MeV (fixed,scale=100,gradient)
73   - Number of temporal par's ..: 1
74   - Constant .................: 1 (relative value) (fixed,scale=1,gradient)
  48 + >>> pos = gammalib.GSkyDir()
  49 + >>> pos.radec_deg(83.6331, 22.0145)
  50 + >>> spatial = gammalib.GModelSpatialPointSource(pos)
  51 + >>> spectral = gammalib.GModelSpectralPlaw(1.0, -2.0, gammalib.GEnergy(100, 'MeV'))
  52 + >>> model = gammalib.GModelSky(spatial, spectral)
  53 + >>> models.append(model)
  54 + >>> print(models)
  55 + === GModels ===
  56 + Number of models ..........: 1
  57 + Number of parameters ......: 6
  58 + === GModelSky ===
  59 + Name ......................:
  60 + Instruments ...............: all
  61 + Instrument scale factors ..: unity
  62 + Observation identifiers ...: all
  63 + Model type ................: PointSource
  64 + Model components ..........: "PointSource" * "PowerLaw" * "Constant"
  65 + Number of parameters ......: 6
  66 + Number of spatial par's ...: 2
  67 + RA .......................: 83.6331 deg (fixed,scale=1)
  68 + DEC ......................: 22.0145 deg (fixed,scale=1)
  69 + Number of spectral par's ..: 3
  70 + Prefactor ................: 1 +/- 0 [0,infty[ ph/cm2/s/MeV (free,scale=1,gradient)
  71 + Index ....................: -2 +/- 0 [10,-10] (free,scale=-2,gradient)
  72 + PivotEnergy ..............: 100 MeV (fixed,scale=100,gradient)
  73 + Number of temporal par's ..: 1
  74 + Normalization ............: 1 (relative value) (fixed,scale=1,gradient)
75 75  
76 76 With this sequence of commands you first defined a sky direction in
77 77 celestial coordinates using ``GSkyDir``. You may recognise that this
... ... @@ -88,7 +88,8 @@ Among them, you find the specified source position (parameters ``RA`` and
88 88 ``DEC``), the power law normalisation (parameter ``Prefactor``) and the spectral
89 89 index (parameter ``Index``). In addition, the reference energy for the
90 90 normalisation has been set to 100 MeV (parameter ``PivotEnergy``)
91   -and the temporal component has been set by default to a constant (parameter ``Constant``).
  91 +and the temporal component has been set by default to a constant
  92 +(parameter ``Constant``).
92 93  
93 94 Suppose you want to change one of these parameters, such as the
94 95 ``PivotEnergy`` that you want to set to 1 TeV. This can be done using:
... ...