Skip to content

Commit 361ea8f

Browse files
committed
👽 Fix script to look for main branch (was master)
1 parent f22249f commit 361ea8f

File tree

11 files changed

+31
-31
lines changed

11 files changed

+31
-31
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- TOC -->
22

33
- [Branches](#branches)
4-
- [Versions](#versions)
5-
- [`nightly`](#nightly)
6-
- [C-PAC release tags](#c-pac-release-tags)
4+
- [Versions](#versions)
5+
- [`nightly`](#nightly)
6+
- [C-PAC release tags](#c-pac-release-tags)
77
- [Guidelines](#guidelines)
8-
- [Building](#building)
9-
- [Let CircleCI build your drafts / works-in-progress](#let-circleci-build-your-drafts--works-in-progress)
10-
- [Build locally (C-PAC ≥ v1.8.0)](#build-locally-c-pac-≥-v180)
8+
- [Building](#building)
9+
- [Let CircleCI build your drafts / works-in-progress](#let-circleci-build-your-drafts--works-in-progress)
10+
- [Build locally (C-PAC ≥ v1.8.0)](#build-locally-c-pac-≥-v180)
1111
- [Flowcharts](#flowcharts)
1212
- [References and citations](#references-and-citations)
1313
- [Environment notes](#environment-notes)
@@ -17,7 +17,7 @@
1717
<a id="markdown-branches" name="branches"></a>
1818
## Branches
1919

20-
Please, always base changes on the `source` branch. `master` branch will be overwritten by the CI deployment.
20+
Please, always base changes on the `source` branch. `main` branch will be overwritten by the CI deployment.
2121

2222
<a id="markdown-versions" name="versions"></a>
2323
### Versions
@@ -67,7 +67,7 @@ Steps to build a release:
6767
* Build environment will match actual docs build environment
6868
* CircleCI takes ~2 minutes to build
6969
1. Fork https://github.com/FCP-INDI/fcp-indi.github.io
70-
1. In your fork's settings, set the GitHub Pages `source` to `master` branch
70+
1. In your fork's settings, set the GitHub Pages `source` to `main` branch
7171
![GitHub Pages settings example screenshot](./images/github-pages-settings-example.png)
7272
1. Add your project on CircleCI
7373
1. Merge your draft / work-in-progress into your fork's `source` branch. Make sure you push to your fork and not the main repository's `source` branch.

docs/_sources/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ def yaml_to_rst(path):
159159
# The encoding of source files.
160160
# source_encoding = 'utf-8-sig'
161161

162-
# The master toctree document.
162+
# The main toctree document.
163163
master_doc = 'index'
164164

165165
# A list of warning types to suppress arbitrary warning messages.

docs/_sources/developer/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. CPAC documentation master file, created by
1+
.. CPAC documentation main file, created by
22
sphinx-quickstart on Fri Jun 22 13:46:06 2012.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.

docs/_sources/developer/workflows/cpac_pipeline.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ C-PAC Pipeline Construction
77
Configuration Object
88
====================
99

10-
The 'c' variable in cpac_pipeline.py is a `Configuration object <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/utils/configuration.py>`_, which is an abstract representation used to store the options for the pipeline configuration YAML after it is read in by C-PAC. Each attribute of the Configuration object is a key from the YAML file, with values mirroring the YAML.
10+
The 'c' variable in cpac_pipeline.py is a `Configuration object <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/utils/configuration.py>`_, which is an abstract representation used to store the options for the pipeline configuration YAML after it is read in by C-PAC. Each attribute of the Configuration object is a key from the YAML file, with values mirroring the YAML.
1111

1212
Strategy Object
1313
===============

docs/_sources/developer/workflows/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. CPAC documentation master file, created by
1+
.. CPAC documentation main file, created by
22
sphinx-quickstart on Fri Jun 22 13:46:06 2012.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.

docs/_sources/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. CPAC documentation master file, created by
1+
.. CPAC documentation main file, created by
22
sphinx-quickstart on Fri Jun 22 13:46:06 2012.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.

docs/_sources/user/appendix.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ A Note About the \*nix Command Line
4040

4141
Overview
4242
--------
43-
If you are using Ubuntu (version 12/14) you can download and run `cpac_install.sh <https://github.com/FCP-INDI/C-PAC/blob/master/cpac_install.sh?raw=true>`__ with the following terminal commands as root:
43+
If you are using Ubuntu (version 12/14) you can download and run `cpac_install.sh <https://github.com/FCP-INDI/C-PAC/blob/main/cpac_install.sh?raw=true>`__ with the following terminal commands as root:
4444

4545
.. code-block:: console
4646
47-
wget https://github.com/FCP-INDI/C-PAC/blob/master/cpac_install.sh?raw=true
47+
wget https://github.com/FCP-INDI/C-PAC/blob/main/cpac_install.sh?raw=true
4848
mv cpac_install.sh?raw=true cpac_install.sh
4949
chmod +x cpac_install.sh
5050
sudo ./cpac_install.sh -r

docs/_sources/user/func.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ You can also specify slice timing parameters within the subject list. If you wi
109109

110110
.. line-block::
111111
**If all subjects within a site have the same acquisition order:**
112-
Use the template :file:`scan_parameters.csv` file available for download `here <https://raw.github.com/FCP-INDI/C-PAC/master/configs/scan_parameters.csv>`__.
112+
Use the template :file:`scan_parameters.csv` file available for download `here <https://raw.github.com/FCP-INDI/C-PAC/main/configs/scan_parameters.csv>`__.
113113

114114
**If subjects within a site have different acquisition orders:**
115-
Use the template :file:`scan_parameters_multiscan.csv` file available for download `here <https://raw.github.com/FCP-INDI/C-PAC/master/configs/scan_parameters_multiscan.csv>`__.
115+
Use the template :file:`scan_parameters_multiscan.csv` file available for download `here <https://raw.github.com/FCP-INDI/C-PAC/main/configs/scan_parameters_multiscan.csv>`__.
116116

117117
Slice Timing information should be entered into these files as follows:
118118

docs/_sources/user/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. C-PAC documentation master file, created by
1+
.. C-PAC documentation main file, created by
22
sphinx-quickstart on Fri Jul 20 16:32:55 2012.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.

docs/_sources/user/pipelines/preconfig.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
default: The Default Pipeline
55
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
66

7-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/dev/docker_data/default_pipeline.yml <https://github.com/FCP-INDI/C-PAC/blob/master/dev/docker_data/default_pipeline.yml>`_
7+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/dev/docker_data/default_pipeline.yml <https://github.com/FCP-INDI/C-PAC/blob/main/dev/docker_data/default_pipeline.yml>`_
88

99
**Note:** C-PAC runs this pipeline by default, and it is not necessary to invoke the `--preconfig` flag to run it.
1010

@@ -32,7 +32,7 @@ Several different individual level analysis are performed on the fMRI data inclu
3232
anat-only: Default with Anatomical Preprocessing Only
3333
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3434

35-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_anat-only.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_anat-only.yml>`_
35+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_anat-only.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_anat-only.yml>`_
3636

3737
Based on the preprocessing decisions of the default pipeline, this preconfiguration allows you to immediately kick off a run with only anatomical preprocessing selected. This includes:
3838

@@ -43,7 +43,7 @@ Based on the preprocessing decisions of the default pipeline, this preconfigurat
4343
preproc: Default without Derivatives
4444
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4545

46-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_preproc.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_preproc.yml>`_
46+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_preproc.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_preproc.yml>`_
4747

4848
Based on the preprocessing decisions of the default pipeline, this preconfiguration allows you to preprocess all of your data, without launching into calculation of outputs and data derivatives. This includes:
4949

@@ -64,7 +64,7 @@ Functional:
6464
ndmg: Neurodata's 'ndmg-f' Pipeline
6565
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6666

67-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_ndmg.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_ndmg.yml>`_
67+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_ndmg.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_ndmg.yml>`_
6868

6969
This pipeline is the result of `Neurodata's <https://neurodata.io/>`_ study to converge upon the intersection of pipeline configuration decisions that maximizes discriminability between participants' data, drawing from the connectome graphs produced (labeled 'ndmg_graph' in the C-PAC output directory). This pipeline invokes a minimal set of preprocessing.
7070

@@ -77,7 +77,7 @@ Note, the 'ndmg_graph' connectome graph outputs are always produced by C-PAC. Th
7777
fmriprep-options: fmriprep-Options Pipeline
7878
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7979

80-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_fmriprep-options.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_fmriprep-options.yml>`_
80+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_fmriprep-options.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_fmriprep-options.yml>`_
8181

8282
This pipeline is designed to increase reproducibility with the preprocessing results of the `fmriprep pipeline package <https://fmriprep.readthedocs.io/en/stable/>`_ produced by the `Poldrack Lab at Stanford University <https://poldracklab.stanford.edu/>`_.
8383

@@ -87,22 +87,22 @@ This pipeline is designed to increase reproducibility with the preprocessing res
8787
benchmark-ANTS: C-PAC Benchmark with ANTs Registration
8888
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8989

90-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_benchmark-ANTS.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_benchmark-ANTS.yml>`_
90+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_benchmark-ANTS.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_benchmark-ANTS.yml>`_
9191

9292
The benchmark pipeline has remained mostly unchanged since the project's inception, and is used at the end of each release cycle to ensure the results of C-PAC's key outputs have not changed. It is designed to test a wide range of pipeline options. This pipeline is based on registration-to-template using the ANTs/ITK toolset, as this decision impacts many other aspects of the pipeline further downstream.
9393

9494
benchmark-FNIRT: C-PAC Benchmark with FSL FNIRT Registration
9595
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9696

97-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_benchmark-FNIRT.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_benchmark-FNIRT.yml>`_
97+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_benchmark-FNIRT.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_benchmark-FNIRT.yml>`_
9898

9999
The benchmark pipeline has remained mostly unchanged since the project's inception, and is used at the end of each release cycle to ensure the results of C-PAC's key outputs have not changed. It is designed to test a wide range of pipeline options. This pipeline is based on registration-to-template using the FSL FLIRT & FNIRT, as this decision impacts many other aspects of the pipeline further downstream.
100100

101101

102102
Monkey: Default with Monkey Preprocessing
103103
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104104

105-
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_monkey.yml <https://github.com/FCP-INDI/C-PAC/blob/master/CPAC/resources/configs/pipeline_config_monkey.yml>`_
105+
Pipeline Configuration YAML: `https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_monkey.yml <https://github.com/FCP-INDI/C-PAC/blob/main/CPAC/resources/configs/pipeline_config_monkey.yml>`_
106106

107107
This pipeline is based on the work of Xu et al. (2019) and `nhp-ABCD-BIDS-pipeline. <https://zenodo.org/record/3888969#.Xw31IpNKjyU>`_
108108

0 commit comments

Comments
 (0)