Commit 10e2ae51d873cbdb0c2420f6ec563dd3a774034d
1 parent
cb85eb84
Update documentation
Showing
4 changed files
with
25 additions
and
12 deletions
doc/source/_themes/sphinx13/layout.html
| ... | ... | @@ -80,7 +80,7 @@ |
| 80 | 80 | <div class=banner_part></div> |
| 81 | 81 | <div class=banner_part> |
| 82 | 82 | <span id="banner_text1">ctools</span><br/> |
| 83 | - <span id="banner_text2">The Gamma-ray Astronomy Science Analysis Software</span> | |
| 83 | + <span id="banner_text2">Gamma-ray Astronomy Science Analysis Software</span> | |
| 84 | 84 | </div> |
| 85 | 85 | </a> |
| 86 | 86 | </div> | ... | ... |
doc/source/admin/release_history/2.0.rst
| 1 | 1 | .. _2.0: |
| 2 | 2 | |
| 3 | -ctools 2.0 release (25 February 2022) | |
| 4 | -===================================== | |
| 3 | +ctools 2.0 release (15 March 2022) | |
| 4 | +================================== | |
| 5 | 5 | |
| 6 | 6 | Overview |
| 7 | 7 | -------- |
| ... | ... | @@ -11,7 +11,8 @@ ctools 2.0 is a major release that adds significant functionality. |
| 11 | 11 | In particular, this release provides: |
| 12 | 12 | |
| 13 | 13 | * Analysis scripts for the science analysis of COMPTEL data |
| 14 | -* ... | |
| 14 | +* Tracking of the carbon footprint of the ctools usage | |
| 15 | +* Storing of model fitting results in XML model definition result files | |
| 15 | 16 | |
| 16 | 17 | |
| 17 | 18 | Bug fixes |
| ... | ... | @@ -64,7 +65,3 @@ New features |
| 64 | 65 | * [`3738 <https://cta-redmine.irap.omp.eu/issues/3738>`_] - |
| 65 | 66 | Add COMPTEL analysis scripts |
| 66 | 67 | * Add :ref:`csadd2caldb` script |
| 67 | - | |
| 68 | - | |
| 69 | -Clean up | |
| 70 | --------- | ... | ... |
doc/source/conf.py
| ... | ... | @@ -70,7 +70,7 @@ master_doc = 'contents' |
| 70 | 70 | |
| 71 | 71 | # General information about the project. |
| 72 | 72 | project = u'ctools' |
| 73 | -copyright = u'2014-2021, ctools developers' | |
| 73 | +copyright = u'2014-2022, ctools developers' | |
| 74 | 74 | |
| 75 | 75 | # The version info for the project you're documenting, acts as replacement for |
| 76 | 76 | # |version| and |release|, also used in various other places throughout the | ... | ... |
doc/source/users/user_manual/introduction.rst
| ... | ... | @@ -3,9 +3,9 @@ |
| 3 | 3 | Introduction |
| 4 | 4 | ============ |
| 5 | 5 | |
| 6 | -ctools is a software package developed for the scientific analysis of | |
| 7 | -Cherenkov Telescope Array (CTA) data or any other Imaging Air Cherenkov | |
| 8 | -Telescope. | |
| 6 | +ctools is a software package developed for the scientific analysis of | |
| 7 | +gamma-ray astronomy data with emphasis on data from the Cherenkov Telescope | |
| 8 | +Array (CTA) data or any other Imaging Air Cherenkov Telescope. | |
| 9 | 9 | |
| 10 | 10 | In this User Manual you will now learn how to use the ctools package. |
| 11 | 11 | If you encounter any problems, please read the :ref:`sec_help` section. |
| ... | ... | @@ -152,3 +152,19 @@ method before running the tool, for example |
| 152 | 152 | ... |
| 153 | 153 | >>> sim.logFileOpen() |
| 154 | 154 | >>> sim.run() |
| 155 | + | |
| 156 | + | |
| 157 | +Additional modules | |
| 158 | +------------------ | |
| 159 | + | |
| 160 | +From version 2.0.0 on ctools includes an additional module comprising scripts | |
| 161 | +for COMPTEL/CGRO data analysis. All COMPTEL scripts start with ``com`` (for example | |
| 162 | +:ref:`comlixfit` for the fitting of data using the SRCLIX algorithm) and are used | |
| 163 | +in the same way as the regular ctools or cscripts. All COMPTEL scripts are also | |
| 164 | +available from Python through a dedicated ``comscripts`` module: | |
| 165 | + | |
| 166 | +.. code-block:: python | |
| 167 | + | |
| 168 | + >>> import comscripts | |
| 169 | + >>> fit = comscripts.comlixfit() | |
| 170 | + | ... | ... |