Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes #23 - Add how to connect from outside uclouvain network #24

Merged
merged 3 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/cpp_fmriprep.slurm
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@
# writtent by CPP people
#
# Submission command for Lemaitre3
#
#
# sbatch cpp_fmriprep.slurm <subjID> <TaskName>
#
#
# examples:
# - 1 subject 1 task
# sbatch cpp_fmriprep.slurm sub-01 visMotLocalizer
#
#
# - 1 subject all task
# sbatch cpp_fmriprep.slurm sub-01 ''
#
#
# - all subjects 1 task
# sbatch cpp_fmriprep.slurm '' visMotLocalizer
#
#
# - multiple subjects
# sbatch cpp_fmriprep.slurm 'sub-01 sub-02' visMotLocalizer
#
#
# - multiple tasks
# sbatch cpp_fmriprep.slurm sub-01 'visMotLocalizer audMotLocalizer'
#
Expand Down
14 changes: 7 additions & 7 deletions doc/cpp_mriqc.slurm
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@
# writtent by CPP people
#
# Submission command for Lemaitre3
#
#
# sbatch cpp_mriqc.slurm <subjID>
#
#
# examples:
# - 1 subject
# sbatch cpp_mriqc.slurm sub-01
#
# sbatch cpp_mriqc.slurm sub-01
#
# - all subjects
# sbatch cpp_mriqc.slurm ''
#
#
# - multiple subjects
# sbatch cpp_mriqc.slurm 'sub-01 sub-02'
# sbatch cpp_mriqc.slurm 'sub-01 sub-02'
#
# - submit all the subjects (1 per job) all at once
# read subj list to submit each to a job
Expand Down Expand Up @@ -73,4 +73,4 @@ singularity run --cleanenv \
"${path_to_singularity_image}" \
/data \
/out \
participant --participant-label "${subjID}"
participant --participant-label "${subjID}"
2 changes: 1 addition & 1 deletion doc/cpp_mriqc_group.slurm
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
# writtent by CPP people
#
# Submission command for Lemaitre3 after running mriqc for each participant
#
#
# sbatch cpp_mriqc_group.slurm

# create jobs_report folder in case they don't exist
Expand Down
13 changes: 12 additions & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,16 @@ To contribute see [here](https://cpp-lln-lab.github.io/CPP_HPC/contributing/)
This repo is a hub to centralize snippet of code, script etc to run analyses (freesurfer, fmriprep, mriqc, etc) in
the [CECI clusters](http://www.ceci-hpc.be/) available for UCLouvain.

To get an account, follow the instructions in the

## FAQ

It is very likely that most of the FAQ could be answered by [CECI documentation](https://support.ceci-hpc.be/doc/)

### How can get a ceci account and connect to a cluster?

To get an account and connect, follow the instructions in the
[documentation](https://support.ceci-hpc.be/doc/).

### How can I connect to a cluster from outside the UCLouvain network?

Use a a VPN to connect as-if you are within the UCLouvain network. Check [how to use UCLouvain VPN](https://intranet.uclouvain.be/fr/myucl/services-informatiques/vpn.html)
4 changes: 2 additions & 2 deletions doc/run_fmriprep.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ Content of the `cpp_fmriprep.slurm` file (download and edit from [here](cpp_fmri
!!! Warning

1. Read the fmriprep documentation to know what you are doing and how the arguments of the run call effects the results
2. All the paths and email are set afte Marco's users for demosntration.
3. Edit the scripts with the info you need to make it run for your user from top to buttom of the script, do not over look the first "commented" chunk cause it is not a real commented section (check the email and job report path, data paths and the `username` etc.).
2. All the paths and email are set afte Marco's users for demosntration.
3. Edit the scripts with the info you need to make it run for your user from top to buttom of the script, do not over look the first "commented" chunk cause it is not a real commented section (check the email and job report path, data paths and the `username` etc.).
```bash
{% include "cpp_fmriprep.slurm" %}
Expand Down
10 changes: 5 additions & 5 deletions doc/run_mriqc.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Content of the `cpp_mriqc.slurm` file (download and edit from [here](cpp_mriqc.s
!!! Warning

1. Read the MRIqc documentation to know what you are doing and how the arguments of the run call effects the results
2. All the paths and email are set afte Marco's users for demosntration.
3. Edit the scripts with the info you need to make it run for your user from top to buttom of the script, do not over look the first "commented" chunk cause it is not a real commented section (check the email and job report path, data paths and the `username` etc.).
2. All the paths and email are set afte Marco's users for demosntration.
3. Edit the scripts with the info you need to make it run for your user from top to buttom of the script, do not over look the first "commented" chunk cause it is not a real commented section (check the email and job report path, data paths and the `username` etc.).
```bash
{% include "cpp_mriqc.slurm" %}
Expand All @@ -92,15 +92,15 @@ sbatch cpp_mriqc.slurm sub-01
ls -d sub* | xargs -n1 -I{} sbatch path/to/cpp_mriqc.slurm {}
```
### Group level
### Group level
Content of the `cpp_mriqc_group.slurm` file (download and edit from [here](cpp_mriqc_group.slurm))
!!! Warning
1. Read the MRIqc documentation to know what you are doing and how the arguments of the run call effects the results
2. All the paths and email are set afte Marco's users for demosntration.
3. Edit the scripts with the info you need to make it run for your user from top to buttom of the script, do not over look the first "commented" chunk cause it is not a real commented section (check the email and job report path, data paths and the `username` etc.).
2. All the paths and email are set afte Marco's users for demosntration.
3. Edit the scripts with the info you need to make it run for your user from top to buttom of the script, do not over look the first "commented" chunk cause it is not a real commented section (check the email and job report path, data paths and the `username` etc.).

```bash
{% include "cpp_mriqc_group.slurm" %}
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ theme:
primary: light blue
accent: light blue
features:
- navigation.expand
- navigation.expand

docs_dir: doc

Expand Down