Skip to content

Commit

Permalink
change example yaml sections to code block of yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
Chenying Zhao committed Jul 25, 2023
1 parent b810ec8 commit 873871f
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions docs/source/preparation_config_yaml_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ Instead, users are expected to define these in this section, **singularity_run**
Example **singularity_run**
-----------------------------------

Below is example section **singularity_run** for ``fMRIPrep``::
Below is example section **singularity_run** for ``fMRIPrep``:

.. code-block:: yaml
singularity_run:
-w: "$BABS_TMPDIR" # this is a placeholder for temporary workspace
Expand Down Expand Up @@ -507,7 +509,9 @@ and the interpreting shell for executing the job script.
Example section **cluster_resources**
----------------------------------------

Example section **cluster_resources** for ``QSIPrep``::
Example section **cluster_resources** for ``QSIPrep``:

.. code-block:: yaml
cluster_resources:
interpreting_shell: /bin/bash
Expand Down Expand Up @@ -647,7 +651,9 @@ bash commands that are required by job running. An example would be to activate
however, different clusters may require different commands to do so. Therefore, BABS asks the user to
provide it.

Example section **script_preamble** for a specific cluster::
Example section **script_preamble** for a specific cluster:

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

Example section **job_compute_space**::
Example section **job_compute_space**:

.. code-block:: yaml
job_compute_space: "${CBICA_TMPDIR}" # Penn Med CUBIC cluster tmp space
Expand Down Expand Up @@ -733,7 +741,9 @@ You may have a dataset where not all the subjects (and sessions) have the requir
running the BIDS App. You can simply provide this list of required files, and BABS will exclude those
subjects and sessions who don't have any of listed required files.

Example section **required_files** for ``fMRIPrep``::
Example section **required_files** for ``fMRIPrep``:

.. code-block:: yaml
required_files:
$INPUT_DATASET_#1:
Expand Down Expand Up @@ -777,7 +787,9 @@ This section is optional.
This section is to define a list of alert messages to be searched in log files,
and these messages may indicates failure of a job.

Example section **alert_log_messages** for fMRIPrep::
Example section **alert_log_messages** for fMRIPrep:

.. code-block:: yaml
alert_log_messages:
stdout:
Expand Down

0 comments on commit 873871f

Please sign in to comment.