Eirik Hatlen / ctools

Commit a0a19500e43060d8f3d59aece6312d3d2cac4580

Authored by Jürgen Knödlseder
1 parent f55cb264

Add release history to user documentation

Inline Side-by-side
Showing 6 changed files with 162 additions and 0 deletions
doc/source/_templates/index.html
  View file @a0a1950
... ... @@ -52,6 +52,7 @@ and next steps, and advance with the coding of the software. {%endtrans%}</p>
52 52 <li><a class="smalllink" href="{{ pathto("users/reference_manual/index") }}">{%trans%}Reference Manual{%endtrans%}</a></li>
53 53 <li><a class="smalllink" href="{{ pathto("users/faq") }}">{%trans%}Frequently asked questions{%endtrans%}</a></li>
54 54 <li><a class="smalllink" href="{{ pathto("users/issues") }}">{%trans%}Known issues{%endtrans%}</a></li>
  55 +<li><a class="smalllink" href="{{ pathto("users/release_history/index") }}">{%trans%}Release history{%endtrans%}</a></li>
55 56 <li><a class="smalllink" href="doxygen/index.html">{%trans%}Source code documentation (Doxygen){%endtrans%}</a></li>
56 57 </ul>
57 58  
... ...
doc/source/users/index.rst
  View file @a0a1950
... ... @@ -10,4 +10,5 @@ User Documentation
10 10 reference_manual/index
11 11 faq
12 12 issues
  13 + release_history/index
13 14 help
... ...
doc/source/users/release_history/1.0.1.rst 0 → 100644
  View file @a0a1950
  1 +.. _1.0.1:
  2 +
  3 +ctools 1.0.1 release (27 January 2016)
  4 +======================================
  5 +
  6 +Overview
  7 +--------
  8 +
  9 +ctools 1.0.1 is a bug fix for ctools release 1.0.
  10 +
  11 +The following bugs have been fixed:
  12 +
  13 +* [`1609 <https://cta-redmine.irap.omp.eu/issues/1609>`_] -
  14 + Re-enable ctmodel computation for stacked analysis
  15 +* [`1607 <https://cta-redmine.irap.omp.eu/issues/1607>`_] -
  16 + Solve compatibility issues with Anaconda on Mac OS X
  17 +* Change diffuse map for science verification
... ...
doc/source/users/release_history/1.0.rst 0 → 100644
  View file @a0a1950
  1 +.. _1.0:
  2 +
  3 +ctools 1.0 release (18 December 2015)
  4 +=====================================
  5 +
  6 +Overview
  7 +--------
  8 +
  9 +ctools 1.0 is the first stable release of ctools.
  10 +
  11 +In particular, this release provides:
  12 +
  13 +* Support scripts for IACT analysis
  14 +* Compliance to GammaLib 1.0 interface
  15 +
  16 +Bug fixes
  17 +---------
  18 +
  19 +* [`1563 <https://cta-redmine.irap.omp.eu/issues/1563>`_] -
  20 + Resolve Python test problem on El Capitan
  21 +
  22 +Improvements
  23 +------------
  24 +
  25 +* Update end-user documentation
  26 +* [`1608 <https://cta-redmine.irap.omp.eu/issues/1608>`_] -
  27 + Rename ``cshessobs`` to ``csiactobs``
  28 +* [`1605 <https://cta-redmine.irap.omp.eu/issues/1605>`_] -
  29 + Ignore errors in El Capitan post processing
  30 +* [`1604 <https://cta-redmine.irap.omp.eu/issues/1604>`_] -
  31 + Change ``GException`` to RuntimeError in cscripts
  32 +* [`1603 <https://cta-redmine.irap.omp.eu/issues/1603>`_] -
  33 + Adapt to GammaLib interface changes
  34 +
  35 +New features
  36 +------------
  37 +
  38 +* [`1608 <https://cta-redmine.irap.omp.eu/issues/1608>`_] -
  39 + Add ``csiactdata`` script
  40 +* [`1579 <https://cta-redmine.irap.omp.eu/issues/1579>`_] -
  41 + Add ``csobs2caldb`` script
  42 +* [`1578 <https://cta-redmine.irap.omp.eu/issues/1578>`_] -
  43 + Add ``csobsinfo``, ``csmodelinfo``, ``csmodelmerge``, ``cstsmapmerge``
  44 +* [`1566 <https://cta-redmine.irap.omp.eu/issues/1566>`_] -
  45 + Implement handling of stacked data in ``csspec``
... ...
doc/source/users/release_history/1.1.rst 0 → 100644
  View file @a0a1950
  1 +.. _1.1:
  2 +
  3 +ctools 1.1 release (24 July 2016)
  4 +=================================
  5 +
  6 +Overview
  7 +--------
  8 +
  9 +ctools 1.1 is a major release that adds significant functionality.
  10 +
  11 +In particular, this release provides:
  12 +
  13 +* Complete IACT analysis scripts and documentation
  14 +* The ``csworkflow`` workflow manager
  15 +* Publication of sky maps over Virtual Observatory Hub
  16 +
  17 +Bug fixes
  18 +---------
  19 +
  20 +* [`1819 <https://cta-redmine.irap.omp.eu/issues/1819>`_] -
  21 + Fix stacked analysis bias
  22 +* [`1795 <https://cta-redmine.irap.omp.eu/issues/1795>`_] -
  23 + Handle zero parameter errors in ``ctulimit``
  24 +
  25 +Improvements
  26 +------------
  27 +
  28 +* [`1821 <https://cta-redmine.irap.omp.eu/issues/1821>`_] -
  29 + Adapt to new spectral model names
  30 +* [`1818 <https://cta-redmine.irap.omp.eu/issues/1818>`_] -
  31 + Adapt to new spatial model names
  32 +* [`1815 <https://cta-redmine.irap.omp.eu/issues/1815>`_] -
  33 + Add background model science verification
  34 +* Add unit tests for all example scripts
  35 +* [`1789 <https://cta-redmine.irap.omp.eu/issues/1789>`_] -
  36 + Compute counts cube weights in ``ctbin``
  37 +* [`1788 <https://cta-redmine.irap.omp.eu/issues/1788>`_] -
  38 + Adapt to new stacked cube interface
  39 +* Add ctools and cscripts unit tests
  40 +* Add ``bgdoversample`` and ``bgdinfill`` parameters to csroot2caldb
  41 +* [`1755 <https://cta-redmine.irap.omp.eu/issues/1755>`_] -
  42 + Add ``seed`` parameter to cspull
  43 +* [`1715 <https://cta-redmine.irap.omp.eu/issues/1715>`_] -
  44 + Test and import IACT scripts only for Python 2.6+
  45 +* [`1714 <https://cta-redmine.irap.omp.eu/issues/1714>`_] -
  46 + Adapt to revise GTime operators
  47 +* [`1710 <https://cta-redmine.irap.omp.eu/issues/1710>`_] -
  48 + Add ``publish()`` methods to tools producing images
  49 +* [`1700 <https://cta-redmine.irap.omp.eu/issues/1700>`_] -
  50 + Read ahead output filename in ``cterror``
  51 +* [`1673 <https://cta-redmine.irap.omp.eu/issues/1673>`_] -
  52 + Subdivide simulation energy range in ``ctobssim``
  53 +* [`1663 <https://cta-redmine.irap.omp.eu/issues/1663>`_] -
  54 + Delete existing events before simulation in ``ctobssim``
  55 +* [`1598 <https://cta-redmine.irap.omp.eu/issues/1598>`_] -
  56 + ``ctselect`` allows usage of non-default events and GTI extensions
  57 +* [`1484 <https://cta-redmine.irap.omp.eu/issues/1484>`_] -
  58 + Support out of source builds
  59 +
  60 +New features
  61 +------------
  62 +
  63 +* [`1797 <https://cta-redmine.irap.omp.eu/issues/1797>`_] -
  64 + Add ``cstsmapsplit`` script
  65 +* [`1771 <https://cta-redmine.irap.omp.eu/issues/1771>`_] -
  66 + Add ``csobsdef.pntdef()`` method
  67 +* [`1760 <https://cta-redmine.irap.omp.eu/issues/1760>`_] -
  68 + Add ``ctmapcube`` tool
  69 +* [`1724 <https://cta-redmine.irap.omp.eu/issues/1724>`_] -
  70 + Add ``ctedispcube`` tool
  71 +* [`1661 <https://cta-redmine.irap.omp.eu/issues/1661>`_] -
  72 + Add ``csiactcopy`` script
  73 +* [`1646 <https://cta-redmine.irap.omp.eu/issues/1646>`_] -
  74 + Add documentation for IACT analysis
  75 +* [`1508 <https://cta-redmine.irap.omp.eu/issues/1508>`_] -
  76 + Add ``csworkflow`` workflow manager script
... ...
doc/source/users/release_history/index.rst 0 → 100644
  View file @a0a1950
  1 +.. _release:
  2 +
  3 +Release History
  4 +===============
  5 +
  6 +Major releases:
  7 +
  8 +.. toctree::
  9 + :maxdepth: 1
  10 +
  11 + ctools 1.1 <1.1>
  12 + ctools 1.0 <1.0>
  13 +
  14 +Bug fix releases:
  15 +
  16 +.. toctree::
  17 + :maxdepth: 1
  18 +
  19 + ctools 1.0.1 <1.0.1>
  20 +
  21 +For older ctools versions see
  22 +`here <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Release_notes>`_.
0 23 \ No newline at end of file
... ...