Nireports

=======================
New feature release in the 25.0.x series.

This release vendors the unmaintained ``svgutils`` package to resolve
warnings and eventual errors.
This release also includes initial type annotations for the package,
as well as a large number of fixes for warnings, to improve the user
experience for downstream packages.

* ENH: Fix `seaborn` and `matplotlib` orientation warning (166)
* ENH: Refactor mosaic plot custom colormap creation (151)
* ENH: Test the segmentation contour plot methods (175)
* ENH: Prefer using NumPy's random number generator (176)
* ENH: Prefer using NumPy's random number generator (174)
* ENH: Use a fixture to close `Matplotlib` figures in tests (169)
* ENH: Close all `Matplotlib` figures in relevant tests explicitly (167)
* ENH: Make use of the `compress` option in melodic plot function (163)
* ENH: Catch warning when loaded text file contains no data in test (156)
* ENH: Close figures in test explicitly (165)
* ENH: Remove duplicate local `NumPy` import in test function (164)
* ENH: Avoid divide by zero warnings when normalizing DWI data (154)
* ENH: Close figures in test explicitly (155)
* ENH: Fix mosaic plot `plot_sagittal` parameter warning (160)
* ENH: Copy NIfTI image header when creating from image (158)
* ENH: Remove unused parameter in segmentation mosaic plot function (152)
* ENH: Make type hinting compatible with Python 3.9 (149)
* RF: Vendor svgutils into nireports._vendored (172)
* TYP: Relax Nifti1Image to SpatialImage (153)
* TYP: Annotate reportlets.mosaic (150)
* TYP: Annotate tools and reportlets.utils (147)
* TYP: Configure and run mypy checks in CI (146)
* DOC: Consider warnings as errors in documentation CI build (162)
* MNT: Update deprecated `seaborn` function calls before they error (171)
* MNT: Update pre-commit config, add codespell (173)
* STY: Enforce ruff/flake8-simplify rules (SIM) (181)
* STY: Prefer importing `warnings` for the sake of consistency (159)

==========================
New feature release in the 24.1.x series.

This release includes a migration of most if not all reporting
interfaces from NiWorkflows.
This release also supports Python 3.13 and Numpy 2.

* ENH: Finalize migration of reporting interfaces (71)
* ENH: Allow figures in session folder (138)
* RF: Replace nireports.data.Loader with acres.Loader (142)
* STY: Apply new ruff rules (139)
* MAINT: Add tox.ini, test minimum dependencies (141)

==========================
Bug-fix release in the 24.0.x series.

Loosens constraints on report generation to permit GIFs.
Technically a feature, but the impact on existing code is null.

CHANGES
-------

* ENH: Allow GIFs in reports by tsalo in https://github.com/nipreps/nireports/pull/128

========================
Hotfix release with one bugfix.

CHANGES
-------

* FIX: Remove all axes before ``fMRIPlot`` by oesteban in https://github.com/nipreps/nireports/pull/133

========================
The new release series includes a fair share of maintenance, style, and documentation improvements.
It also includes some bugfixes, one very relevant as memory consumption may have been overseen for a
long while because many reporters were not closing their *matplotlib* figures.
Finally, several relevant features, such as new DWI plotting tools, have been included.

CHANGES
-------

* FIX: Set max height and overflow css for qcrating widget by rwblair in https://github.com/nipreps/nireports/pull/117
* FIX: Address memory issues and corruption in ``fMRIPlot`` by oesteban in https://github.com/nipreps/nireports/pull/131
* ENH: Add gradient plot method by jhlegarreta in https://github.com/nipreps/nireports/pull/96
* ENH: Set the ``seaborn`` barplot ``hue`` property value by jhlegarreta in https://github.com/nipreps/nireports/pull/100
* ENH: Add DWI volume plot method by jhlegarreta in https://github.com/nipreps/nireports/pull/101
* ENH: Add raincloud plot capabilities by jhlegarreta in https://github.com/nipreps/nireports/pull/118
* ENH: Higher-level carpetplot tooling for DWI by teresamg in https://github.com/nipreps/nireports/pull/119
* DOC: Update *Readthedocs* and package's docs dependencies by oesteban in https://github.com/nipreps/nireports/pull/97
* DOC: Misc documentation and style fixes by jhlegarreta in https://github.com/nipreps/nireports/pull/102
* DOC: Fix ``dwi`` module function cross ref in docstring by jhlegarreta in https://github.com/nipreps/nireports/pull/103
* MAINT: Fix ``matplotlib.cm.get_cmap`` deprecation by DimitriPapadopoulos in https://github.com/nipreps/nireports/pull/98
* MAINT: Consistently use ``matplotlib.colormaps`` in ``mpl`` namespace by effigies in https://github.com/nipreps/nireports/pull/104
* MAINT: Add CI badges to ``README`` by jhlegarreta in https://github.com/nipreps/nireports/pull/111
* MAINT: Add PyPI badge to ``README`` by jhlegarreta in https://github.com/nipreps/nireports/pull/112
* MAINT: Add license badge to ``README`` by jhlegarreta in https://github.com/nipreps/nireports/pull/113
* MAINT: Pacify *ruff* by oesteban in https://github.com/nipreps/nireports/pull/123
* MAINT: *Numpy* 2.0 compatibility by effigies in https://github.com/nipreps/nireports/pull/127
* STY: Apply ruff/flake8-implicit-str-concat rule ISC001 by DimitriPapadopoulos in https://github.com/nipreps/nireports/pull/99
* STY: Make coverage badge be last in ``README`` badge list by jhlegarreta in https://github.com/nipreps/nireports/pull/116
* STY: Transition to *ruff* for code formatting by jhlegarreta in https://github.com/nipreps/nireports/pull/114
* STY: Fix style in ``update_authors.py`` by jhlegarreta in https://github.com/nipreps/nireports/pull/115

New Contributors
----------------

* jhlegarreta made their first contribution in https://github.com/nipreps/nireports/pull/96
* teresamg made their first contribution in https://github.com/nipreps/nireports/pull/119
* rwblair made their first contribution in https://github.com/nipreps/nireports/pull/117

**Full Changelog**: https://github.com/nipreps/nireports/compare/23.2.2...24.0.0

========================
Bug-fix release in the 23.2.x series.

CHANGES
-------

**Full Changelog**: https://github.com/nipreps/nireports/compare/23.2.1...23.2.2

* ENH: Support PNGs and JPGs in reportlets (126)