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.37.3] - 2026-04-16#

♻ Changed#

  • Added support for the NEUROCAPS_DATA environment variable to override the default data directory location used by fetch_preset_parcel_approach. Defaults to “~/neurocaps_data” when unset.

[0.37.2] - 2026-02-19#

💻 Metadata#

  • Update metadata on Pypi

♻ Changed#

  • Update internal code to handle deprecated parameter argument

  • Silence matplotlib logger

[0.37.1] - 2026-02-08#

🐛 Fixes#

  • Restrict setuptools so that maximum version installed is <82.0.0 to prevent import error for neuromaps due to removal of pkg_resources (Note: A fix is available in the neuromaps main branch but has not been released to PyPI yet)

  • Fixed spelling in exception message (“preproc-bold” -> “preproc_bold”) in TimeseriesExtractor.get_bold

[0.37.0] - 2026-02-02#

♻ Changed#

  • Updated minimum plotly version to 6.5.0 and kaleido to 1.2.0. Chrome needs to be installed to save plots as a PNG

  • Removed the deprecated “engine” kwarg since kaleido is the only backend used for new plotly versions

[0.36.2] - 2025-12-17#

🐛 Fixes#

  • Update separate acompcor logic to accommodate new format

[0.36.1] - 2025-12-11#

🐛 Fixes#

  • Account for NaN in onset and duration

[0.36.0] - 2025-11-22#

  • Added support for Python 3.13

[0.35.2] - 2025-08-15#

🐛 Fixes#

  • Fixes an error message not providing valid number of nodes when fetching parcellation approaches.

[0.35.1] - 2025-08-08#

  • JOSS Version

🐛 Fixes#

  • Properly set data type in nifti image header to address floating point issues for certain atlases when converting CAP vectors to niftis and saving image.

[0.35.0] - 2025-08-08#

🐛 Fixes#

  • Ensures mutability by using deepcopy in CAP and TimeseriesExtractor to not bypass validation

  • Accounts for case when duration is coded as 0 in event timing files as 0 in BIDS can indicate impulse.

[0.34.3] - 2025-07-25#

🚀 New/Added#

  • Added n_cores and progress_bar parameters to simulate_bids_dataset.

🐛 Fixes#

  • Incorrect session ID also raises a BIDSQueryError.

[0.34.2] - 2025-07-22#

🐛 Fixes#

  • Type hint fixes and fix undocumented parameter.

[0.34.1] - 2025-07-21#

🚀 New/Added#

  • Added new utility functions to make tutorials easier.

[0.34.0] - 2025-07-19#

♻ Changed#

  • PlotDefaults is now apart of the public API and has a new method (available_methods).

  • Documentation for plot related parameters moved to PlotDefaults.

  • For correlation and transition matrices plot, “annot” is now True by default.

  • Renamed “_plotting_utils.py” to “_plot_utils.py”.

[0.33.1] - 2025-07-18#

🐛 Fixes#

  • Fix in knn_dict that always defaulted to “Schaefer”

[0.33.0.post1] - 2025-07-15#

📖 Documentation#

  • Updates to remove old information in parameters (type hints and strings).

[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