From 10e2ae51d873cbdb0c2420f6ec563dd3a774034d Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Tue, 15 Mar 2022 15:05:02 +0100 Subject: [PATCH] Update documentation --- doc/source/_themes/sphinx13/layout.html | 2 +- doc/source/admin/release_history/2.0.rst | 11 ++++------- doc/source/conf.py | 2 +- doc/source/users/user_manual/introduction.rst | 22 +++++++++++++++++++--- 4 files changed, 25 insertions(+), 12 deletions(-) diff --git a/doc/source/_themes/sphinx13/layout.html b/doc/source/_themes/sphinx13/layout.html index 9b60ab8..756c11d 100755 --- a/doc/source/_themes/sphinx13/layout.html +++ b/doc/source/_themes/sphinx13/layout.html @@ -80,7 +80,7 @@ diff --git a/doc/source/admin/release_history/2.0.rst b/doc/source/admin/release_history/2.0.rst index eddd30a..850755d 100644 --- a/doc/source/admin/release_history/2.0.rst +++ b/doc/source/admin/release_history/2.0.rst @@ -1,7 +1,7 @@ .. _2.0: -ctools 2.0 release (25 February 2022) -===================================== +ctools 2.0 release (15 March 2022) +================================== Overview -------- @@ -11,7 +11,8 @@ ctools 2.0 is a major release that adds significant functionality. In particular, this release provides: * Analysis scripts for the science analysis of COMPTEL data -* ... +* Tracking of the carbon footprint of the ctools usage +* Storing of model fitting results in XML model definition result files Bug fixes @@ -64,7 +65,3 @@ New features * [`3738 `_] - Add COMPTEL analysis scripts * Add :ref:`csadd2caldb` script - - -Clean up --------- diff --git a/doc/source/conf.py b/doc/source/conf.py index f8e60d5..6847c53 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -70,7 +70,7 @@ master_doc = 'contents' # General information about the project. project = u'ctools' -copyright = u'2014-2021, ctools developers' +copyright = u'2014-2022, ctools developers' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/doc/source/users/user_manual/introduction.rst b/doc/source/users/user_manual/introduction.rst index 7556ca5..d15c4f5 100755 --- a/doc/source/users/user_manual/introduction.rst +++ b/doc/source/users/user_manual/introduction.rst @@ -3,9 +3,9 @@ Introduction ============ -ctools is a software package developed for the scientific analysis of -Cherenkov Telescope Array (CTA) data or any other Imaging Air Cherenkov -Telescope. +ctools is a software package developed for the scientific analysis of +gamma-ray astronomy data with emphasis on data from the Cherenkov Telescope +Array (CTA) data or any other Imaging Air Cherenkov Telescope. In this User Manual you will now learn how to use the ctools package. If you encounter any problems, please read the :ref:`sec_help` section. @@ -152,3 +152,19 @@ method before running the tool, for example ... >>> sim.logFileOpen() >>> sim.run() + + +Additional modules +------------------ + +From version 2.0.0 on ctools includes an additional module comprising scripts +for COMPTEL/CGRO data analysis. All COMPTEL scripts start with ``com`` (for example +:ref:`comlixfit` for the fitting of data using the SRCLIX algorithm) and are used +in the same way as the regular ctools or cscripts. All COMPTEL scripts are also +available from Python through a dedicated ``comscripts`` module: + +.. code-block:: python + + >>> import comscripts + >>> fit = comscripts.comlixfit() + -- libgit2 0.21.4