From 21d6f4f6377cd7c7f58671b947938a38858d70ea Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Mon, 25 Jul 2016 09:43:29 +0200 Subject: [PATCH] Add release history to documentation --- ChangeLog | 1 - doc/source/_templates/index.html | 1 + doc/source/users/index.rst | 1 + doc/source/users/release_history/1.0.1.rst | 20 ++++++++++++++++++++ doc/source/users/release_history/1.0.rst | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/users/release_history/1.1.rst | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/users/release_history/index.rst | 22 ++++++++++++++++++++++ 7 files changed, 258 insertions(+), 1 deletion(-) create mode 100644 doc/source/users/release_history/1.0.1.rst create mode 100644 doc/source/users/release_history/1.0.rst create mode 100644 doc/source/users/release_history/1.1.rst create mode 100644 doc/source/users/release_history/index.rst diff --git a/ChangeLog b/ChangeLog index 7930d20..10604e9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -17,7 +17,6 @@ Handle additional columns in GArf class GCTAAeff2D no longer extrapolates beyond response table (#1784) Add GWcsSIN projection class (#1798) - CTA cube response no longer selects on RoI and energies (#1789) Add weights to CTA event cube and event bin (#1789) Remove GCTACubeExposure, GCTACubePsf and GCTACubeBackground elogmeans() methods GCTACubeExposure, GCTACubePsf and GCTACubeBackground use energy values (#1788) diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html index 9547e07..fa76909 100644 --- a/doc/source/_templates/index.html +++ b/doc/source/_templates/index.html @@ -42,6 +42,7 @@ and next steps, and advance with the coding of the software. {%endtrans%}

  • {%trans%}How To{%endtrans%}
  • {%trans%}Frequently asked questions{%endtrans%}
  • {%trans%}Known issues{%endtrans%}
    • +
  • {%trans%}Release history{%endtrans%}
  • {%trans%}Source code documentation (Doxygen){%endtrans%}
    • diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index a9f2aa7..128ac6d 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -12,4 +12,5 @@ User Documentation howto/index faq issues + release_history/index help diff --git a/doc/source/users/release_history/1.0.1.rst b/doc/source/users/release_history/1.0.1.rst new file mode 100644 index 0000000..8a10f92 --- /dev/null +++ b/doc/source/users/release_history/1.0.1.rst @@ -0,0 +1,20 @@ +.. _1.0.1: + +GammaLib 1.0.1 release (27 January 2016) +======================================== + +Overview +-------- + +GammaLib 1.0.1 is a bug fix for GammaLib release 1.0. + +The following bugs have been fixed: + +* [`1616 `_] - + Add units to CTA event list columns +* [`1611 `_] - + Allow usage of numbers in FITS extension names +* [`1607 `_] - + Solve compatibility issues with Anaconda on Mac OS X +* [`1584 `_] - + Correct diffuse map MC normalisation diff --git a/doc/source/users/release_history/1.0.rst b/doc/source/users/release_history/1.0.rst new file mode 100644 index 0000000..9c4ac14 --- /dev/null +++ b/doc/source/users/release_history/1.0.rst @@ -0,0 +1,58 @@ +.. _1.0: + +GammaLib 1.0 release (18 January 2016) +====================================== + +Overview +-------- + +GammaLib 1.0 is the first stable release of GammaLib. + +In particular, this release provides: + +* Compliance with Mac OS X El Capitan +* Filename FITS extension support + + +Change log +---------- + +Bug fixes +^^^^^^^^^ + +* [`1605 `_] - + Ignore errors for El Capitan post processing +* [`1581 `_] - + ``GSkyMap::__getitem__`` throw exception if out of bound +* [`1563 `_] - + Resolve Python test problem on El Capitan + +Improvements +^^^^^^^^^^^^ + +* [`1600 `_] - + Read only mandatory columns in ``GCTAEventList`` +* [`1586 `_] - + Check existence of files in CTA response loading +* [`1580 `_] - + Handle ``~`` in filenames +* [`1578 `_] - + Add ``GModel::has_ts()`` method +* [`1569 `_] - + Perform ``init.py`` creation only in build step + +New features +^^^^^^^^^^^^ + +* [`1599 `_] - + Add ``GFilename`` class + +Clean up +^^^^^^^^ + +* [`1601 `_] - + Remove extname arguments from classes +* [`1564 `_] - + Remove access by name methods from ``GSkyRegions`` + + diff --git a/doc/source/users/release_history/1.1.rst b/doc/source/users/release_history/1.1.rst new file mode 100644 index 0000000..da371ab --- /dev/null +++ b/doc/source/users/release_history/1.1.rst @@ -0,0 +1,156 @@ +.. _1.1: + +GammaLib 1.1 release (24 July 2016) +=================================== + +Overview +-------- + +GammaLib 1.1 is a major release that adds significant functionality. +In particular, this release provides: + +* Support for Fermi/LAT Pass 8 analysis +* Support for CTA on/off fitting +* Point Spread Function histograms for CTA +* Energy dispersion for stacked CTA analysis +* Publication of sky maps to the Virtual Observatory hub +* New names for spatial and spectral model and their parameters + (see :ref:`sec_model`) + +Change log +---------- + +Bug fixes +^^^^^^^^^ + +* Fix exception handling SWIG interface for Python 3 +* [`1815 `_] - + Fix consistency problem in ``GCTABackground3D`` +* [`1806 `_] - + Fix Makefile for example executables +* [`1717 `_] - + Make ``GFilename::is_fits`` thread safe +* Fix ``GFitsTableCol::insert()`` method for empty columns +* [`1662 `_] - + Fix ``GCTAEdisp2D::compute_ebounds_xxx()`` methods + +Improvements +^^^^^^^^^^^^ + +* [`1824 `_] - + Check on model parameters in spectral registry +* [`1821 `_] - + Rename spectral model components +* [`1820 `_] - + Write same XML element names than those that were read +* [`1818 `_] - + Rename spatial model components +* [`1808 `_] - + Models accessing file now support relative file names, + add ``GXmlElement::filename()`` and ``GXmlDocument::filename()`` methods, + move node parent from GXmlElement to GXmlNode class +* [`1784 `_] - + ``GCTAAeff2D`` no longer extrapolates beyond response table +* [`1787 `_] - + ``GSkyMap::save()`` now overwrites files +* [`1779 `_] - + Use ``std::vector`` for naxes argument in ``GFitsImage`` +* ``GCTACubePsf`` and ``GCTACubeEdisp`` now save 4D images +* Change interpolation scheme in ``GCTABackground3D`` +* [`1765 `_] - + Add ``GModel::read_attributes()`` and ``GModel::write_attributes()`` + private methods +* [`1746 `_] - + Also write test reports in case of an exception +* [`1745 `_] - + ``GCaldb::filename()`` method now returns ``GFilename`` +* [`1725 `_] - + Use rejection method in ``GModelSpatialDiffuseMap::mc()`` +* [`1722 `_] - + Use rejection method in ``GCTABackground3D::mc()`` and + ``GModelSpatialDiffuseCube::mc()`` +* [`1714 `_] - + Revise GTime operators +* [`1695 `_] - + Handle FITS extensions in ``GSkyMap::load()`` and ``GSkyMap::save()`` methods +* [`1674 `_] - + Restrict Monte Carlo simulations in ``GModelSpatialDiffuseConst`` to + simulation cone +* [`1673 `_] - + Optimise ``GModelSpatialDiffuseMap::set_mc_cone()`` and + ``GModelSpatialDiffuseCube::set_mc_cone()`` methods +* [`1672 `_] - + Use default ``GTime`` in ``GModelSpectral::eval()`` and + ``GModelSpectral::eval_gradients()`` methods +* [`1671 `_] - + The ``GApplicationPar::filename()`` methods now take and return ``GFilename`` +* [`1670 `_] - + Use default ``GTime`` in ``GObservation::deadc()`` method +* [`1666 `_] - + Add ``GFilename`` methods and remove equivalents from ``GTools`` +* [`1664 `_] - + Add non-const ``GObservation::events()`` method +* [`1656 `_] - + Use column names for CTA response table access +* [`1649 `_] - + Use ``GFilename`` in ``GFits`` to store filename +* [`1648 `_] - + Implement event fetching and disposal in ``GCTAEventList`` class +* Handle also additional columns in ``GCTAEventList::append()`` method +* [`1598 `_] - + Load CTA GTI extension from the HDU name provided by the DSS keyword + +New features +^^^^^^^^^^^^ + +* [`1803 `_] - + Include examples in unit tests +* Handle additional columns in ``GArf`` class +* [`1798 `_] - + Add ``GWcsSIN`` projection class +* [`1789 `_] - + Add weights to CTA event cube and event bin +* [`1786 `_] - + Add ``GCTAPsfTable`` class +* [`1773 `_] - + Add ``GCsv::append()`` method +* [`1772 `_] - + Add ``GTestSuite::test_value()`` string method +* [`1770 `_] - + Add component setting methods to ``GModelSky`` +* Add ``GApplication::logFileClose()`` method +* [`1744 `_] - + Add ``GCTAObservation`` filename constructor +* [`1743 `_] - + Add ``gammalib::number()`` function +* [`1733 `_] - + Add ``GSkyMap::shape()`` and ``GSkyMap::ndim()`` methods +* Add ``GEnergy`` division operator +* [`1723 `_] - + Add ``GObservations::nobserved()`` method +* [`1721 `_] - + Add energy dispersion cube for stacked analysis +* [`1710 `_] - + Add ``GSkyMap::publish()`` method to publish map on VO Hub and add + ``GVOClient::publish()`` method to publish a FITS HDU +* [`1710 `_] - + Add ``GSkyMap::publish()`` method to publish map on VO Hub +* Add ``GFilename::fullname()`` method +* Add ``GCTAEventList::remove()`` method +* [`1517 `_] - + Support Fermi LAT Pass 8 response functions +* [`1484 `_] - + Support out of source builds +* [`1044 `_, `1781 `_] - + Finalize implementation of CTA On/Off fitting + +Clean up +^^^^^^^^ + +* Remove ``GCTACubeExposure::elogmeans()``, ``GCTACubePsf::elogmeans()`` + and ``GCTACubeBackground::elogmeans()`` methods +* [`1669 `_] - + Remove ``GCTAOnOffObservations`` class +* [`1648 `_] - + Remove event fetching from ``GCTAObservation`` class + diff --git a/doc/source/users/release_history/index.rst b/doc/source/users/release_history/index.rst new file mode 100644 index 0000000..46229f9 --- /dev/null +++ b/doc/source/users/release_history/index.rst @@ -0,0 +1,22 @@ +.. _release: + +Release History +=============== + +Major release history: + +.. toctree:: + :maxdepth: 1 + + GammaLib 1.1 <1.1> + GammaLib 1.0 <1.0> + +Bug fix releases: + +.. toctree:: + :maxdepth: 1 + + GammaLib 1.0.1 <1.0.1> + +For older GammaLib versions see +`here `_. \ No newline at end of file -- libgit2 0.21.4