Changelog#

The current changelog contains information on NeuroCAPs versions 0.33.0 and above. For changes in earlier versions:

Note: The versions listed in this file have been or will be deployed to PyPI.

[Versioning]#

0.minor.patch.postN

  • .minor : Introduces new features and may include potential breaking changes. Any breaking changes will be explicitly noted in the changelog (e.g., new functions or parameters, changes in parameter defaults, or function names).

  • .patch : Contains fixes for identified bugs and may include modifications or added parameters for improvements/enhancements. All fixes and modifications are backwards compatible.

  • .postN : Consists of documentation changes or metadata-related updates, such as modifications to type hints.

[0.33.0] - 2025-07-15#

🚀 New/Added#

  • plot_output_format parameter added to replace as_pickle, as_json, and as_html

  • This parameter is added under output_dir, which changes signature ordering

â™» Changed#

  • Significant changes in ordering of signature parameters for better grouping

  • Removal of certain parameters to clean up signatures:

    • flush (in TimeseriesExtractor): remnant of print but logging is used now

    • fwhm (in CAP.caps2niftis and CAP.caps2surf, parameter still available in TimeseriesExtractor to apply smoothing during timeseries extraction; however smoothing is not needed for statistical maps)

    • fslr_giftis_dict (in CAP.caps2surf)

  • Changed default in CAP.caps2plot from “outer_product” to “heatmap”

đź“– Documentation#

  • Only version specifiers from >= 0.33.0 are shown. Previous specifiers are archived in the 0.32.4 readthedocs.io