Commit 15a65dfd10978d1cc2a536de878c349d0e153328
1 parent
2add83c1
Update download and FAQ pages of documentation.
Showing
2 changed files
with
56 additions
and
10 deletions
doc/source/download.rst
| ... | ... | @@ -15,6 +15,13 @@ Releases |
| 15 | 15 | |
| 16 | 16 | The latest ctools release is ``ctools-0.9.0`` (22 May 2015). |
| 17 | 17 | |
| 18 | +.. note:: | |
| 19 | + | |
| 20 | + The cscripts in the Mac OS X binary package ctools-0.9.0-macosx10.3.dmg | |
| 21 | + were not working. If you encounter a problem please download the updated | |
| 22 | + binary package | |
| 23 | + `ctools-0.9.1-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.1-macosx10.3.dmg>`_. | |
| 24 | + | |
| 18 | 25 | Below a table of ctools releases. Please note that at this stage of the |
| 19 | 26 | project there is a strict link between the ctools and gammalib versions. |
| 20 | 27 | Please make sure that you have the corresponding gammalib version installed |
| ... | ... | @@ -30,7 +37,7 @@ gammalib. |
| 30 | 37 | - Mac OS X package |
| 31 | 38 | * - `0.9.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.0.tar.gz>`_ |
| 32 | 39 | - `0.10.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-0.10.0.tar.gz>`_ |
| 33 | - - `ctools-0.9.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.0-macosx10.3.dmg>`_ | |
| 40 | + - `ctools-0.9.1-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.1-macosx10.3.dmg>`_ | |
| 34 | 41 | * - `0.8.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-01.tar.gz>`_ |
| 35 | 42 | - `0.9.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-09-01.tar.gz>`_ |
| 36 | 43 | - `ctools-00-08-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-01-macosx10.3.dmg>`_ |
| ... | ... | @@ -71,25 +78,46 @@ gammalib. |
| 71 | 78 | - `0.4.7 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-07.tar.gz>`_ |
| 72 | 79 | - |
| 73 | 80 | |
| 81 | + | |
| 74 | 82 | Git repository |
| 75 | 83 | -------------- |
| 76 | 84 | |
| 77 | -To clone the ctools source code, type | |
| 85 | +To clone the gammalib and ctools source codes, type | |
| 78 | 86 | |
| 79 | 87 | .. code-block:: bash |
| 80 | 88 | |
| 81 | - $ git clone https://cta-git.irap.omp.eu/ctools | |
| 89 | + $ git clone https://cta-git.irap.omp.eu/gammalib | |
| 90 | + $ git clone https://cta-git.irap.omp.eu/ctools | |
| 82 | 91 | |
| 83 | -This will create a directory named ctools under the current working directory | |
| 84 | -that will contain the ctools source code. Before you are able to compile the | |
| 85 | -code you need to generate the configuration file (make sure that you're | |
| 86 | -actually on the devel branch of the git repository): | |
| 92 | +This will create directories named gammalib and ctools under the current working | |
| 93 | +directory that will contain the gammalib and ctools source code. Before you are able | |
| 94 | +to compile the code you need to generate the configuration file using the | |
| 95 | +``autogen.sh`` script. Also make sure that you're actually on the devel branch of the git | |
| 96 | +repository. GammaLib and ctools can be compiled using the following | |
| 97 | +command sequence (the code will be installed into the ``/usr/local/gamma`` | |
| 98 | +directory): | |
| 87 | 99 | |
| 88 | 100 | .. code-block:: bash |
| 89 | 101 | |
| 90 | - $ cd ctools | |
| 91 | - $ git checkout devel | |
| 92 | - $ ./autogen.sh | |
| 102 | + $ cd gammalib | |
| 103 | + $ git checkout devel | |
| 104 | + $ ./autogen.sh | |
| 105 | + $ ./configure | |
| 106 | + $ make | |
| 107 | + $ make check | |
| 108 | + $ sudo make install | |
| 109 | + $ export GAMMALIB=/usr/local/gamma | |
| 110 | + $ source $GAMMALIB/bin/gammalib-init.sh | |
| 111 | + $ cd .. | |
| 112 | + $ cd ctools | |
| 113 | + $ git checkout devel | |
| 114 | + $ ./autogen.sh | |
| 115 | + $ ./configure | |
| 116 | + $ make | |
| 117 | + $ make check | |
| 118 | + $ sudo make install | |
| 119 | + $ export CTOOLS=/usr/local/gamma | |
| 120 | + $ source $CTOOLS/bin/ctools-init.sh | |
| 93 | 121 | |
| 94 | 122 | .. note:: |
| 95 | 123 | ... | ... |
doc/source/faq.rst
| ... | ... | @@ -17,6 +17,7 @@ asked. |
| 17 | 17 | - :ref:`I want to upgrade ctools, do I have to upgrade GammaLib? <faq_upgrade>` |
| 18 | 18 | - :ref:`Why does my ctool complain about missing parameters? <faq_pars>` |
| 19 | 19 | - :ref:`Should I used binned or unbinned analysis? <faq_analysis>` |
| 20 | +- :ref:`How precise are ctools? <faq_precision>` | |
| 20 | 21 | |
| 21 | 22 | |
| 22 | 23 | .. _faq_ctools_gammalib: |
| ... | ... | @@ -119,3 +120,20 @@ asked. |
| 119 | 120 | the line may require a prohibitive large number of energy bins for a binned |
| 120 | 121 | analysis. |
| 121 | 122 | |
| 123 | + | |
| 124 | +.. _faq_precision: | |
| 125 | + | |
| 126 | +.. topic:: How precise are ctools? | |
| 127 | + | |
| 128 | + The ctools and gammalib codes have a numerical accuracy of better than 1%. | |
| 129 | + This means that if you use ctools to determine for example the flux | |
| 130 | + received from a source or the spectral points of an SED, the relative | |
| 131 | + precision of the flux or the spectral points is better than 1%. | |
| 132 | + The same is true for spatial parameters, such as source position or | |
| 133 | + source extension. | |
| 134 | + For many cases the actual numerical precision is in fact much better | |
| 135 | + than 1%, but in any case, it should never be worse. | |
| 136 | + Note, however, that this does not imply that source parameters can be | |
| 137 | + determined with CTA with an accuracy of 1%. The accuracy depends in the | |
| 138 | + end on the precision to which the instrument response function is known, | |
| 139 | + which should be more in the 10% range. | ... | ... |