Skip to content

Commit d6811a0

Browse files
wihetooesteban
authored andcommitted
improving codeblocks
1 parent 7867e5a commit d6811a0

2 files changed

Lines changed: 9 additions & 13 deletions

File tree

docs/contributing_tutorials/adding_a_new_template.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,6 @@ This tutorial assumes you have done all the steps in the preceding tutorial: :re
1616
**Note** at present, this tutorial will require writing access to the TemplateFlow repo.
1717
If you do not have access here, it may be best to open up an issue asking for a template space to be created.
1818

19-
Big picture
20-
===============
21-
22-
Image files (e.g. nifti files) are hosted on OSF and linked to Github.
23-
24-
You will need to publish the directory to OSF and create a link to it to Github.
25-
This link can be done with DataLad, DataLad tracks a dataset and only downloads files when they are needed.
26-
You can read more about DataLad [`Link <FIXLINK>`_].
27-
2819
Step 1: create a new dataset
2920
=============================
3021

@@ -96,6 +87,7 @@ Within this directory we place a template_description.json which is needed in al
9687
The json file contains the following:
9788

9889
.. code-block:: json
90+
9991
{
10092
"Authors": ["Noone"],
10193
"Acknowledgements": "Curated and added to TemplateFlow by Thompson WH",

docs/contributing_tutorials/uploading_to_existing_template.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ All other information (e.g. tsv, json files) will be hosted on github as regular
2020

2121
When you use TemplateFlow, the images are only downloaded when they are needed.
2222
This can be done with DataLad, DataLad tracks a dataset and only downloads files when they are needed.
23-
You can read more about DataLad [`Link <FIXLINK>`_].
23+
You can read more about DataLad `here <https://www.datalad.org>`_.
2424

2525
Thus, when uploading to an existing template, there are two different steps:
2626

@@ -36,14 +36,18 @@ Place the file you want to upload in directory and give them appropriate .
3636
Let us say you want to upload:
3737
`tpl-test/tpl-test_atlas-test1_dseg.nii.gz`, `tpl-test/tpl-test_atlas-test2_dseg.nii.gz`.
3838

39-
>>> export OSF_PASSWORD='<some-password>'
40-
>>> osf upload tpl-test_atlas-test1_dseg.nii.gz tpl-test_atlas-test1_dseg.nii.gz
39+
.. code-block:: bash
40+
41+
export OSF_PASSWORD='<some-password>'
42+
osf upload tpl-test_atlas-test1_dseg.nii.gz tpl-test_atlas-test1_dseg.nii.gz
4143
4244
If you are overwriting an existing image, use the -f flag.
4345

4446
If you want to upload multiple images (let us say we have multiple atlases), use a for bash loop:
4547

46-
>>> ls tpl-test/*_atlas-test*_dseg.nii.gz | parallel -j8 'osf upload {} {}'
48+
.. code-block:: bash
49+
50+
ls tpl-test/*_atlas-test*_dseg.nii.gz | parallel -j8 'osf upload {} {}'
4751
4852
And this will iteratively upload all instances of the atlas to OSF.
4953

0 commit comments

Comments
 (0)