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

[DOCS] minor enhancements in docs after Sydney's review #115

Open
1 of 5 tasks
zhao-cy opened this issue Jul 12, 2023 · 0 comments
Open
1 of 5 tasks

[DOCS] minor enhancements in docs after Sydney's review #115

zhao-cy opened this issue Jul 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zhao-cy
Copy link
Collaborator

zhao-cy commented Jul 12, 2023

I will add more things:

(point 1-3 are from my notes in PR #103)

  1. add a bit more docs re: what if BABS functions fail, e.g.,:
  • singularity run command is not what the user want
  • Cluster resources are not what the user want
  • What if babs-init fails: integrate these two versions together: version in babs-init.rst + “create_babs_project.rst”
  1. Example customized_text for Slurm clusters, using partition request as examples: #SBATCH -p <partition_name>.
  • add this to: preparation_config_yaml_file.rst#cluster-resources.
  • add this to the example walkthrough too.
  1. BABS (only) works on SGE and Slurm HPC clusters. Not designed to be run on local computers as there is no job scheduler system or singularity software.

  2. Sydney's comments in PR [DOCS/ENH] Documentation enhancement and review #103, not those "suggested changes" that are ready to commit

  3. If the input dataset is zipped derivatives, the name of the input dataset should NOT include -. Otherwise, when generating participant_job.sh, the variable e.g., FMRIPREP-ANAT_ZIP won't be valid for bash script.

  • So be careful when you name the output folder to create under zip_foldernames, if you will use the zip derivatives as input dataset of the next step. This is because you'll use the same string for input dataset of zip derivatives as the output foldername you're giving now.
  1. If compute nodes do not have access to internet:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant