Add release history to user documentation

Jürgen Knödlseder
1 parent f55cb264
Showing 6 changed files with 162 additions and 0 deletions
doc/source/_templates/index.html
doc/source/users/index.rst
doc/source/users/release_history/1.0.1.rst
doc/source/users/release_history/1.0.rst
doc/source/users/release_history/1.1.rst
doc/source/users/release_history/index.rst
@@ -52,6 +52,7 @@ and next steps, and advance with the coding of the software. {%endtrans%}&lt;/p&gt;
 <li><a class="smalllink" href="{{ pathto("users/reference_manual/index") }}">{%trans%}Reference Manual{%endtrans%}</a></li>
 <li><a class="smalllink" href="{{ pathto("users/faq") }}">{%trans%}Frequently asked questions{%endtrans%}</a></li>
 <li><a class="smalllink" href="{{ pathto("users/issues") }}">{%trans%}Known issues{%endtrans%}</a></li>
+<li><a class="smalllink" href="{{ pathto("users/release_history/index") }}">{%trans%}Release history{%endtrans%}</a></li>
 <li><a class="smalllink" href="doxygen/index.html">{%trans%}Source code documentation (Doxygen){%endtrans%}</a></li>
 </ul>
@@ -10,4 +10,5 @@ User Documentation
    reference_manual/index
    faq
    issues
+   release_history/index
    help
+.. _1.0.1:
+
+ctools 1.0.1 release (27 January 2016)
+======================================
+
+Overview
+--------
+
+ctools 1.0.1 is a bug fix for ctools release 1.0.
+
+The following bugs have been fixed:
+
+* [`1609 <https://cta-redmine.irap.omp.eu/issues/1609>`_] -
+  Re-enable ctmodel computation for stacked analysis
+* [`1607 <https://cta-redmine.irap.omp.eu/issues/1607>`_] -
+  Solve compatibility issues with Anaconda on Mac OS X
+* Change diffuse map for science verification
+.. _1.0:
+
+ctools 1.0 release (18 December 2015)
+=====================================
+
+Overview
+--------
+
+ctools 1.0 is the first stable release of ctools.
+
+In particular, this release provides:
+
+* Support scripts for IACT analysis
+* Compliance to GammaLib 1.0 interface
+
+Bug fixes
+---------
+
+* [`1563 <https://cta-redmine.irap.omp.eu/issues/1563>`_] -
+  Resolve Python test problem on El Capitan
+
+Improvements
+------------
+
+* Update end-user documentation
+* [`1608 <https://cta-redmine.irap.omp.eu/issues/1608>`_] -
+  Rename ``cshessobs`` to ``csiactobs``
+* [`1605 <https://cta-redmine.irap.omp.eu/issues/1605>`_] -
+  Ignore errors in El Capitan post processing
+* [`1604 <https://cta-redmine.irap.omp.eu/issues/1604>`_] -
+  Change ``GException`` to RuntimeError in cscripts
+* [`1603 <https://cta-redmine.irap.omp.eu/issues/1603>`_] -
+  Adapt to GammaLib interface changes
+
+New features
+------------
+
+* [`1608 <https://cta-redmine.irap.omp.eu/issues/1608>`_] -
+  Add ``csiactdata`` script
+* [`1579 <https://cta-redmine.irap.omp.eu/issues/1579>`_] -
+  Add ``csobs2caldb`` script
+* [`1578 <https://cta-redmine.irap.omp.eu/issues/1578>`_] -
+  Add ``csobsinfo``, ``csmodelinfo``, ``csmodelmerge``, ``cstsmapmerge``
+* [`1566 <https://cta-redmine.irap.omp.eu/issues/1566>`_] -
+  Implement handling of stacked data in ``csspec``
+.. _1.1:
+
+ctools 1.1 release (24 July 2016)
+=================================
+
+Overview
+--------
+
+ctools 1.1 is a major release that adds significant functionality.
+
+In particular, this release provides:
+
+* Complete IACT analysis scripts and documentation
+* The ``csworkflow`` workflow manager
+* Publication of sky maps over Virtual Observatory Hub
+
+Bug fixes
+---------
+
+* [`1819 <https://cta-redmine.irap.omp.eu/issues/1819>`_] -
+  Fix stacked analysis bias
+* [`1795 <https://cta-redmine.irap.omp.eu/issues/1795>`_] -
+  Handle zero parameter errors in ``ctulimit``
+
+Improvements
+------------
+
+* [`1821 <https://cta-redmine.irap.omp.eu/issues/1821>`_] -
+  Adapt to new spectral model names
+* [`1818 <https://cta-redmine.irap.omp.eu/issues/1818>`_] -
+  Adapt to new spatial model names
+* [`1815 <https://cta-redmine.irap.omp.eu/issues/1815>`_] -
+  Add background model science verification
+* Add unit tests for all example scripts
+* [`1789 <https://cta-redmine.irap.omp.eu/issues/1789>`_] -
+  Compute counts cube weights in ``ctbin``
+* [`1788 <https://cta-redmine.irap.omp.eu/issues/1788>`_] -
+  Adapt to new stacked cube interface
+* Add ctools and cscripts unit tests
+* Add ``bgdoversample`` and ``bgdinfill`` parameters to csroot2caldb
+* [`1755 <https://cta-redmine.irap.omp.eu/issues/1755>`_] -
+  Add ``seed`` parameter to cspull
+* [`1715 <https://cta-redmine.irap.omp.eu/issues/1715>`_] -
+  Test and import IACT scripts only for Python 2.6+
+* [`1714 <https://cta-redmine.irap.omp.eu/issues/1714>`_] -
+  Adapt to revise GTime operators
+* [`1710 <https://cta-redmine.irap.omp.eu/issues/1710>`_] -
+  Add ``publish()`` methods to tools producing images
+* [`1700 <https://cta-redmine.irap.omp.eu/issues/1700>`_] -
+  Read ahead output filename in ``cterror``
+* [`1673 <https://cta-redmine.irap.omp.eu/issues/1673>`_] -
+  Subdivide simulation energy range in ``ctobssim``
+* [`1663 <https://cta-redmine.irap.omp.eu/issues/1663>`_] -
+  Delete existing events before simulation in ``ctobssim``
+* [`1598 <https://cta-redmine.irap.omp.eu/issues/1598>`_] -
+  ``ctselect`` allows usage of non-default events and GTI extensions
+* [`1484 <https://cta-redmine.irap.omp.eu/issues/1484>`_] -
+  Support out of source builds
+
+New features
+------------
+
+* [`1797 <https://cta-redmine.irap.omp.eu/issues/1797>`_] -
+  Add ``cstsmapsplit`` script
+* [`1771 <https://cta-redmine.irap.omp.eu/issues/1771>`_] -
+  Add ``csobsdef.pntdef()`` method
+* [`1760 <https://cta-redmine.irap.omp.eu/issues/1760>`_] -
+  Add ``ctmapcube`` tool
+* [`1724 <https://cta-redmine.irap.omp.eu/issues/1724>`_] -
+  Add ``ctedispcube`` tool
+* [`1661 <https://cta-redmine.irap.omp.eu/issues/1661>`_] -
+  Add ``csiactcopy`` script
+* [`1646 <https://cta-redmine.irap.omp.eu/issues/1646>`_] -
+  Add documentation for IACT analysis
+* [`1508 <https://cta-redmine.irap.omp.eu/issues/1508>`_] -
+  Add ``csworkflow`` workflow manager script
+.. _release:
+
+Release History
+===============
+
+Major releases:
+
+.. toctree::
+   :maxdepth: 1
+
+   ctools 1.1 <1.1>
+   ctools 1.0 <1.0>
+
+Bug fix releases:
+
+.. toctree::
+   :maxdepth: 1
+
+   ctools 1.0.1 <1.0.1>
+
+For older ctools versions see
+`here <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Release_notes>`_.
 \ No newline at end of file