Skip to content

Commit 3e3bb90

Browse files
committed
docs: import config file from package data
1 parent e81839f commit 3e3bb90

File tree

1 file changed

+5
-60
lines changed

1 file changed

+5
-60
lines changed

fmriprep/config.py

Lines changed: 5 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -11,66 +11,10 @@
1111
The module has a :py:func:`~fmriprep.config.to_filename` function to allow writting out
1212
the settings to hard disk in *ToML* format, which looks like:
1313
14-
.. code-block:: toml
15-
16-
[environment]
17-
cpu_count = 8
18-
exec_env = "posix"
19-
free_mem = 2.2
20-
overcommit_policy = "heuristic"
21-
overcommit_limit = "50%"
22-
nipype_version = "1.5.0"
23-
templateflow_version = "0.4.2"
24-
version = "20.0.1"
25-
26-
[nipype]
27-
crashfile_format = "txt"
28-
get_linked_libs = false
29-
nprocs = 8
30-
omp_nthreads = 8
31-
plugin = "MultiProc"
32-
resource_monitor = false
33-
stop_on_first_crash = false
34-
35-
[execution]
36-
bids_dir = "/data/openfmri/ds000005"
37-
boilerplate_only = false
38-
exec_env = "posix"
39-
fs_license_file = "/opt/freesurfer/license.txt"
40-
fs_subjects_dir = "/data/openfmri/ds000005/derivatives/freesurfer-6.0.1"
41-
log_dir = "/data/openfmri/ds000005/derivatives/fmriprep/logs"
42-
log_level = 15
43-
low_mem = false
44-
md_only_boilerplate = false
45-
notrack = true
46-
output_dir = "/data/openfmri/ds000005/derivatives"
47-
reports_only = false
48-
run_uuid = "20200302-174345_9ba9f304-82de-4538-8c3a-570c5f5d8f2f"
49-
participant_label = [ "01",]
50-
work_dir = "work/"
51-
write_graph = false
52-
53-
[workflow]
54-
anat_only = false
55-
aroma_err_on_warn = false
56-
aroma_melodic_dim = -200
57-
bold2t1w_dof = 6
58-
cifti_output = false
59-
fmap_bspline = false
60-
force_syn = false
61-
hires = true
62-
ignore = []
63-
longitudinal = false
64-
medial_surface_nan = false
65-
run_reconall = true
66-
skull_strip_fixed_seed = false
67-
skull_strip_template = "OASIS30ANTs"
68-
t2s_coreg = false
69-
use_aroma = false
70-
71-
[nipype.plugin_args]
72-
maxtasksperchild = 1
73-
raise_insufficient = false
14+
.. literalinclude:: ../fmriprep/data/tests/config.toml
15+
:language: toml
16+
:name: fmriprep.toml
17+
:caption: **Example file representation of fMRIPrep settings**.
7418
7519
This config file is used to pass the settings across processes,
7620
using the :py:func:`~fmriprep.config.load` function.
@@ -129,6 +73,7 @@
12973
# cmp is not used by fmriprep, so ignore nipype-generated warnings
13074
warnings.filterwarnings('ignore', 'cmp not installed')
13175
warnings.filterwarnings('ignore', 'This has not been fully tested. Please report any failures.')
76+
warnings.filterwarnings('ignore', "sklearn.externals.joblib is deprecated in 0.21")
13277
warnings.filterwarnings('ignore', "can't resolve package from __spec__ or __package__")
13378
warnings.filterwarnings('ignore', category=DeprecationWarning)
13479
warnings.filterwarnings('ignore', category=FutureWarning)

0 commit comments

Comments
 (0)