Skip to content

CHANGES.rst

Latest commit

 

History

History
272 lines (211 loc) · 12.2 KB

CHANGES.rst

File metadata and controls

272 lines (211 loc) · 12.2 KB
Raw

25.3.0 (September 10, 2025)

New feature release in the 25.3.x series.

  • FIX: Disable subplot colorbars in cifti_surfaces_plot (#197)
  • ENH: Keep dropped TRs in undecimated carpetplot (#207)
  • ENH: Exclude non-steady-state volumes from confoundplot bounds, stats (#206)
  • STY: Spell out tracer entity (#203)
  • TST: Check colormap equivalence, modulo alpha (#200)
  • MNT: Update and test minimum dependencies (#198)
  • MNT: Update ruff parameters (#177)
  • MNT: Update pre-commit ruff legacy alias (#196)
  • STY: Enforce ruff rules (RUF) (#180)

25.2.0 (June 2, 2025)

Start of the 25.2.x series.

This release supports handling sessions when generating reports.

  • ENH: Add session filtering to report generation (#193)

25.1.0 (May 22, 2025)

New feature release in the 25.0.x series.

This release drops support for Python 3.9.

  • ENH: Add detrend parameter to fMRIPlot (#190)
  • ENH: Add output_name_pattern for PET (#188)
  • MNT: Update templateflow cache, use OIDC PyPI uploads (#185)

25.0.1 (March 20, 2025)

Hot fix in the 25.0.x series.

This release fixes an AttributeError caused by eagerly-evaluated type annotations.

25.0.0 (March 20, 2025)

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)

24.1.0 (December 18, 2024)

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)

24.0.3 (November 18, 2024)

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 #128

24.0.2 (August 26, 2024)

Hotfix release with one bugfix.

CHANGES

  • FIX: Remove all axes before fMRIPlot by @oesteban in #133

24.0.1 (August 25, 2024)

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

New Contributors

  • @jhlegarreta made their first contribution in #96
  • @teresamg made their first contribution in #119
  • @rwblair made their first contribution in #117

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

23.2.2 (August 19, 2024)

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)

23.2.1 (May 07, 2024)

Bug-fix release in the 23.2.x series.

CHANGES

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

  • MNT: Fix matplotlib.cm.get_cmap deprecation (#98)

23.2.0 (December 13, 2023)

A new minor release with support for Python 3.12, matplotlib 3.8, and dropping the implicit dependency on setuptools.

CHANGES

Full Changelog: https://github.com/nipreps/nireports/compare/23.1.0...23.2.0

  • FIX: Fix AttributeError Xtick has no attribute label (#84)
  • FIX: Typos found by codespell (#79)
  • ENH: Add session filtering to report generation (#82)
  • ENH: Add ignore_initial_volumes param to ConfoundsCorrelationPlot (#83)
  • RF: Purge pkg_resources, add data loader (#85)
  • STY: Assorted pyupgrade suggestions (#80)

23.1.0 (June 13, 2023)

A new minor release including several bugfixes and a new module for diffusion MRI data plotting tools.

CHANGES

Full Changelog: https://github.com/nipreps/nireports/compare/23.0.1...23.1.0

  • FIX: Calculation of aspect ratio of mosaics (#76)
  • FIX: Bugs discovered generating DWI reports (#73)
  • FIX: Improve handling of reportlet style (#68)
  • FIX: Plugin inclusion via main bootstrap file did not work (#64)
  • ENH: Better SNR levels for representation in DWI heatmaps (#77)
  • ENH: Add a new DWI heatmap for quality control (#75)
  • ENH: Port basic report-capable interfaces from NiWorkflows (#74)
  • ENH: Add a bval-<label> entity (#72)
  • ENH: Allow CSS styling of reportlets in bootstrap file (#67)
  • ENH: Improve handling of auth token by rating-widget (#66)
  • ENH: Advanced metadata interpolation (#65)
  • ENH: BIDS filters and support plugins (incl. a rating widget as the example) (#62)
  • ENH: Allow different types of reportlets, not only BIDS-based (#60)
  • ENH: Upgrade bootstrap to 5.0.2 (#59)
  • ENH: Allow plotting of image rotated to cardinal axes (#650)
  • DOC: Adds a docstring to the compose_view function. (#63)
  • DOC: Ensure copyright notice in all headers' comment (#635)
  • MAINT: Replace distutils use, upgrade versioneer (#725)
  • MAINT: Refactor structure of interfaces (#603)
  • CI: Try older codecov orb (#70)
  • CI: Purge codecov Python package (#69)

23.0.1 (March 10, 2023)

Hotfix release porting nipreps/niworkflows#785.

23.0.0 (March 10, 2023)

The first OFFICIAL RELEASE of NiReports is out! This first version of the package ports the visualization tools from MRIQC and NiWorkflows into a common API. In addition, the plotting of mosaic views (MRIQC) is flexibilized so that rodent imaging can conveniently be also visualized.

CHANGES

Full Changelog: https://github.com/nipreps/nireports/compare/0.2.0...23.0.0

  • FIX: Bug in plot_mosaic introduced in #52 (666ac5b)
  • ENH: Flexibilize views of plot_mosaic to render nonhuman imaging by @oesteban in #52
  • ENH: Set up CI on CircleCI for artifact visualization by @esavary in #50
  • ENH: API refactor of NiPype interfaces by @oesteban in #51
  • MAINT: Updated MAINTAINERS.md by @esavary in #49
  • MAINT: Add Governance files (#48)

Author list for papers based on NiReports 23.0 series

As described in the Contributor Guidelines, anyone listed as developer or contributor may write and submit manuscripts about NiReports. To do so, please move the author(s) name(s) to the front of the following list:

Christopher J. Markiewicz 1; Zvi Baratz 2; Elodie Savary 3; Mathias Goncalves 1; Ross W. Blair 1; Eilidh MacNicol 4; Céline Provins 3; Dylan Nielson 5; Russell A. Poldrack 1; Oscar Esteban 6.

Affiliations:

  1. Department of Psychology, Stanford University, CA, USA
  2. Sagol School of Neuroscience, Tel Aviv University, Tel Aviv, Israel
  3. Department of Radiology, Lausanne University Hospital and University of Lausanne, Switzerland
  4. Department of Neuroimaging, Institute of Psychiatry, Psychology and Neuroscience, King's College London, London, UK
  5. Section on Clinical and Computational Psychiatry, National Institute of Mental Health, Bethesda, MD, USA
  6. Department of Radiology, Lausanne University Hospital and University of Lausanne

Pre 23.0.0

A number of pre-releases were launched before 23.0.0 to test the deployment and the integration tests.