From b23bffe2e2f7083101add9eb365cfbff52cf0afb Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Thu, 24 Jun 2021 22:18:52 +0200 Subject: [PATCH] Update Welcome and About text --- doc/source/_templates/index.html | 48 +++++++++++++++++++++++++----------------------- doc/source/_themes/sphinx13/layout.html | 4 ++-- doc/source/about.rst | 52 +++++++++++++++++++++++++++------------------------- doc/source/conf.py | 2 +- 4 files changed, 55 insertions(+), 51 deletions(-) diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html index 22789c2..a527bc9 100755 --- a/doc/source/_templates/index.html +++ b/doc/source/_templates/index.html @@ -1,29 +1,36 @@ {% extends "layout.html" %} {% set title = _('Overview') %} {% block body %} -

{{ _('ctools') }}

-

{%trans%} ctools is a software package developed for the scientific -analysis of Cherenkov telescope data, such as H.E.S.S., MAGIC, VERITAS or -CTA. +

{%trans%} ctools is a software package for the scientific analysis of +astronomical gamma-ray data. The package comprises an extensive set of tools +for the analysis of data from existing and future Cherenkov telescopes, +including H.E.S.S., VERITAS, MAGIC and CTA. ctools supports also the analysis +of data from CGRO/COMPTEL, Fermi/LAT and INTEGRAL/SPI, enabling the exploration +of the full gamma-ray energy band, spanning from hundreds of keV to hundreds of +TeV. {%endtrans%}

+ +

{%trans%} The ctools philosophy inherited from ftools consists of providing +building blocks that perform well-defined science data analysis tasks, including +observation and event selection, binning, sky map creation, source detection, +model fitting, spectra, phase curve and light curve generation, and observation +simulations. The building blocks are then combined by the user to create flexible +analysis workflows that can fit the needs of any scientist. {%endtrans%}

+ +

{%trans%} ctools can be used as command-line executables alike ftools to carry +out simple analyses even for users without any programming skills. Furthermore, +the tools are accessible through dedicated Python modules providing an alternative +user interface to the software, as well as the possibility to provide tutorials +in the form of Jupyter notebooks. Shell or Python scripts can be used by more +advanced users to build analysis pipelines to any degrees of complexity. {%endtrans%}

-

{%trans%} ctools comprises a set of ftools-like binary executables and -Python scripts with a command-line interface allowing for interactive step-wise -data analysis. ctools includes also Python modules to control all tools and -scripts from within Python. Creation of shell or Python scripts and pipelines -is supported as well. {%endtrans%}

-

{%trans%} ctools are based on GammaLib, a versatile toolbox for the scientific analysis of astronomical gamma-ray data. -GammaLib supports the analysis of H.E.S.S., MAGIC, VERITAS, CTA, Fermi/LAT, -CGRO/COMPTEL and INTEGRAL/SPI data. GammaLib supports in particular the -combination of data from different instruments in a true joint multi-wavelength -analysis that consistently handles the response of each instrument. An interface -to virtual observatory resources does also exist. {%endtrans%}

{%trans%} ctools are developed by a community of enthousiastic gamma-ray -astronomers with support from engineers. The lead institute is

+astronomers with support from engineers. The lead institute is +{%endtrans%}

@@ -31,7 +38,8 @@ astronomers with support from engineers. The lead institute is

-

As of today there have been contributions by the following institutions:

+

{%trans%} As of today there have been contributions by the following institutions: +{%endtrans%}

@@ -44,12 +52,6 @@ astronomers with support from engineers. The lead institute is

-

We regularily organise -coding sprints -where key developers but also newcomers meet to discuss the developments -and next steps, and advance with the coding of the software. -{%endtrans%}

-

{%trans%} ctools is free software distributed under the GNU GPL license version 3 {%endtrans%}

diff --git a/doc/source/_themes/sphinx13/layout.html b/doc/source/_themes/sphinx13/layout.html index ebd449f..9b60ab8 100755 --- a/doc/source/_themes/sphinx13/layout.html +++ b/doc/source/_themes/sphinx13/layout.html @@ -79,8 +79,8 @@ diff --git a/doc/source/about.rst b/doc/source/about.rst index b82ffcd..2e22143 100755 --- a/doc/source/about.rst +++ b/doc/source/about.rst @@ -3,29 +3,32 @@ About ===== -ctools is a software package developed for the scientific analysis of -Cherenkov telescope data, such as H.E.S.S., MAGIC, VERITAS or CTA. - -ctools comprises a set of ftools-like binary executables and Python scripts -with a command-line interface allowing for interactive step-wise data analysis. -ctools includes also Python modules to control all tools and scripts from -within Python. -Creation of shell or Python scripts and pipelines is supported as well. - -ctools are based on GammaLib, a versatile toolbox for the scientific -analysis of astronomical gamma-ray data. -GammaLib supports the analysis of H.E.S.S., MAGIC, VERITAS, CTA, Fermi/LAT, -CGRO/COMPTEL and INTEGRAL/SPI data. -GammaLib supports in particular the combination of data from different instruments -in a true joint multi-wavelength analysis that consistently handles the response -of each instrument. -An interface to virtual observatory resources does also exist. +ctools is a software package for the scientific analysis of astronomical +gamma-ray data. The package comprises an extensive set of tools for the analysis +of data from existing and future Cherenkov telescopes, including H.E.S.S., +VERITAS, MAGIC and CTA. ctools supports also the analysis of data from +CGRO/COMPTEL, Fermi/LAT and INTEGRAL/SPI, enabling the exploration of the full +gamma-ray energy band, spanning from hundreds of keV to hundreds of TeV. + +The ctools philosophy inherited from ftools consists of providing building +blocks that perform well-defined science data analysis tasks, including +observation and event selection, binning, sky map creation, source detection, +model fitting, spectra, phase curve and light curve generation, and observation +simulations. The building blocks are then combined by the user to create +flexible analysis workflows that can fit the needs of any scientist. + +ctools can be used as command-line executables alike ftools to carry out simple +analyses even for users without any programming skills. Furthermore, the tools +are accessible through dedicated Python modules providing an alternative user +interface to the software, as well as the possibility to provide tutorials in +the form of Jupyter notebooks. Shell or Python scripts can be used by more +advanced users to build analysis pipelines to any degrees of complexity. + +ctools are based on `GammaLib `_, a versatile +toolbox for the scientific analysis of astronomical gamma-ray data. ctools are developed by a team of enthousiastic gamma-ray astronomers with -support from engineers. We regularily organise -`coding sprints `_ -where key developers but also newcomers meet to discuss the developments -and next steps, and advance with the coding of the software. +support from engineers. Acknowledging or citing ctools @@ -64,10 +67,9 @@ for GammaLib. In addition please add the following acknowledgment: - *This research made use of ctools, a community-developed analysis package - for Imaging Air Cherenkov Telescope data. ctools is based on GammaLib, - a community-developed toolbox for the scientific analysis of astronomical - gamma-ray data.* + *This research made use of ctools, a community-developed gamma-ray astronomy + science analysis software. ctools is based on GammaLib, a community-developed + toolbox for the scientific analysis of astronomical gamma-ray data.* If the journal allows this, you can also include a link to http://cta.irap.omp.eu/ctools/ in addition to the above text. diff --git a/doc/source/conf.py b/doc/source/conf.py index 532f9db..f8e60d5 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-2019, ctools developers' +copyright = u'2014-2021, 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 -- libgit2 0.21.4