Commit b23bffe2e2f7083101add9eb365cfbff52cf0afb
1 parent
251d1e2f
Update Welcome and About text
Showing
4 changed files
with
55 additions
and
51 deletions
doc/source/_templates/index.html
| 1 | 1 | {% extends "layout.html" %} {% set title = _('Overview') %} {% block |
| 2 | 2 | body %} |
| 3 | -<h1>{{ _('ctools') }}</h1> | |
| 4 | 3 | |
| 5 | -<p>{%trans%} ctools is a software package developed for the scientific | |
| 6 | -analysis of Cherenkov telescope data, such as H.E.S.S., MAGIC, VERITAS or | |
| 7 | -CTA. | |
| 4 | +<p>{%trans%} ctools is a software package for the scientific analysis of | |
| 5 | +astronomical gamma-ray data. The package comprises an extensive set of tools | |
| 6 | +for the analysis of data from existing and future Cherenkov telescopes, | |
| 7 | +including H.E.S.S., VERITAS, MAGIC and CTA. ctools supports also the analysis | |
| 8 | +of data from CGRO/COMPTEL, Fermi/LAT and INTEGRAL/SPI, enabling the exploration | |
| 9 | +of the full gamma-ray energy band, spanning from hundreds of keV to hundreds of | |
| 10 | +TeV. {%endtrans%}</p> | |
| 11 | + | |
| 12 | +<p>{%trans%} The ctools philosophy inherited from ftools consists of providing | |
| 13 | +building blocks that perform well-defined science data analysis tasks, including | |
| 14 | +observation and event selection, binning, sky map creation, source detection, | |
| 15 | +model fitting, spectra, phase curve and light curve generation, and observation | |
| 16 | +simulations. The building blocks are then combined by the user to create flexible | |
| 17 | +analysis workflows that can fit the needs of any scientist. {%endtrans%}</p> | |
| 18 | + | |
| 19 | +<p>{%trans%} ctools can be used as command-line executables alike ftools to carry | |
| 20 | +out simple analyses even for users without any programming skills. Furthermore, | |
| 21 | +the tools are accessible through dedicated Python modules providing an alternative | |
| 22 | +user interface to the software, as well as the possibility to provide tutorials | |
| 23 | +in the form of Jupyter notebooks. Shell or Python scripts can be used by more | |
| 24 | +advanced users to build analysis pipelines to any degrees of complexity. | |
| 8 | 25 | {%endtrans%}</p> |
| 9 | 26 | |
| 10 | -<p>{%trans%} ctools comprises a set of ftools-like binary executables and | |
| 11 | -Python scripts with a command-line interface allowing for interactive step-wise | |
| 12 | -data analysis. ctools includes also Python modules to control all tools and | |
| 13 | -scripts from within Python. Creation of shell or Python scripts and pipelines | |
| 14 | -is supported as well. {%endtrans%}</p> | |
| 15 | - | |
| 16 | 27 | <p>{%trans%} ctools are based on <a href="http://cta.irap.omp.eu/gammalib">GammaLib</a>, |
| 17 | 28 | a versatile toolbox for the scientific analysis of astronomical gamma-ray data. |
| 18 | -GammaLib supports the analysis of H.E.S.S., MAGIC, VERITAS, CTA, Fermi/LAT, | |
| 19 | -CGRO/COMPTEL and INTEGRAL/SPI data. GammaLib supports in particular the | |
| 20 | -combination of data from different instruments in a true joint multi-wavelength | |
| 21 | -analysis that consistently handles the response of each instrument. An interface | |
| 22 | -to virtual observatory resources does also exist. | |
| 23 | 29 | {%endtrans%}</p> |
| 24 | 30 | |
| 25 | 31 | <p>{%trans%} ctools are developed by a community of enthousiastic gamma-ray |
| 26 | -astronomers with support from engineers. The lead institute is</p> | |
| 32 | +astronomers with support from engineers. The lead institute is | |
| 33 | +{%endtrans%}</p> | |
| 27 | 34 | |
| 28 | 35 | <table cellpadding="0" cellspacing="0" border="0"> |
| 29 | 36 | <tr> |
| ... | ... | @@ -31,7 +38,8 @@ astronomers with support from engineers. The lead institute is</p> |
| 31 | 38 | </tr> |
| 32 | 39 | </table> |
| 33 | 40 | |
| 34 | -<p>As of today there have been contributions by the following institutions:</p> | |
| 41 | +<p>{%trans%} As of today there have been contributions by the following institutions: | |
| 42 | +{%endtrans%}</p> | |
| 35 | 43 | |
| 36 | 44 | <table cellpadding="0" cellspacing="0" border="0"> |
| 37 | 45 | <tr> |
| ... | ... | @@ -44,12 +52,6 @@ astronomers with support from engineers. The lead institute is</p> |
| 44 | 52 | </tr> |
| 45 | 53 | </table> |
| 46 | 54 | |
| 47 | -<p>We regularily organise | |
| 48 | -<a href=https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Coding_sprints>coding sprints</a> | |
| 49 | -where key developers but also newcomers meet to discuss the developments | |
| 50 | -and next steps, and advance with the coding of the software. | |
| 51 | -{%endtrans%}</p> | |
| 52 | - | |
| 53 | 55 | <p>{%trans%} ctools is free software distributed under the |
| 54 | 56 | <a href="http://www.gnu.org/licenses/gpl.html">GNU GPL license version 3</a> |
| 55 | 57 | {%endtrans%}</p> | ... | ... |
doc/source/_themes/sphinx13/layout.html
| ... | ... | @@ -79,8 +79,8 @@ |
| 79 | 79 | <div class=banner_part></div> |
| 80 | 80 | <div class=banner_part></div> |
| 81 | 81 | <div class=banner_part> |
| 82 | - <span id="banner_text1">Cherenkov Telescope</span><br/> | |
| 83 | - <span id="banner_text2">Science Analysis Software</span> | |
| 82 | + <span id="banner_text1">ctools</span><br/> | |
| 83 | + <span id="banner_text2">The Gamma-ray Astronomy Science Analysis Software</span> | |
| 84 | 84 | </div> |
| 85 | 85 | </a> |
| 86 | 86 | </div> | ... | ... |
doc/source/about.rst
| ... | ... | @@ -3,29 +3,32 @@ |
| 3 | 3 | About |
| 4 | 4 | ===== |
| 5 | 5 | |
| 6 | -ctools is a software package developed for the scientific analysis of | |
| 7 | -Cherenkov telescope data, such as H.E.S.S., MAGIC, VERITAS or CTA. | |
| 8 | - | |
| 9 | -ctools comprises a set of ftools-like binary executables and Python scripts | |
| 10 | -with a command-line interface allowing for interactive step-wise data analysis. | |
| 11 | -ctools includes also Python modules to control all tools and scripts from | |
| 12 | -within Python. | |
| 13 | -Creation of shell or Python scripts and pipelines is supported as well. | |
| 14 | - | |
| 15 | -ctools are based on GammaLib, a versatile toolbox for the scientific | |
| 16 | -analysis of astronomical gamma-ray data. | |
| 17 | -GammaLib supports the analysis of H.E.S.S., MAGIC, VERITAS, CTA, Fermi/LAT, | |
| 18 | -CGRO/COMPTEL and INTEGRAL/SPI data. | |
| 19 | -GammaLib supports in particular the combination of data from different instruments | |
| 20 | -in a true joint multi-wavelength analysis that consistently handles the response | |
| 21 | -of each instrument. | |
| 22 | -An interface to virtual observatory resources does also exist. | |
| 6 | +ctools is a software package for the scientific analysis of astronomical | |
| 7 | +gamma-ray data. The package comprises an extensive set of tools for the analysis | |
| 8 | +of data from existing and future Cherenkov telescopes, including H.E.S.S., | |
| 9 | +VERITAS, MAGIC and CTA. ctools supports also the analysis of data from | |
| 10 | +CGRO/COMPTEL, Fermi/LAT and INTEGRAL/SPI, enabling the exploration of the full | |
| 11 | +gamma-ray energy band, spanning from hundreds of keV to hundreds of TeV. | |
| 12 | + | |
| 13 | +The ctools philosophy inherited from ftools consists of providing building | |
| 14 | +blocks that perform well-defined science data analysis tasks, including | |
| 15 | +observation and event selection, binning, sky map creation, source detection, | |
| 16 | +model fitting, spectra, phase curve and light curve generation, and observation | |
| 17 | +simulations. The building blocks are then combined by the user to create | |
| 18 | +flexible analysis workflows that can fit the needs of any scientist. | |
| 19 | + | |
| 20 | +ctools can be used as command-line executables alike ftools to carry out simple | |
| 21 | +analyses even for users without any programming skills. Furthermore, the tools | |
| 22 | +are accessible through dedicated Python modules providing an alternative user | |
| 23 | +interface to the software, as well as the possibility to provide tutorials in | |
| 24 | +the form of Jupyter notebooks. Shell or Python scripts can be used by more | |
| 25 | +advanced users to build analysis pipelines to any degrees of complexity. | |
| 26 | + | |
| 27 | +ctools are based on `GammaLib <http://cta.irap.omp.eu/gammalib>`_, a versatile | |
| 28 | +toolbox for the scientific analysis of astronomical gamma-ray data. | |
| 23 | 29 | |
| 24 | 30 | ctools are developed by a team of enthousiastic gamma-ray astronomers with |
| 25 | -support from engineers. We regularily organise | |
| 26 | -`coding sprints <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Coding_sprints>`_ | |
| 27 | -where key developers but also newcomers meet to discuss the developments | |
| 28 | -and next steps, and advance with the coding of the software. | |
| 31 | +support from engineers. | |
| 29 | 32 | |
| 30 | 33 | |
| 31 | 34 | Acknowledging or citing ctools |
| ... | ... | @@ -64,10 +67,9 @@ for GammaLib. |
| 64 | 67 | |
| 65 | 68 | In addition please add the following acknowledgment: |
| 66 | 69 | |
| 67 | - *This research made use of ctools, a community-developed analysis package | |
| 68 | - for Imaging Air Cherenkov Telescope data. ctools is based on GammaLib, | |
| 69 | - a community-developed toolbox for the scientific analysis of astronomical | |
| 70 | - gamma-ray data.* | |
| 70 | + *This research made use of ctools, a community-developed gamma-ray astronomy | |
| 71 | + science analysis software. ctools is based on GammaLib, a community-developed | |
| 72 | + toolbox for the scientific analysis of astronomical gamma-ray data.* | |
| 71 | 73 | |
| 72 | 74 | If the journal allows this, you can also include a link to |
| 73 | 75 | http://cta.irap.omp.eu/ctools/ in addition to the above text. | ... | ... |
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-2019, ctools developers' | |
| 73 | +copyright = u'2014-2021, 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 | ... | ... |