22.0.0 (To be determined)

New feature release in the 22.0.x series.

This release has been tested to work with Python 3.9 and FreeSurfer 7.2,
which are now bundled in the Docker image.

This release also features improvements to T2\* and carpetplot reporting.

  * FIX: Re-add fsr-checkxopts to Docker image
  * FIX: Update wrapper python path (nipreps#2783)
  * FIX: Preserve ``collect_data`` behavior by using named args (nipreps#2754)
  * FIX: Update *fMRIPrep* version in bibliography at run time (nipreps#2738)
  * FIX: Plot carpetplot with CIFTI-specific colorbar (nipreps#2737)
  * FIX: Two minor typos in report spec (nipreps#2708)
  * ENH: Clip T2\* values at 100ms to keep consistent histogram axes (nipreps#2781)
  * ENH: Plot histogram of T2\* values in gray-matter mask (nipreps#2778)
  * ENH: Save T2starmap files in all requested output spaces, if calculated (nipreps#2776)
  * ENH: Compare T2\* map to BOLD reference (nipreps#2751)
  * ENH: Add edge-regressors to confounds & crown to carpetplot (nipreps#2621)
  * ENH: Add major/minor versions to base workflow name (nipreps#2716)
  * DOC: Fix JSON typo in config in FAQ (nipreps#2771)
  * DOC: Clarify calculation of confounding signals (nipreps#2724)
  * MNT: Build on Python 3.9 environment (nipreps#2782)
  * MNT: Seed ignore-revs file and script to tag new hashes with log entries (nipreps#2748)
  * MNT: Require PyBIDS 0.15+ to allow fMRIPrep to preserve zero-padding in run entity (nipreps#2745)
  * MNT: Upload artifacts after each step of Circle's workflow (nipreps#2736)
  * MNT: Normalize code style of ``workflows.confounds`` (nipreps#2729)
  * MNT: Ask for fmriprep-docker RUNNING line (nipreps#2670)
  * DOCKER: Bundle FreeSurfer 7 (nipreps#2779)
  * CI: Touch up CircleCI configuration (nipreps#2764)
  * CI: Update package builds to use python -m build (nipreps#2746)

22.0.0rc0

New feature release in the 22.0.x series.

This release has been tested to work with Python 3.9 and FreeSurfer 7.2,
which are now bundled in the Docker image.

This release also features improvements to T2\* and carpetplot reporting.

  * FIX: Update wrapper python path (nipreps#2783)
  * FIX: Preserve ``collect_data`` behavior by using named args (nipreps#2754)
  * FIX: Update *fMRIPrep* version in bibliography at run time (nipreps#2738)
  * FIX: Plot carpetplot with CIFTI-specific colorbar (nipreps#2737)
  * FIX: Two minor typos in report spec (nipreps#2708)
  * ENH: Clip T2\* values at 100ms to keep consistent histogram axes (nipreps#2781)
  * ENH: Plot histogram of T2\* values in gray-matter mask (nipreps#2778)
  * ENH: Save T2starmap files in all requested output spaces, if calculated (nipreps#2776)
  * ENH: Compare T2\* map to BOLD reference (nipreps#2751)
  * ENH: Add edge-regressors to confounds & crown to carpetplot (nipreps#2621)
  * ENH: Add major/minor versions to base workflow name (nipreps#2716)
  * DOC: Fix JSON typo in config in FAQ (nipreps#2771)
  * DOC: Clarify calculation of confounding signals (nipreps#2724)
  * MNT: Build on Python 3.9 environment (nipreps#2782)
  * MNT: Seed ignore-revs file and script to tag new hashes with log entries (nipreps#2748)
  * MNT: Require PyBIDS 0.15+ to allow fMRIPrep to preserve zero-padding in run entity (nipreps#2745)
  * MNT: Upload artifacts after each step of Circle's workflow (nipreps#2736)
  * MNT: Normalize code style of ``workflows.confounds`` (nipreps#2729)
  * MNT: Ask for fmriprep-docker RUNNING line (nipreps#2670)
  * DOCKER: Bundle FreeSurfer 7 (nipreps#2779)
  * CI: Touch up CircleCI configuration (nipreps#2764)
  * CI: Update package builds to use python -m build (nipreps#2746)

21.0.2 (April 21, 2022)

=======================
Bug-fix releaase in the 21.0.x series.

This release includes a few bug-fixes for susceptibility distortion correction (SDC) and multi-echo (ME).
A few notable fixes include:
- Added tolerance for affine precision differences when using EPI fieldmaps.
- Removed hang-ups when reusing anatomical derivatives with ME data.
- Increased BOLD masking workflow robustness.

A full list of changes can be found below:

  * DOCKER: Update multiarch deb package link (nipreps#2758)
  * ENH: Add affine_tolerance flag to MergeSeries (nipreps/niworkflows#706)
  * FIX: Initialize BIDS layout after cleaning working directory (nipreps#2741)
  * FIX: Avoid double unwarping during resampling of processed multi-echo data (nipreps#2730)
  * FIX: Account for potential lists of lists in multi-echo cases (nipreps/niworkflows#719)
  * FIX: Improve reliability of BOLD masking workflow (nipreps/niworkflows#712)
  * FIX: Relax tolerance for different affines when concatenating blips (nipreps/sdcflows#265)

21.0.1 (January 24, 2022)

Bug-fix release in the 21.0.x series.

This release re-enables reverse-PE EPI fieldmaps, i.e. EPIs acquired with the
opposite phase-encoding direction to a BOLD series.
Additionally, the ``--use-syn-sdc`` option will now error by default if no
``PhaseEncodingDirection`` can be found for a BOLD series. To reduce this to
a warning, use ``--use-syn-sdc warn``. SyN-SDC will NOT be run, but the workflow
will proceed.

* FIX: Create single fmap_select_std node for use with all ANAT estimators (nipreps#2692)
* FIX: Re-enable reverse-PE EPI fieldmaps (nipreps#2684)
* FIX: Pass boolean use_syn_sdc to find_estimators (nipreps#2685)
* FIX: Ensure AROMA inputs are uncompressed if --low-mem (nipreps#2657)
* ENH: Add ``--topup-max-vols`` flag to control TOPUP runtime (nipreps#2688)
* ENH: Allow ``--use-syn-sdc`` to take a "warn" option to avoid exiting when PE dir is unavailable (nipreps#2680)
* RF: Add extension field to differentiate from upcoming templates (nipreps#2613)
* WRAPPER: Map ``--bids-filter-file``\s into Docker container (nipreps#2691)
* MNT: Silence warning from pybids; list packaging as dependency (nipreps#2689)
* MNT: Add netbase to Docker image to ensure correct datalad operation (nipreps#2682)
* MNT: Restore nitime to requirements, necessary for DVARS (nipreps#2678)

20.2.7 (January 24, 2022)

Bug-fix release in the 20.2.x LTS series.

  * FIX: Clarify phase encoding direction, rather than axis (nipreps#2690)
  * FIX: Ensure AROMA inputs are uncompressed if --low-mem (nipreps#2657)
  * FIX: Add ``-basescale 1`` parameter to avoid ``flirt`` scaling (nipreps#2624)
  * WRAPPER: Map ``--bids-filter-file``\s into Docker container (nipreps#2691)
  * MNT: Add netbase to Docker image to ensure correct datalad operation (nipreps#2682)

21.0.0 (December 14, 2021)

==========================
A new series is finally here!

Some highlights of this version's new features include a substantial rework of fMRIPrep's
susceptibility distortion correction (including the addition of FSL's `topup` as the new
default PEPOLAR correction technique), improved flexibility for multiecho scans, and
dependency version upgrades within the Docker environment.

.. note::

  To follow BIDS Derivatives more closely, *fMRIPrep*'s default output layout has changed.
  To enable the legacy layout, use the `--output-layout legacy` flag.
  For more information, please see https://fmriprep.org/en/latest/outputs.html#layout

.. caution::

    As with all minor version increments, working directories
    from previous versions **should not be reused**.

Thank you for using *fMRIPrep*!
If you encounter any issues with this release, please let us know
by posting an issue on our GitHub page!

A full list of changes can be found below.

* DOC: Remove mention to ``epidewarp.fsl`` from ``NOTICE`` (nipreps#2629)
* DOC: Update description of output layout, add discussion of legacy mode (nipreps#2646)
* DOC: ME | Add missing output to documentation, improve boilerplate (nipreps#2608)
* DOC: Add --index-metadata to `pybids layout` faq (nipreps#2546)
* DOC: Add warning about slice timing correction in output documentation. (nipreps#2502)
* DOC: Update sample report (nipreps#2519)
* DOC: Refactor README and citing information (nipreps#2474)
* DOC: Point documentation at *SDCFlows* and remove SDC section (nipreps#2470)\
* DOC: Transfer duplicated documentation to www.nipreps.org (nipreps#2469)
* DOC: Better explanation on how spike regressors are generated (nipreps#2465)
* DOC: Clarify that ``res-2`` entity does not mean 2mm (nipreps#2466)
* DOC: adds --mem metavar (nipreps#2378)
* DOC: skull stripping is forced by default (nipreps#2345)
* DOCKER: Shrink Docker image size (nipreps#2551)
* DOCKER: Strip ABI tag from libQt5Core.so.5 to prevent Singularity failures (nipreps#2535)
* ENH: Make bids the default output layout option (nipreps#2555)
* ENH: Mask multi-echo data with reference mask instead of echo-specific masks (nipreps#2349)
* ENH: Replace initial FLIRT with mri_coreg, use -basescale 1 for FLIRT-BBR (nipreps#2625)
* ENH: Add flag for STC reference time and set in all cases (nipreps#2520)
* ENH: Use ``BIDSLayoutIndexer`` and do not index unnecessary modalities (nipreps#2494)
* ENH: Allow users to download templateflow templates to directory (nipreps#2482)
* ENH: Detect 3D & too-short BOLD series, warn and skip run's workflow building (nipreps#2461)
* ENH: Modernize Dockerfile (nipreps#2409) (nipreps#2270)
* ENH: Leverage SDCFlows 2.x API (nipreps#2392)
* ENH: Tedana-friendly ME derivatives (nipreps#2575)
* ENH: Better integration of *SDCFlows*' unwarping (nipreps#2576)
* ENH: Refactor workflow to adopt *SDCFlows*' new correction workflow (nipreps#2547)
* FIX: Threshold boldref resampled values to be non-negative (nipreps#2630)
* FIX: Restore SyN-SDC (nipreps#2530)
* FIX: Confusing I/O field ``bold_mask`` in bold-to-bold resampling workflow (nipreps#2611)
* FIX: ME | Revise SDC compute graph (nipreps#2610)
* FIX: Propagate the SDC warp to resampling node also with ME (nipreps#2609)
* FIX: Optimize build job on CircleCI (nipreps#2605)
* FIX: Minor multiecho issues (nipreps#2574)
* FIX: Missing numpy import (nipreps#2533)
* FIX: Avoid eager imports from *NiWorkflows* causing API breaks (nipreps#2495)
* FIX: Split aCompCor into aCompCor, cCompCor, wCompCor (nipreps#2523)
* FIX: Avoid unnecessary connections based on branching logic (nipreps#2508)
* FIX: Permit missing TR to show PyBIDS error at workflow construction time (nipreps#2513)
* FIX: Simplify STC logic for too short BOLD series (nipreps#2489)
* FIX: Catch FreeSurfer error related to FIPS being enabled (nipreps#2490)
* FIX: ``DerivativesDataSink`` nondeterministic checksums fixed with ``niworkflows=~1.3.4`` (nipreps#2458)
* FIX: Address dependency incompatibilities by pinning specific packages (nipreps#2463)
* FIX: Unprotected import of ``sentry_sdk``, which is not a dependency (nipreps#2460)
* FIX: Clarify phase encoding direction, rather than axis (nipreps#2302)
* MAINT: Conform fast-track outputs to BIDS ordering (nipreps#2663)
* MAINT: Reduce redundant processing of ds005 (nipreps#2649)
* MAINT: Finalize the work we started with the refactor of the Docker image (nipreps#2601)
* MAINT: Run full workflows on tags (nipreps#2593)
* MAINT: Stage Python environment of Docker image from nipreps/miniconda (nipreps#2581)
* MAINT: Stop NeuroDebian dependency in Dockerfile (nipreps#2578)
* MAINT: Run pytest through GitHub actions (nipreps#2529)
* MAINT: Relicense +20.3.x - BSD-3-Clause -> Apache License 2.0 (nipreps#2325)
* MAINT: Add missing OASIS30 WM/BS probsegs (nipreps#2471)
* MAINT: Update BIDS validator to 1.8.0 (nipreps#2443)
* MAINT: Address the problems of a sloppy merge (nipreps#2468)
* MAINT: Containers - remove ``/root/.npm`` (nipreps#2464)
* MAINT: Remove traces of Xenial base (nipreps#2459)
* MAINT: Revise CircleCI's cache tags to avoid mixups between builds (nipreps#2457)
* MAINT: Back port CircleCI configuration from dev branch (nipreps#2456)
* MAINT: Increase minimum tedana version (nipreps#2366)
* MAINT: Docker hub has disabled password authentication (nipreps#2448)
* MAINT: Add Lea Waller to ``contributors.json`` (nipreps#2304)
* MAINT: Move away from nearly deprecated images (nipreps#2295)
* MAINT: Migrate from poldracklab to nipreps orgs (nipreps#2290)
* MAINT: Ease CI packaging tests (nipreps#2472)
* RF/FIX: Iterate over echo indices, not filenames, simplifying iteration logic (nipreps#2651)

21.0.0rc2 (November 18, 2021)

-----------------------------
* DOC: ME | Add missing output to documentation, improve boilerplate (nipreps#2608)
* ENH: Tedana-friendly ME derivatives (nipreps#2575)
* ENH: Better integration of *SDCFlows*' unwarping (nipreps#2576)
* ENH: Refactor workflow to adopt *SDCFlows*' new correction workflow (nipreps#2547)
* FIX: Restore SyN-SDC (nipreps#2530)
* FIX: Confusing I/O field ``bold_mask`` in bold-to-bold resampling workflow (nipreps#2611)
* FIX: ME | Revise SDC compute graph (nipreps#2610)
* FIX: Propagate the SDC warp to resampling node also with ME (nipreps#2609)
* FIX: Optimize build job on CircleCI (nipreps#2605)
* FIX: Minor multiecho issues (nipreps#2574)
* MAINT: Finalize the work we started with the refactor of the Docker image (nipreps#2601)
* MAINT: Run full workflows on tags (nipreps#2593)
* MAINT: Stage Python environment of Docker image from nipreps/miniconda (nipreps#2581)
* MAINT: Stop NeuroDebian dependency in Dockerfile (nipreps#2578)

20.2.6 (October 27, 2021)

=========================
Patch release in the 20.2.x LTS series.

This release includes an updated runtime environment for Docker/Singularity users.
This environment includes a newer release of `indexed_gzip`, fixing `CrcError`s previously encountered.

  * CI: Run full workflows on tags (nipreps#2593)
  * RF: Add extension field to differentiate from upcoming templates (nipreps#2613)

20.2.5 (October 12, 2021)

Bug-fix release in the 20.2.x LTS series.

This release includes a fix to `--slice-time-ref` parsing. Also, some
issues in anatomical processing are resolved, including poorly-interpolated
labels in aseg segmentations, and probabilistic segmentations have reverted
to FAST.

  * FIX: --slice-time-ref option parsing (nipreps#2573)
  * CI: Add style checks (missing since Travis got throttled) (nipreps#2570)

20.2.4 (October 04, 2021)

Bug-fix release in the 20.2.x LTS series.

This release includes some fixes to minor bugs, and includes enhancements
to allow the user to specify a different slice-timing-correction (STC) target.

Each BOLD series will contain ``SliceTimingCorrected`` metadata to indicate
whether STC was performed. If performed, the ``StartTime`` metadata field will
be set to indicate the onset time of the BOLD series.

  * FIX: Avoid unnecessary connections based on branching logic (nipreps#2508)
  * FIX: Permit missing TR to show PyBIDS error at workflow construction time (nipreps#2513)
  * [BACKPORT] FIX: Catch FreeSurfer error related to FIPS being enabled (nipreps#2490)
  * ENH: Use ``BIDSLayoutIndexer`` and do not index unnecessary modalities (nipreps#2494)
  * [BACKPORT] ENH: Slice-timing correction improvements (nipreps#2565)