Skip to content

Commit 69a7908

Browse files
committed
[skip ci] update documentation to reflect new confounds options
2 parents d9c33e9 + 38d0550 commit 69a7908

23 files changed

+407
-1630
lines changed

.circleci/config.yml

Lines changed: 70 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,8 @@ jobs:
257257
-e FMRIPREP_REGRESSION_TARGETS=/tmp/data/fmriprep_bold_mask \
258258
-e FMRIPREP_REGRESSION_REPORTS=/tmp/data/reports \
259259
--entrypoint="py.test" poldracklab/fmriprep:latest \
260-
/root/src/fmriprep/ \
261-
-svx --doctest-modules --ignore=/root/src/fmriprep/docs --ignore=setup.py
260+
/src/fmriprep/ \
261+
-svx --doctest-modules --ignore=/src/fmriprep/docs --ignore=setup.py
262262
- run:
263263
name: Package new masks
264264
no_output_timeout: 10m
@@ -329,7 +329,7 @@ jobs:
329329
docker run -ti --rm=false -v $PWD:/_build_html \
330330
--entrypoint=sphinx-build poldracklab/fmriprep:latest \
331331
-T -E -b html -d _build/doctrees-readthedocs -W -D \
332-
language=en /root/src/fmriprep/docs/ /_build_html 2>&1 \
332+
language=en /src/fmriprep/docs/ /_build_html 2>&1 \
333333
| tee $PWD/builddocs.log
334334
cat $PWD/builddocs.log
335335
grep -qv "ERROR" $PWD/builddocs.log
@@ -358,10 +358,10 @@ jobs:
358358
at: /tmp
359359
- restore_cache:
360360
keys:
361-
- ds005-anat-v13-{{ .Branch }}-{{ epoch }}
362-
- ds005-anat-v13-{{ .Branch }}
363-
- ds005-anat-v13-master
364-
- ds005-anat-v13-
361+
- ds005-anat-v14-{{ .Branch }}-{{ epoch }}
362+
- ds005-anat-v14-{{ .Branch }}
363+
- ds005-anat-v14-master
364+
- ds005-anat-v14-
365365
- run:
366366
name: Setting up test
367367
command: |
@@ -389,13 +389,13 @@ jobs:
389389
sudo setfacl -d -m group:$(id -gn):rwx /tmp/ds005/work && \
390390
sudo setfacl -m group:$(id -gn):rwx /tmp/ds005/work
391391
fmriprep-docker -i poldracklab/fmriprep:latest \
392-
-e FMRIPREP_DEV 1 -u $(id -u) \
392+
-e FMRIPREP_DEV 1 \
393393
--config $PWD/nipype.cfg -w /tmp/ds005/work \
394394
/tmp/data/ds005 /tmp/ds005/derivatives participant \
395395
--sloppy --write-graph --mem_mb 4096 \
396396
--nthreads 2 --anat-only -vv
397397
- save_cache:
398-
key: ds005-anat-v13-{{ .Branch }}-{{ epoch }}
398+
key: ds005-anat-v14-{{ .Branch }}-{{ epoch }}
399399
paths:
400400
- /tmp/ds005/work
401401

@@ -408,11 +408,11 @@ jobs:
408408
sudo setfacl -d -m group:$(id -gn):rwx /tmp/ds005/work && \
409409
sudo setfacl -m group:$(id -gn):rwx /tmp/ds005/work
410410
fmriprep-docker -i poldracklab/fmriprep:latest \
411-
-e FMRIPREP_DEV 1 -u $(id -u) \
411+
-e FMRIPREP_DEV 1 \
412412
--config $PWD/nipype.cfg -w /tmp/ds005/work \
413413
/tmp/data/ds005 /tmp/ds005/derivatives participant \
414414
--sloppy --write-graph --use-syn-sdc --mem_mb 4096 \
415-
--ignore-aroma-denoising-errors --use-aroma \
415+
--use-aroma \
416416
--output-space T1w template fsaverage5 fsnative \
417417
--template-resampling-grid native \
418418
--use-plugin /home/circleci/src/fmriprep/.circleci/legacy.yml \
@@ -423,6 +423,7 @@ jobs:
423423
mkdir -p /tmp/ds005/derivatives_partial
424424
sudo mv /tmp/ds005/derivatives/freesurfer /tmp/ds005/derivatives_partial
425425
sudo cp -a /tmp/ds005/work /tmp/ds005/work_partial
426+
sudo rm -rf /tmp/ds005/work_partial/fmriprep_wf/single_subject_01_wf/func_preproc_task_mixedgamblestask_run_02_wf/ica_aroma_wf
426427
- run:
427428
name: Checking outputs of full fMRIPrep run
428429
command: |
@@ -434,14 +435,14 @@ jobs:
434435
name: Re-run fMRIPrep on single run of task data
435436
no_output_timeout: 2h
436437
command: |
437-
rm /tmp/data/ds005/sub-01/func/*_run-02_*
438+
rm /tmp/data/ds005/sub-01/func/*_run-01_*
438439
fmriprep-docker -i poldracklab/fmriprep:latest \
439-
-e FMRIPREP_DEV 1 -u $(id -u) \
440-
--config $PWD/nipype.cfg -w /tmp/ds005/work \
440+
-e FMRIPREP_DEV 1 \
441+
--config $PWD/nipype.cfg -w /tmp/ds005/work_partial \
441442
/tmp/data/ds005 /tmp/ds005/derivatives_partial participant \
442443
--sloppy --write-graph --use-syn-sdc --mem_mb 4096 \
443444
--output-space T1w template fsaverage5 fsnative \
444-
--ignore-aroma-denoising-errors --use-aroma \
445+
--aroma-melodic-dimensionality 2 --use-aroma \
445446
--template-resampling-grid native \
446447
--nthreads 2 --cifti-output -vv
447448
- run:
@@ -488,10 +489,10 @@ jobs:
488489
at: /tmp
489490
- restore_cache:
490491
keys:
491-
- ds054-anat-v11-{{ .Branch }}-{{ epoch }}
492-
- ds054-anat-v11-{{ .Branch }}
493-
- ds054-anat-v11-master
494-
- ds054-anat-v11-
492+
- ds054-anat-v12-{{ .Branch }}-{{ epoch }}
493+
- ds054-anat-v12-{{ .Branch }}
494+
- ds054-anat-v12-master
495+
- ds054-anat-v12-
495496
- run:
496497
name: Setting up test
497498
command: |
@@ -525,7 +526,7 @@ jobs:
525526
--fs-no-reconall --sloppy --write-graph \
526527
--mem_mb 4096 --nthreads 2 --anat-only -vv
527528
- save_cache:
528-
key: ds054-anat-v11-{{ .Branch }}-{{ epoch }}
529+
key: ds054-anat-v12-{{ .Branch }}-{{ epoch }}
529530
paths:
530531
- /tmp/ds054/work
531532

@@ -606,10 +607,10 @@ jobs:
606607
at: /tmp
607608
- restore_cache:
608609
keys:
609-
- ds210-anat-v9-{{ .Branch }}-{{ epoch }}
610-
- ds210-anat-v9-{{ .Branch }}
611-
- ds210-anat-v9-master
612-
- ds210-anat-v9-
610+
- ds210-anat-v10-{{ .Branch }}-{{ epoch }}
611+
- ds210-anat-v10-{{ .Branch }}
612+
- ds210-anat-v10-master
613+
- ds210-anat-v10-
613614
- run:
614615
name: Setting up test
615616
command: |
@@ -643,7 +644,7 @@ jobs:
643644
--fs-no-reconall --sloppy --write-graph \
644645
--mem_mb 4096 --nthreads 2 --anat-only -vv
645646
- save_cache:
646-
key: ds210-anat-v9-{{ .Branch }}-{{ epoch }}
647+
key: ds210-anat-v10-{{ .Branch }}-{{ epoch }}
647648
paths:
648649
- /tmp/ds210/work
649650

@@ -676,6 +677,35 @@ jobs:
676677
- store_artifacts:
677678
path: /tmp/ds210
678679

680+
deploy_docker_patches:
681+
machine:
682+
image: circleci/classic:201711-01
683+
working_directory: /tmp/src/fmriprep
684+
steps:
685+
686+
- attach_workspace:
687+
at: /tmp
688+
- run:
689+
name: Load Docker image layer cache
690+
no_output_timeout: 30m
691+
command: |
692+
docker info
693+
set +o pipefail
694+
if [ -f /tmp/cache/docker.tar.gz ]; then
695+
sudo apt update && sudo apt -y install pigz
696+
pigz -d --stdout /tmp/cache/docker.tar.gz | docker load
697+
docker images
698+
fi
699+
- run:
700+
name: Deploy to Docker Hub
701+
no_output_timeout: 40m
702+
command: |
703+
if [[ -n "$DOCKER_PASS" ]]; then
704+
docker login -u $DOCKER_USER -p $DOCKER_PASS
705+
docker tag poldracklab/fmriprep poldracklab/fmriprep:${CIRCLE_BRANCH#docker/}
706+
docker push poldracklab/fmriprep:${CIRCLE_BRANCH#docker/}
707+
fi
708+
679709
deploy_docker:
680710
machine:
681711
image: circleci/classic:201711-01
@@ -746,6 +776,7 @@ workflows:
746776
ignore:
747777
- /docs?\/.*/
748778
- /tests?\/.*/
779+
- /docker\/.*/
749780
tags:
750781
only: /.*/
751782

@@ -757,6 +788,7 @@ workflows:
757788
- /ds005\/.*/
758789
- /ds054\/.*/
759790
- /ds210\/.*/
791+
- /docker\/.*/
760792
tags:
761793
only: /.*/
762794

@@ -770,6 +802,7 @@ workflows:
770802
- /ds005\/.*/
771803
- /ds054\/.*/
772804
- /ds210\/.*/
805+
- /docker\/.*/
773806
tags:
774807
only: /.*/
775808

@@ -781,6 +814,7 @@ workflows:
781814
ignore:
782815
- /docs?\/.*/
783816
- /tests?\/.*/
817+
- /docker\/.*/
784818
tags:
785819
only: /.*/
786820

@@ -795,6 +829,7 @@ workflows:
795829
- /ds005\/.*/
796830
- /ds054\/.*/
797831
- /ds210\/.*/
832+
- /docker\/.*/
798833
tags:
799834
only: /.*/
800835

@@ -809,6 +844,7 @@ workflows:
809844
- /tests?\/.*/
810845
- /ds054\/.*/
811846
- /ds210\/.*/
847+
- /docker\/.*/
812848
tags:
813849
only: /.*/
814850

@@ -823,6 +859,7 @@ workflows:
823859
- /tests?\/.*/
824860
- /ds005\/.*/
825861
- /ds210\/.*/
862+
- /docker\/.*/
826863
tags:
827864
only: /.*/
828865

@@ -838,9 +875,17 @@ workflows:
838875
- /tests?\/.*/
839876
- /ds005\/.*/
840877
- /ds054\/.*/
878+
- /docker\/.*/
841879
tags:
842880
only: /.*/
843881

882+
- deploy_docker_patches:
883+
requires:
884+
- build
885+
filters:
886+
branches:
887+
only: /docker\/.*/
888+
844889
- deploy_docker:
845890
requires:
846891
- build

.circleci/ds005_partial_outputs.txt

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,27 +34,25 @@ fmriprep/sub-01/anat/sub-01_space-MNI152NLin2009cAsym_label-CSF_probseg.nii.gz
3434
fmriprep/sub-01/anat/sub-01_space-MNI152NLin2009cAsym_label-GM_probseg.nii.gz
3535
fmriprep/sub-01/anat/sub-01_space-MNI152NLin2009cAsym_label-WM_probseg.nii.gz
3636
fmriprep/sub-01/func
37-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_AROMAnoiseICs.csv
38-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_bold.dtseries.json
39-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_bold.dtseries.nii
40-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_desc-acompcor_decomposition.json
41-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_desc-confounds_regressors.tsv
42-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_desc-MELODIC_mixing.tsv
43-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_desc-tcompcor_decomposition.json
44-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-fsaverage5_hemi-L.func.gii
45-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-fsaverage5_hemi-R.func.gii
46-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-fsnative_hemi-L.func.gii
47-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-fsnative_hemi-R.func.gii
48-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-MNI152NLin2009cAsym_boldref.nii.gz
49-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-MNI152NLin2009cAsym_desc-aparcaseg_dseg.nii.gz
50-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-MNI152NLin2009cAsym_desc-aseg_dseg.nii.gz
51-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-MNI152NLin2009cAsym_desc-brain_mask.nii.gz
52-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-MNI152NLin2009cAsym_desc-preproc_bold.nii.gz
53-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-MNI152NLin2009cAsym_desc-smoothAROMAnonaggr_bold.nii.gz
54-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-T1w_boldref.nii.gz
55-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-T1w_desc-aparcaseg_dseg.nii.gz
56-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-T1w_desc-aseg_dseg.nii.gz
57-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-T1w_desc-brain_mask.nii.gz
58-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-01_space-T1w_desc-preproc_bold.nii.gz
37+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_AROMAnoiseICs.csv
38+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_bold.dtseries.json
39+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_bold.dtseries.nii
40+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-confounds_regressors.tsv
41+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-MELODIC_mixing.tsv
42+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-fsaverage5_hemi-L.func.gii
43+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-fsaverage5_hemi-R.func.gii
44+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-fsnative_hemi-L.func.gii
45+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-fsnative_hemi-R.func.gii
46+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-MNI152NLin2009cAsym_boldref.nii.gz
47+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-MNI152NLin2009cAsym_desc-aparcaseg_dseg.nii.gz
48+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-MNI152NLin2009cAsym_desc-aseg_dseg.nii.gz
49+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-MNI152NLin2009cAsym_desc-brain_mask.nii.gz
50+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-MNI152NLin2009cAsym_desc-preproc_bold.nii.gz
51+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-MNI152NLin2009cAsym_desc-smoothAROMAnonaggr_bold.nii.gz
52+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-T1w_boldref.nii.gz
53+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-T1w_desc-aparcaseg_dseg.nii.gz
54+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-T1w_desc-aseg_dseg.nii.gz
55+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-T1w_desc-brain_mask.nii.gz
56+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_space-T1w_desc-preproc_bold.nii.gz
5957
fmriprep/sub-01.html
6058
/tmp/ds005/derivatives_partial

CHANGES.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
1.3.0.post1 (February 8, 2019)
2+
==============================
3+
4+
Hotfix release intended for Singularity users. For further detail, please see
5+
`#1500 <https://github.com/poldracklab/fmriprep/issues/1500>`__.
6+
7+
1.3.0 (February 7, 2019)
8+
========================
9+
10+
We start the 1.3.x series including a few bugfixes, housekeeping duty and a refactors
11+
to leverage `sMRIPrep <https://github.com/poldracklab/smriprep>`__ (which is a fork of
12+
fMRIPrep's anatomical workflow), pybids>=0.7 for querying dataset, and
13+
`TemplateFlow <https://github.com/templateflow>`__ for handling standard spaces.
14+
15+
* [FIX] Bad ``fsnative`` replacement in CIfTI workflow (#1476) @oesteban
16+
* [FIX] Avoid warning when generating boilerplate (#1464) @oesteban
17+
* [MAINT] resolves #1485 : patch fmriprep-docker automount for use with Python 3.7 (#1486) @rciric
18+
* [RF] Use anatomical workflows from sMRIPrep (#1482) @oesteban
19+
* [MAINT] Update sentry-sdk (#1490) @chrisfilo
20+
* [ENH] Remaining TemplateFlow integrations (#1494) @oesteban
21+
* [MAINT] Update to keep up with poldracklab/niworkflows#299 (#1496) @oesteban
22+
* [FIX] Updating bids-validator to 1.1.3 (#1498) @chrisfilo
23+
24+
125
1.2.6-1 (January 24, 2019)
226
==========================
327

0 commit comments

Comments
 (0)