Commit cd7636ca64d10303ebed5c9477974ad40a38d358
1 parent
1f64ddfa
Move the FAQ to the root folder, and a "Known issues" document, and add informat…
…ion about the limitations of the Broken power law and the parameters update.
Showing
3 changed files
with
21 additions
and
2 deletions
doc/source/_templates/index.html
| ... | ... | @@ -37,7 +37,6 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}</p> |
| 37 | 37 | <li><a class="smalllink" href="{{ pathto("user_manual/getting_started/models") }}">{%trans%}Modelling CTA data{%endtrans%}</a></li> |
| 38 | 38 | <li><a class="smalllink" href="{{ pathto("user_manual/getting_started/response") }}">{%trans%}CTA response functions{%endtrans%}</a></li> |
| 39 | 39 | <li><a class="smalllink" href="{{ pathto("user_manual/getting_started/python") }}">{%trans%}Using ctools from Python{%endtrans%}</a></li> |
| 40 | -<li><a class="smalllink" href="{{ pathto("user_manual/getting_started/faq") }}">{%trans%}Frequently asked questions{%endtrans%}</a></li> | |
| 41 | 40 | </ul> |
| 42 | 41 | |
| 43 | 42 | <h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2> |
| ... | ... | @@ -45,6 +44,8 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}</p> |
| 45 | 44 | <ul> |
| 46 | 45 | <li><a class="smalllink" href="{{ pathto("user_manual/index") }}">{%trans%}User Manual{%endtrans%}</a></li> |
| 47 | 46 | <li><a class="smalllink" href="{{ pathto("reference_manual/index") }}">{%trans%}Reference Manual{%endtrans%}</a></li> |
| 47 | +<li><a class="smalllink" href="{{ pathto("faq") }}">{%trans%}Frequently asked questions{%endtrans%}</a></li> | |
| 48 | +<li><a class="smalllink" href="{{ pathto("issues") }}">{%trans%}Known issues{%endtrans%}</a></li> | |
| 48 | 49 | <li><a class="smalllink" href="doxygen/index.html">{%trans%}Source code documentation (Doxygen){%endtrans%}</a></li> |
| 49 | 50 | </ul> |
| 50 | 51 | ... | ... |
doc/source/user_manual/getting_started/faq.rst renamed to doc/source/faq.rst
| ... | ... | @@ -15,6 +15,7 @@ asked. |
| 15 | 15 | - :ref:`What is the difference between ctools and GammaLib? <faq_ctools_gammalib>` |
| 16 | 16 | - :ref:`Are ctools and GammaLib specific to CTA? <faq_instruments>` |
| 17 | 17 | - :ref:`I want to upgrade ctools, do I have to upgrade GammaLib? <faq_upgrade>` |
| 18 | +- :ref:`Why does my ctool complain about missing parameters? <faq_pars>` | |
| 18 | 19 | |
| 19 | 20 | |
| 20 | 21 | .. _faq_ctools_gammalib: |
| ... | ... | @@ -77,3 +78,21 @@ asked. |
| 77 | 78 | (see the :ref:`download` section for a correspondance of versions). |
| 78 | 79 | We plan however to put the GammaLib interface under change control. |
| 79 | 80 | ctools should then become more independent from GammaLib. |
| 81 | + | |
| 82 | + | |
| 83 | +.. _faq_pars: | |
| 84 | + | |
| 85 | +.. topic:: Why does my ctool complain about missing parameters? | |
| 86 | + | |
| 87 | + After upgrading to a new ctools version, a ctool may issue the following | |
| 88 | + error | |
| 89 | + | |
| 90 | + ``*** ERROR in GApplicationPars::operator[](std::string&): Invalid | |
| 91 | + argument. Parameter "XXX" has not been found in parameter file. | |
| 92 | + Please specify a valid parameter name.`` | |
| 93 | + | |
| 94 | + This error may occur if some parameters have been added to a ctool and | |
| 95 | + you still have the old parameter file without that parameter sitting in | |
| 96 | + your pfiles folder. Simply erasing all files in the pfiles folder should | |
| 97 | + fix this problem. | |
| 98 | + | ... | ... |