Skip to content

Commit 873871f

Browse files
author
Chenying Zhao
committed
change example yaml sections to code block of yaml
1 parent b810ec8 commit 873871f

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/source/preparation_config_yaml_file.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,9 @@ Instead, users are expected to define these in this section, **singularity_run**
7777
Example **singularity_run**
7878
-----------------------------------
7979

80-
Below is example section **singularity_run** for ``fMRIPrep``::
80+
Below is example section **singularity_run** for ``fMRIPrep``:
81+
82+
.. code-block:: yaml
8183
8284
singularity_run:
8385
-w: "$BABS_TMPDIR" # this is a placeholder for temporary workspace
@@ -507,7 +509,9 @@ and the interpreting shell for executing the job script.
507509
Example section **cluster_resources**
508510
----------------------------------------
509511

510-
Example section **cluster_resources** for ``QSIPrep``::
512+
Example section **cluster_resources** for ``QSIPrep``:
513+
514+
.. code-block:: yaml
511515
512516
cluster_resources:
513517
interpreting_shell: /bin/bash
@@ -647,7 +651,9 @@ bash commands that are required by job running. An example would be to activate
647651
however, different clusters may require different commands to do so. Therefore, BABS asks the user to
648652
provide it.
649653

650-
Example section **script_preamble** for a specific cluster::
654+
Example section **script_preamble** for a specific cluster:
655+
656+
.. code-block:: yaml
651657
652658
script_preamble: |
653659
source ${CONDA_PREFIX}/bin/activate babs # Penn Med CUBIC cluster; replace 'babs' with your conda env name
@@ -692,7 +698,9 @@ to (saved in) the output RIA (i.e., a permanent storage) where your BABS project
692698
We recommend using space that automatically cleans after the job finishes especially for large-scale dataset
693699
which has a large amount of jobs to do.
694700

695-
Example section **job_compute_space**::
701+
Example section **job_compute_space**:
702+
703+
.. code-block:: yaml
696704
697705
job_compute_space: "${CBICA_TMPDIR}" # Penn Med CUBIC cluster tmp space
698706
@@ -733,7 +741,9 @@ You may have a dataset where not all the subjects (and sessions) have the requir
733741
running the BIDS App. You can simply provide this list of required files, and BABS will exclude those
734742
subjects and sessions who don't have any of listed required files.
735743

736-
Example section **required_files** for ``fMRIPrep``::
744+
Example section **required_files** for ``fMRIPrep``:
745+
746+
.. code-block:: yaml
737747
738748
required_files:
739749
$INPUT_DATASET_#1:
@@ -777,7 +787,9 @@ This section is optional.
777787
This section is to define a list of alert messages to be searched in log files,
778788
and these messages may indicates failure of a job.
779789

780-
Example section **alert_log_messages** for fMRIPrep::
790+
Example section **alert_log_messages** for fMRIPrep:
791+
792+
.. code-block:: yaml
781793
782794
alert_log_messages:
783795
stdout:

0 commit comments

Comments
 (0)