Iftach Sadeh / ctools

Commit b92b2538c94693929b62494eb386a0a946dd614f

Authored by Jürgen Knödlseder
1 parent c00513ce

Update documentation and csinfo script

Inline Side-by-side
Showing 7 changed files with 36 additions and 5 deletions
ChangeLog
  View file @b92b253
... ... @@ -3,7 +3,9 @@
3 3 * Bug fix version 1.7.4 released
4 4 ================================
5 5  
  6 + Add conda activation and deactivation scripts for csh (#3628)
6 7 Replace spectral model by file function in csspec (#3624)
  8 + Update csinfo script (#3623)
7 9  
8 10  
9 11 2020-12-02
... ...
... ... @@ -11,7 +11,8 @@ ctools release with respect to the precedent release.
11 11  
12 12 Configuration
13 13 -------------
14   -None
  14 +conda activation and deactivation scripts were added for csh so that
  15 +an anaconda installation also works for this shell (#3628).
15 16  
16 17  
17 18 Documentation
... ... @@ -169,6 +170,12 @@ csiactobs - Inspect IACT observation definition XML file
169 170 None
170 171  
171 172  
  173 +csinfo - Check ctools installation
  174 +----------------------------------
  175 +The script was updated to comprise the full list of available tools and scripts
  176 +(#3623).
  177 +
  178 +
172 179 cslightcrv - Generate light curve
173 180 ---------------------------------
174 181 None
... ...
cscripts/csinfo.py
  View file @b92b253
... ... @@ -2,7 +2,7 @@
2 2 # ==========================================================================
3 3 # Print info about Gammalib / ctools to the console
4 4 #
5   -# Copyright (C) 2015-2016 Christoph Deil
  5 +# Copyright (C) 2015-2021 Christoph Deil
6 6 #
7 7 # This program is free software: you can redistribute it and/or modify
8 8 # it under the terms of the GNU General Public License as published by
... ... @@ -32,10 +32,13 @@ CTOOL_LIST = """
32 32 ctedispcube Generates energy dispersion cube
33 33 cterror Calculates likelihood profile errors
34 34 ctexpcube Generates exposure cube
  35 + ctfindvar Search for source variability
35 36 ctlike Performs maximum likelihood fitting
36 37 ctmapcube Generates a map cube
37 38 ctmodel Computes model counts cube
38 39 ctobssim Simulate CTA observations
  40 + ctphase Computes the phase of each event
  41 + ctprob Computes event probability for a given model
39 42 ctpsfcube Generates point spread function cube
40 43 ctselect Selects event data
41 44 ctskymap Generates sky map
... ... @@ -47,20 +50,31 @@ CTOOL_LIST = """
47 50 # `doc/source/users/reference_manual/index.rst`
48 51 # and needs to be manually updated and kept in sync
49 52 CSCRIPT_LIST = """
  53 + csbkgmodel Generates background model for 3D analysis
50 54 cscaldb Lists available instrument response functions
  55 + csebins Generates energy boundaries for stacked analysis
51 56 cslightcrv Computes lightcurve
52 57 csinfo Checks ctools and GammaLib installations
53 58 csmodelinfo Shows model container content
54 59 csmodelmerge Merges several model containers into one file
  60 + csmodelselect Select models from model definition file
  61 + csmodelsois Generate map cube from subset of models
55 62 csobsdef Generates observation definition file
56 63 csobsinfo Shows observation container content
  64 + csobsselect Select observations from observation definition file
  65 + csphagen Generates PHA, ARF, RMF files based on source/background regions
  66 + csphasecrv Computes phase curve
57 67 cspull Generates pull distribution
58 68 csresmap Generates residual map
  69 + csresspec Generates residual spectrum
  70 + csscs Performs spectral component separation
59 71 cssens Computes CTA sensitivity
60 72 csspec Computes spectral points
  73 + cssrcdetect Detects sources in sky map
61 74 cstsdist Generates TS distribution
  75 + cstsmapmerge Merges slices from Test Statistic map computations
62 76 cstsmapsplit Creates commands to split the Test Statistic map computations
63   - cstsmapmerge Merges slices from Test Statistic map computations\n
  77 + csviscube Computes visibility cube\n
64 78 csobs2caldb Creates a caldb entry from an input observation
65 79 csroot2caldb Creates a caldb entry from a ROOT performance file
66 80 csiactdata Shows information about IACT data available on the user machine
... ...
doc/source/admin/download.rst
  View file @b92b253
... ... @@ -3,7 +3,7 @@
3 3 Download
4 4 ========
5 5  
6   -The latest ctools release is ``ctools-1.7.3`` (2 December 2020).
  6 +The latest ctools release is ``ctools-1.7.4`` (28 April 2021).
7 7  
8 8 Below a table of ctools releases. Please read the :ref:`sec_release` to
9 9 learn more about new features and corrected bugs in a given release.
... ... @@ -23,6 +23,9 @@ learn more about new features and corrected bugs in a given release.
23 23 * - ctools
24 24 - gammalib
25 25 - Mac OS X (10.7+) binary disk image
  26 + * - `1.7.4 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.7.4.tar.gz>`_
  27 + - `1.7.4 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.7.4.tar.gz>`_
  28 + - `ctools-1.7.4-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.7.4-macosx10.7.dmg>`_
26 29 * - `1.7.3 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.7.3.tar.gz>`_
27 30 - `1.7.3 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.7.3.tar.gz>`_
28 31 - `ctools-1.7.3-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.7.3-macosx10.7.dmg>`_
... ...
doc/source/admin/install_conda.rst
  View file @b92b253
... ... @@ -36,7 +36,7 @@ Installing
36 36  
37 37 .. code-block:: bash
38 38  
39   - $ conda create -n myenv python=3.5 # or one of the following Python versions: 2.7, 3.5, 3.6, 3.7, 3.8
  39 + $ conda create -n myenv python=3.5 # or one of the following Python versions: 2.7, 3.5, 3.6, 3.7, 3.8, 3.9
40 40 $ conda activate myenv
41 41 (myenv) $
42 42  
... ...
doc/source/admin/release_history/1.7.4.rst
  View file @b92b253
... ... @@ -10,5 +10,9 @@ ctools 1.7.4 is a bug fix release for ctools release 1.7.
10 10  
11 11 The following bugs were fixed:
12 12  
  13 +* [`3628 <https://cta-redmine.irap.omp.eu/issues/3628>`_] -
  14 + Add conda activation and deactivation scripts for csh
13 15 * [`3624 <https://cta-redmine.irap.omp.eu/issues/3624>`_] -
14 16 Replace spectral model by file function in :ref:`csspec`
  17 +* [`3623 <https://cta-redmine.irap.omp.eu/issues/3623>`_] -
  18 + Update csinfo script
... ...
doc/source/develop/releasing/index.rst
  View file @b92b253
... ... @@ -21,4 +21,5 @@ To create a new ctools release you have to go through the following steps:
21 21 * added unit tests for all new code
22 22 * added a page about the software changes to the release history
23 23 * updated the User documentation if necessary
  24 + * updated the csinfo script if necessary
24 25  
... ...