Add brief explanation of zero-based vs. one-based indexing in Slurm array page
Open
Nobody has claimed this yet.
style: article/section 📝
system: cheaha 🖧
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
What would you like to see added?
- Add a brief note about usecase of zero-based vs. one-based indexing in the Slurm array Introduction section here, https://docs.rc.uab.edu/cheaha/slurm/submitting_jobs/#batch-array-jobs-with-known-indices.
- Link to pages,
- https://docs.rc.uab.edu/cheaha/slurm/slurm_tutorial/
- https://docs.rc.uab.edu/cheaha/slurm/practical_sbatch/
- Add key terminologies to the Slurm Array page (for instance, SLURM_ARRAY_TASK_ID)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Slurm array section at the linked batch-array-jobs page and review the nearby Slurm tutorial and practical sbatch pages for terminology and indexing context. Done means the Introduction explains zero- versus one-based indexing, links both referenced pages, and defines key terms such as SLURM_ARRAY_TASK_ID.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, hpc
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100