From cd7636ca64d10303ebed5c9477974ad40a38d358 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Tue, 30 Jun 2015 12:45:50 +0200 Subject: [PATCH] Move the FAQ to the root folder, and a "Known issues" document, and add information about the limitations of the Broken power law and the parameters update. --- doc/source/_templates/index.html | 3 ++- doc/source/faq.rst | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/user_manual/getting_started/faq.rst | 79 ------------------------------------------------------------------------------- doc/source/user_manual/getting_started/index.rst | 1 - 4 files changed, 100 insertions(+), 81 deletions(-) create mode 100644 doc/source/faq.rst delete mode 100644 doc/source/user_manual/getting_started/faq.rst diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html index 2456023..5a56949 100644 --- a/doc/source/_templates/index.html +++ b/doc/source/_templates/index.html @@ -37,7 +37,6 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}

  • {%trans%}Modelling CTA data{%endtrans%}
  • {%trans%}CTA response functions{%endtrans%}
  • {%trans%}Using ctools from Python{%endtrans%}
    • -
  • {%trans%}Frequently asked questions{%endtrans%}

    • {%trans%}Documentation{%endtrans%}

    @@ -45,6 +44,8 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}

    diff --git a/doc/source/faq.rst b/doc/source/faq.rst new file mode 100644 index 0000000..bd0f626 --- /dev/null +++ b/doc/source/faq.rst @@ -0,0 +1,98 @@ +.. _faq: + +Frequently asked questions +-------------------------- + +Below you will find a list of frequently asked questions that has been +compiled from your user experience and feedback. +In case that you do not find an answer to your question on this page you +may post your question on the ctools@irap.omp.eu mailing list. +To subscribe to this list you simply need to send an e-mail to +ctools-subscribe@irap.omp.eu (content is irrelevant). +This page will be regularily updated based on the most frequent questions +asked. + +- :ref:`What is the difference between ctools and GammaLib? ` +- :ref:`Are ctools and GammaLib specific to CTA? ` +- :ref:`I want to upgrade ctools, do I have to upgrade GammaLib? ` +- :ref:`Why does my ctool complain about missing parameters? ` + + +.. _faq_ctools_gammalib: + +.. topic:: What is the difference between ctools and GammaLib? + + To use a metaphor, ctools is like a village composed of indivdual + buildings with different purposes (a school, a church, a townhall, + a shop, etc.) while GammaLib is like the bricks that are common to all + buildings of the village. + + GammaLib is all about the objects you need to assemble a tool. + Examples of such objects are "photons", "events", "energies", "times", + "time intervals", "observations", "pointing directions", etc. + ctools will put these objects in order to create the functionalities + that are needed for the analysis of CTA data. + Examples of such functionalities are "selecting events", "generating a sky + map", "fitting a spectrum", "generating a light curve", etc. + All the inner workings of the objects happen in GammaLib, while ctools + essentially provides the concrete to tie the objects together. + In terms of complexity, 95% of the arithemtics are done in GammaLib while + ctools is mainly doing some housekeeping. + + +.. _faq_instruments: + +.. topic:: Are ctools and GammaLib specific to CTA? + + The short answer is: ctools yes, GammaLib no. + + ctools have been specifically designed to provide the functionalities that + are required to analyse CTA data. + This does not mean that ctools can not be used for analysing data from + other Imaging Air Cherenkov Telescopes; the sole requirement is that the + data and response files are provided in a CTA compliant format. + However, ctools are not designed to analyse data from Fermi/LAT, + INTEGRAL, COMPTEL or other gamma-ray telescopes. + Nevertheless, some joint multi-telescope analysis is supported by ctools. + + GammaLib, however, is a universal framework with a core that is completely + independent of any telescope. + Plugins are used to interface GammaLib with the data and response files of + specific telescopes. + For every new instrument that shall be supported a new plugin needs to be + developed. + So far, plugins exists for CTA (and Imaging Air Cherenkov Telescopes in + general), Fermi/LAT, and COMPTEL. + Some support for integration of any arbitrary multi-wavelength data + exists. + + +.. _faq_upgrade: + +.. topic:: I want to upgrade ctools, do I have to upgrade GammaLib? + + For the moment yes. + + The GammaLib interface is still not fully stabilised, hence ctools is + continuously adapted to match the interface evolution + (see the :ref:`download` section for a correspondance of versions). + We plan however to put the GammaLib interface under change control. + ctools should then become more independent from GammaLib. + + +.. _faq_pars: + +.. topic:: Why does my ctool complain about missing parameters? + + After upgrading to a new ctools version, a ctool may issue the following + error + + ``*** ERROR in GApplicationPars::operator[](std::string&): Invalid + argument. Parameter "XXX" has not been found in parameter file. + Please specify a valid parameter name.`` + + This error may occur if some parameters have been added to a ctool and + you still have the old parameter file without that parameter sitting in + your pfiles folder. Simply erasing all files in the pfiles folder should + fix this problem. + diff --git a/doc/source/user_manual/getting_started/faq.rst b/doc/source/user_manual/getting_started/faq.rst deleted file mode 100644 index 7058d9e..0000000 --- a/doc/source/user_manual/getting_started/faq.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _faq: - -Frequently asked questions --------------------------- - -Below you will find a list of frequently asked questions that has been -compiled from your user experience and feedback. -In case that you do not find an answer to your question on this page you -may post your question on the ctools@irap.omp.eu mailing list. -To subscribe to this list you simply need to send an e-mail to -ctools-subscribe@irap.omp.eu (content is irrelevant). -This page will be regularily updated based on the most frequent questions -asked. - -- :ref:`What is the difference between ctools and GammaLib? ` -- :ref:`Are ctools and GammaLib specific to CTA? ` -- :ref:`I want to upgrade ctools, do I have to upgrade GammaLib? ` - - -.. _faq_ctools_gammalib: - -.. topic:: What is the difference between ctools and GammaLib? - - To use a metaphor, ctools is like a village composed of indivdual - buildings with different purposes (a school, a church, a townhall, - a shop, etc.) while GammaLib is like the bricks that are common to all - buildings of the village. - - GammaLib is all about the objects you need to assemble a tool. - Examples of such objects are "photons", "events", "energies", "times", - "time intervals", "observations", "pointing directions", etc. - ctools will put these objects in order to create the functionalities - that are needed for the analysis of CTA data. - Examples of such functionalities are "selecting events", "generating a sky - map", "fitting a spectrum", "generating a light curve", etc. - All the inner workings of the objects happen in GammaLib, while ctools - essentially provides the concrete to tie the objects together. - In terms of complexity, 95% of the arithemtics are done in GammaLib while - ctools is mainly doing some housekeeping. - - -.. _faq_instruments: - -.. topic:: Are ctools and GammaLib specific to CTA? - - The short answer is: ctools yes, GammaLib no. - - ctools have been specifically designed to provide the functionalities that - are required to analyse CTA data. - This does not mean that ctools can not be used for analysing data from - other Imaging Air Cherenkov Telescopes; the sole requirement is that the - data and response files are provided in a CTA compliant format. - However, ctools are not designed to analyse data from Fermi/LAT, - INTEGRAL, COMPTEL or other gamma-ray telescopes. - Nevertheless, some joint multi-telescope analysis is supported by ctools. - - GammaLib, however, is a universal framework with a core that is completely - independent of any telescope. - Plugins are used to interface GammaLib with the data and response files of - specific telescopes. - For every new instrument that shall be supported a new plugin needs to be - developed. - So far, plugins exists for CTA (and Imaging Air Cherenkov Telescopes in - general), Fermi/LAT, and COMPTEL. - Some support for integration of any arbitrary multi-wavelength data - exists. - - -.. _faq_upgrade: - -.. topic:: I want to upgrade ctools, do I have to upgrade GammaLib? - - For the moment yes. - - The GammaLib interface is still not fully stabilised, hence ctools is - continuously adapted to match the interface evolution - (see the :ref:`download` section for a correspondance of versions). - We plan however to put the GammaLib interface under change control. - ctools should then become more independent from GammaLib. diff --git a/doc/source/user_manual/getting_started/index.rst b/doc/source/user_manual/getting_started/index.rst index f703ede..57b6851 100644 --- a/doc/source/user_manual/getting_started/index.rst +++ b/doc/source/user_manual/getting_started/index.rst @@ -9,5 +9,4 @@ Getting started models response python - faq -- libgit2 0.21.4