Asgardpy

===========================


API Changes
-----------


Bug Fixes
---------

- Generalize functions to read and write Gammapy model config files via AsgardpyConfig.
Separate some of the functions responsible for operations in a distinct ``asgardpy.config.operations`` module. [`179 <https://github.com/chaimain/asgardpy/pull/179>`__]


New Features
------------

- Clean-up code to check model preference, by creating a new stats.utils module containing common functions to be used. [`178 <https://github.com/chaimain/asgardpy/pull/178>`__]

- Add the public sample data of CTAO-LST1 Crab Nebula data and fixes [`183 <https://github.com/chaimain/asgardpy/issues/183>`__] [`#184 <https://github.com/chaimain/asgardpy/pull/184>`__]


Maintenance
-----------

- Rebase for the Hotfix release v0.4.4 and update documentation regarding its usage. [`180 <https://github.com/chaimain/asgardpy/pull/180>`__]

- Fixing Sphinx build issue caused by the upgrade from [`181 <https://github.com/chaimain/asgardpy/pull/181>`__] by pinning Towncrier. [`#182 <https://github.com/chaimain/asgardpy/pull/182>`__]

- Adding conda environment files and updating the documentation with its usage. [`185 <https://github.com/chaimain/asgardpy/pull/185>`__]

===========================


API Changes
-----------

- Update overall dependency of Gammapy to v1.2 and resolves Issue [`152 <https://github.com/chaimain/asgardpy/issues/152>`_]. [`#165 <https://github.com/chaimain/asgardpy/pull/165>`__]

- Add supporting functions to generate correct intrinsic spectral model and flux points. Adds the new addition of PKS 2155 data to GAMMAPY_DATA which will be available with Gammapy v1.3 and using it to display an example notebook. Solves Issue [`169 <https://github.com/chaimain/asgardpy/issues/169>`_]. [`#174 <https://github.com/chaimain/asgardpy/pull/174>`__]


Bug Fixes
---------


New Features
------------

- Add an example notebook to explore filtering options for data and models in FoV and resolves Issue [`166 <https://github.com/chaimain/asgardpy/issues/166>`_]. [`#172 <https://github.com/chaimain/asgardpy/pull/172>`__]


Maintenance
-----------

- Fix the issue with the build of the virtual env [`171 <https://github.com/chaimain/asgardpy/pull/171>`__]

- Update pre-commit dependencies and remove redundant arguments in pyproject [`173 <https://github.com/chaimain/asgardpy/pull/173>`__]

- General clean-up of code. [`176 <https://github.com/chaimain/asgardpy/pull/176>`__]

===========================

Hotfix for 0.4.3 by including commits from [`161 <https://github.com/chaimain/asgardpy/pull/161>`__], [`#171 <https://github.com/chaimain/asgardpy/pull/171>`__] and [`#174 <https://github.com/chaimain/asgardpy/pull/174>`__].


API Changes
-----------


Bug Fixes
---------


New Features
------------


Maintenance
-----------

===========================


API Changes
-----------


Bug Fixes
---------


New Features
------------

- Separate the functionality of reading from a Fermi-XML model file into a distinct function in gammapy module. Completes the Issue [`153 <https://github.com/chaimain/asgardpy/issues/153>`_]. [`#155 <https://github.com/chaimain/asgardpy/pull/155>`__]

- Add a temporary stats function to fetch pivot energy for any spectral model. This function will be present in the upcoming release of Gammapy v1.2.

Also include Windows OS in CI tests. [`160 <https://github.com/chaimain/asgardpy/pull/160>`__]


Maintenance
-----------

- Show Towncrier created fragments for changelog drafts before release of a new project version. [`151 <https://github.com/chaimain/asgardpy/pull/151>`__]

- Adapt tox env and start using pre-commit hooks. Have CI also run on Mac OS. Completes the remaining tasks in the Issue [`127 <https://github.com/chaimain/asgardpy/issues/127>`_]. [`#154 <https://github.com/chaimain/asgardpy/pull/154>`__]

- Adapt code suggestions from Scientific Python Development Guide and remove some coverage redundancies. [`156 <https://github.com/chaimain/asgardpy/pull/156>`__]

- Adapt code suggestions from Scrutinizer Code Quality scan. Use ``match-case`` instead of list of ``if-elif-else`` condition blocks. [`157 <https://github.com/chaimain/asgardpy/pull/157>`__]

- Limit scipy version until gammapy v1.2 fixes its dependency. [`158 <https://github.com/chaimain/asgardpy/pull/158>`__]

===========================


API Changes
-----------


Bug Fixes
---------

- Apply Bug fix on the definition of ``TimeIntervals`` config and usage in ``ObservationsConfig`` by changing it to just be a dict type and letting the ``ObservationsConfig`` have the ``obs_time`` as list of ``TimeIntervalsType``. Fixes the issue [`144 <https://github.com/chaimain/asgardpy/issues/144>`_]. [`#145 <https://github.com/chaimain/asgardpy/pull/145>`__]


New Features
------------

- Fixed project descriptions by correcting License id, changelog file link also added some more test coverage. [`137 <https://github.com/chaimain/asgardpy/pull/137>`__]

- Expand test coverage and add a description for the additional zipped Fermi-LAT data. [`138 <https://github.com/chaimain/asgardpy/pull/138>`__]

- Extend capacity to have more than 1 3D datasets, with any of them being able to add an extra FoV Background Model, to show the full support of the pipeline. [`139 <https://github.com/chaimain/asgardpy/pull/139>`__]

- Implement towncrier for maintaining PR changes as new fragments. [`141 <https://github.com/chaimain/asgardpy/pull/141>`__]

- Adapt the basic Time format to use any format and list of intervals as part of ``BaseConfig``.
Remove redundant classes, adapt tests and use ``TimeIntervalsType`` as the main Time input type. [`142 <https://github.com/chaimain/asgardpy/pull/142>`__]

- Extend the functionality of ``recursive_merge_dicts`` when comparing 2 lists of values with different lengths. [`143 <https://github.com/chaimain/asgardpy/pull/143>`__]


Maintenance
-----------

============================


Bug fixes
---------

- Correct the calculation of Goodness of Fit stats as described in the Issue
[`130 <https://github.com/chaimain/asgardpy/issues/130>`_]. Replaces the
usage of Gammapy's ``CountsStatistic`` functions with those in
``gammapy.stats.fit_statistics`` module, to evaluate the best fit (Observed)
statistic and perfect fit (Expected) statistic for all types of Datasets used.

Update the various notebooks, scripts and documentation accordingly.

Update test coverage on ``analysis`` and ``data`` modules, along with adding
copies of diffuse model files for the additional Fermi-LAT data to use name ids
used by ``fermipy`` and ``enrico``.
[`132 <https://github.com/chaimain/asgardpy/pull/132>`_]

- Replaced dynamic versioning to go back to static versioning as in the parent
package template, before trying a proper resolution of Issue
[`135 <https://github.com/chaimain/asgardpy/issues/135>`_].
[`136 <https://github.com/chaimain/asgardpy/pull/136>`_]

- Update documentation to have separate pages for describing additional support
for asgardpy inputs, from the standard ones, mentioned in the overview page.

Also updates test coverage for ``data.target`` and ``io`` modules.
[`134 <https://github.com/chaimain/asgardpy/pull/134>`_]

- Update test coverage on reading different XML models for Fermi-LAT data as
supported by ``gammapy`` module of asgardpy and move the zipped additional
data to ``dev`` folder. [`133 <https://github.com/chaimain/asgardpy/pull/133>`_]

- Updated pytests to follow proper code style with proper assert statements as
mentioned in one of the 3 tasks in the Issue
[`127 <https://github.com/chaimain/asgardpy/issues/127>`_].
[`131 <https://github.com/chaimain/asgardpy/pull/131>`_]


Maintenance
-----------

- Restructure the package to follow some PEP guidelines as described in
Issue [`125 <https://github.com/chaimain/asgardpy/issues/125>`_].

Add a separate Citation file, move codespell_ignore_words file to ``dev`` folder,
Contributing file to ``.github`` folder. Start to use dynamic versioning.
[`126 <https://github.com/chaimain/asgardpy/pull/126>`_]