<commit_before>
v 0.0.9 (Unreleased)
--------------------

Preproc workflow
~~~~~~~~~~~~~~~~

- Added the ability to supply fieldmap images that can be used to unwarp
  distortions caused by susceptibility regions. This uses FSL's ``topup`` and
  ``applytopup`` utilities. The images you should provide aren't actually
  traditional "fieldmaps", but rather images with normal and reversed phase
  encoding directions, from which a map of the distortions can be computed.
  See the new experiment option ``fieldmap_template``.


Model workflow
~~~~~~~~~~~~~~

- Added the ability to include additional nuisance variables in the model.
  This can now include eigenvariates of deep white matter timeseries and the
  mean signal from across the whole brain. This involves the new experiment
  options ``wm_components`` and ``confound_sources``.

- Made the inclusion of artifact indicator vectors in the design matrix optional.
  See the new experiment option ``remove_artifacts``.

- Made some changes to the model summary node to use memory more efficiently.
  The model summary code should now use a similar amount of memory as the
  ``film_gls`` model fitting process.
<commit_msg>Add note about required rerunning<commit_after>
v 0.0.9 (Unreleased)
--------------------

Preproc workflow
~~~~~~~~~~~~~~~~

- Added the ability to supply fieldmap images that can be used to unwarp
  distortions caused by susceptibility regions. This uses FSL's ``topup`` and
  ``applytopup`` utilities. The images you should provide aren't actually
  traditional "fieldmaps", but rather images with normal and reversed phase
  encoding directions, from which a map of the distortions can be computed.
  See the new experiment option ``fieldmap_template``.


Model workflow
~~~~~~~~~~~~~~

- Added the ability to include additional nuisance variables in the model.
  This can now include eigenvariates of deep white matter timeseries and the
  mean signal from across the whole brain. This involves the new experiment
  options ``wm_components`` and ``confound_sources``. This change requires that
  you rerun the preproc workflow before running the model workflow after updating
  lyman.

- Made the inclusion of artifact indicator vectors in the design matrix optional.
  See the new experiment option ``remove_artifacts``.

- Made some changes to the model summary node to use memory more efficiently.
  The model summary code should now use a similar amount of memory as the
  ``film_gls`` model fitting process.

{'fraction_non_alphanumeric': 0.08523409363745499, 'fraction_numerical': 0.0024009603841536613, 'mean_word_length': 4.154639175257732, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4474411', 'n_tokens_mistral': 621, 'n_tokens_neox': 580, 'n_words': 333}