Submit Script ALELEON Supercomputer: Perbedaan antara revisi

Dari ALELEON by EFISON
(→‎SLURM Satu Node: paraphrasing, major update)
(→‎Struktur Submit Script: menambah contoh script)
 
(74 revisi perantara oleh pengguna yang sama tidak ditampilkan)
Baris 1: Baris 1:
SLURM adalah software scheduler untuk mengantarkan job komputasi user ke Compute Node. Bila tidak menggunakan SLURM maka job user akan berjalan di Login Node yang tidak layak untuk komputasi. Selain itu SLURM mencatat penggunaan [[Core Hour]] user.  
Halaman ini menjelaskan panduan memahami, membuat, dan mengisi '''SLURM Submit Script''' (atau disingkat Submit Script) yang merupakan 'formulir' untuk menjalankan komputasi ke Compute Node menggunakan sistem manajemen SLURM.  


== '''Alur Penggunaan SLURM untuk Job Submission''' ==
=='''Struktur Submit Script'''==
Pada contoh berikut, user akan menjalankan komputasi HPCG ke Compute Node dengan nama program '''<nowiki/>''''xhpcg-3.1':
Submit Script mempunyai 4 bagian utama:
[ale01@login hpcg-tutorial]$ ls
hasil  hpcg.dat  '''xhpcg-3.1'''
User harus membuat '''SLURM submission script''' yang berisikan alokasi resources (CPU, GPU, RAM, waktu, dkk) dan alur jalannya program (pada contoh ini, xhpcg-3.1). Langkah membuat SLURM submission script akan dijelaskan di bagian berikutnya. Pada contoh ini, user membuat SLURM submission script bernama ''''slurm-hpcgnvidia'''<nowiki/>'.
[ale01@login hpcg-tutorial]$ ls
hasil  hpcg.dat  '''slurm-hpcgnvidia'''  xhpcg-3.1
Jalankan SLURM submission script dengan perintah '''sbatch'''. Perhatikan bahwa SLURM menjalankan job user dengan nomor ID 231.
[ale01@login hpcg-tutorial]$ sbatch slurm-hpcgnvidia
Submitted batch job 231
User dapat melihat status jalannya job dengan perintah '''squeue'''. Perhatikan bahwa job ID 231 sedang berjalan.
[ale01@login hpcg-tutorial]$ squeue -l
Mon Mar 22 10:43:22 2021
              JOBID PARTITION    NAME    USER    STATE      TIME TIME_LIMI  NODES NODELIST(REASON)
                230      epyc  HPLBLIS    ale02  RUNNING      9:42  20:00:00      1 epyc01
                229      epyc  HPLBLIS    ale02  RUNNING      10:46  20:00:00      1 epyc02
                231 gpu_amper slurm-hp    ale01  RUNNING      2:00  1:00:00      1 gpu1
Job selesai bila sudah tidak terlihat di daftar squeue. User dapat mengatur konfigurasi file output di SLURM submission script seperti contoh dibawah ini (output result-231.err dan result-231.out).
[ale01@login hpcg-tutorial]$ ls
hasil                                      hpcg.dat                          result-231.err  slurm-hpcgnvidia
HPCG-Benchmark_3.1_2021-03-22_10-43-30.txt  hpcg_log_2021.03.22.10.41.25.txt  result-231.out  xhpcg-3.1


== '''Perintah Esensial SLURM''' ==
#Header '''#!/bin/bash''' (karena script ini ditulis dengan bahasa bash)
Berikut adalah perintah esensial bagi user untuk menggunakan SLURM:  
#'''Parameter SBATCH''' untuk mengalokasikan resources job seperti CPU, RAM, GPU, time, dll.
{| class="wikitable"
#*''Pada penggunaan superkomputer, user menentukan sendiri jumlah alokasi komputasi (CPU, RAM, GPU, time limit) yang akan dipakai untuk menjalankan komputasi asalkan tidak melebihi kapasitas Compute Node ALELEON Supercomputer.''
!Perintah
# Apabila membutuhkan, memuat modul software tertentu untuk menjalankan komputasi user dengan '''[https://wiki.efisonlt.com/wiki/Module_Environment#Module_Environment_di_SLURM_Submit_Script Module Environment]'''
!Penjelasan
# Alur perintah menjalankan program user.
 
[[Berkas:Slurmsubmitscript.png|al=|nir|jmpl|''Struktur dan contoh SLURM Submit Script'']]Berikut adalah beberapa contoh nyata Submit Script:  
 
* Template Submit Script untuk masing-masing software komputasi tersedia di laman [[Daftar Software Komputasi dan Tutorial Penggunaan|'''Daftar Software Komputasi dan Tutorial Penggunaan''']]
 
{| class="wikitable mw-collapsible mw-collapsed"
!Contoh Submit Script menjalankan software R
|-
|-
|
|<syntaxhighlight lang="bash" line="1">
$ sbatch <slurm-submission-script>
#!/bin/bash
|Mengirim SLURM submission script untuk dijalankan di SLURM.
 
# -------------------------------------------------------------
# | Template SLURM Submit Script
# | Software        : R
# | Versi          : 4.3.0
# |
# | NOTES:
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini bersifat referensi.
# |    User dapat mengubah bagian yang sekiranya perlu diubah.
# -------------------------------------------------------------
 
# --------------------------------------------------
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------
 
# Alokasi jumlah core thread CPU
#SBATCH --ntasks=32
 
# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=128GB
 
# Alokasi limit waktu menjalankan job.
# Format HH:MM:SS atau D-HH:MM:SS
#SBATCH --time=2-00:00:00
 
# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt
 
# Definisi file untuk menampung output error log   
#SBATCH --error=error-%j.txt
 
# Nama input file R dengan format file-nya
INPUT_FILE='dataumat.R'
 
# Memuat modul software R yang akan digunakan user
module load R/4.3.0-GCC11.3-MKL
 
# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------
 
# Perintah menjakankan R
Rscript ${INPUT_FILE}
</syntaxhighlight>
|}
{| class="wikitable mw-collapsible mw-collapsed"
!Contoh Submit Script menjalankan software LAMMPS
|-
|-
|
|<syntaxhighlight lang="bash" line="1">
$ squeue
#!/bin/bash
|Melihat status dan antrian semua komputasi. Tambahan opsi:  
 
# ------------------------------------------------------------------------
# | Template SLURM Submit Script
# | Software        : LAMMPS
# | Versi          : 2022.06.23u4
# |
# | NOTES:  
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini adalah referensi - user dapat mengubah bagian yang
# |    sekiranya perlu diubah.
# ------------------------------------------------------------------------


* squeue -l : squeue dengan info lengkap
# --------------------------------------------------
* squeue -u $USER : squeue untuk job user saja
# Alokasi komputasi, modul software, dan file input
|-
# --------------------------------------------------
|
 
$ scancel <job-ID>
# Partisi compute node GPU
|Membatalkan job. Misalkan pada contoh diatas dengan job ID 231:
#SBATCH --partition=ampere
$ scancel 231
|}


== '''SLURM Submission Script''' ==
# Alokasi jumlah GPU
'''SLURM submission script adalah bash-script yang bertujuan untuk menjalankan program komputasi melalui SLURM'''. Terdapat 4 komponen penting pada SLURM submission script:
#SBATCH --gpus=1


[[Berkas:Contoh_SLURM.png|al=|nirbing|578x578px]]
# Alokasi jumlah core thread CPU
# Header #!/bin/bash untuk bash script.
#SBATCH --ntasks=16
# Parameter alokasi resources CPU, memori, waktu, output, dll dengan '''SBATCH'''.
# Pengaturan [[Module Environment|'''Module Environment''']] untuk memuat software yang dibutuhkan.
# Alur perintah untuk menjalankan komputasi user.


=== '''Resources HPC Aleleon Mk.II''' ===
# Rekomendasi 2 thread OMP secara umum
Sebelum menggunakan SLURM, user harus mengetahui spesifikasi dan limitasi hardware dari HPC Aleleon Mk.II dimana dijelaskan pada tabel dibawah ini.
#SBATCH --cpus-per-task=2
{| class="wikitable"
|+Partisi Hardware HPC Aleleon Mk.II
![[Partisi Aleleon Mk.II|Partisi]]
!Keterangan
!Jumlah Node
!Jumlah Core CPU per node
!Jumlah RAM per node
!Jumlah GPU per node
|-
|'''epyc''' (DEFAULT)
|compute node CPU
|3
|128
|250GB
|0
|-
|'''gpu_ampere'''
|compute node GPU
|1
|128
|125GB
|2
|}


=== '''Parameter Resources SBATCH Esensial''' ===
# Alokasi jumlah memori RAM (satuan GB)
Berikut adalah daftar parameter SBATCH basis yang esensial:
#SBATCH --mem=64GB
{| class="wikitable"
|+Parameter SBATCH SLURM basic
!Parameter
!Penjelasan
|-
|#SBATCH --ntasks=<cpu-cores>
|Jumlah alokasi cores CPU yang akan dipakai. Contoh mengalokasikan 64 core CPU:
$SBATCH --ntasks=64
|-
|#SBATCH --mem=<mem-capacity>
|Jumlah alokasi memori RAM. User bisa menetapkan satuan apapun namun kami merekomendasikan satuan GB. Contoh mengalokasikan memori 64GB:
$SBATCH --mem=64GB
|-
|#SBATCH --time=<walltime>
|Walltime (waktu maksimal) yang dialokasikan untuk job user. Walltime maksimal saat ini untuk HPC Aleleon Mk.II adalah 14 hari. Format waktu <walltime> yang digunakan:


* HH:MM:SS. Contoh alokasi 10 jam= #SBATCH --time=10:00:00
# Alokasi limit waktu menjalankan job
* D-HH:MM:SS. Contoh alokasi 2 hari= #SBATCH --time=2-00:00:00
#SBATCH --time=10:00:00
|}


Berikut adalah parameter untuk output komputasi:
# Definisi file untuk menampung output terminal
{| class="wikitable"
#SBATCH --output=result-%j.txt
|+Parameter SBATCH SLURM untuk output
!Parameter
!Penjelasan
|-
|#SBATCH --output=<output-file>
|Merekap output terminal dari program user. Terdapat variabel spesial yaitu %j untuk merekap JOB ID. Format file dibebaskan. Contoh:
$SBATCH --output=hasil-%j.out
|-
|#SBATCH --error=<error-file>
|Merekap output verbose program, berguna untuk melakukan troubleshooting dikala program user tidak berjalan. Contoh:
#SBATCH --error=hasil-%j.err
|}
Parameter SBATCH khusus lainnya untuk mengakses GPU Node, threading OpenMP, paralel multi-node akan dijelaskan pada bagian berikutnya.


=== '''Apakah Terdapat Aturan Mengatur Konfigurasi SBATCH?''' ===
# Definisi file untuk menampung output error log   
User dibebaskan untuk mengisi parameter SBATCH selama tidak melebihi nilai maksimal (seperti CPU maksimal 128) atau nilai yang salah. Tidak terdapat aturan seperti alokasi CPU / RAM mengikuti nilai the power of two. User bisa saja memasukkan alokasi CPU dan RAM yang 'tidak wajar' seperti 17 core CPU dan 41GB RAM.  
#SBATCH --error=error-%j.txt 


Bila terjadi kesalahan parameter SLURM, user tetap bisa melakukan sbatch namun job tidak akan berjalan (tidak muncul di squeue). Adalah praktek yang baik untuk selalu menyertakan parameter #SBATCH --error supaya terdapat log ketika job tidak berjalan via SLURM.
# Nama input file LAMMPS dengan format file-nya
INPUT_FILE='zobarne.lammps'


== '''Contoh SLURM Submission Script Satu Node CPU''' ==
# Memuat modul software LAMMPS versi GPU
module load lammps/2022.06.23u4-GCC11.3-AOCL4.0-CUDA12.1


=== '''SLURM Satu Node'''  ===
# -------------------------------------------------
Program akan berjalan dengan jumlah core CPU dan RAM yang definisikan pada parameter SBATCH ntasks dan mem. Contoh lengkap SLURM submission script dengan CPU 128 threads dan RAM 16GB:
# RUN SCRIPT
#!/bin/bash
# -------------------------------------------------
#SBATCH --ntasks=128
#SBATCH --mem=16GB
#SBATCH --time=00:10:00
#SBATCH --output=result-%j.out
#SBATCH --error=result-%j.err
# MODULE
# module load software yang dibutuhkan
# RUN COMMAND
# run command software...


=== '''SLURM Satu Node MPI'''  ===
# Export threading OMP
User hendaknya menggunakan modul MPI default yang direkomendasikan admin EFISON:
export OMP_NUM_THREADS=$SLURM_CPUS_PER_TASK
$ module load openmpi
Perhatikan bahwa '''jumlah task mpirun tidak boleh melebihi ntasks''' pada SBATCH. Selain itu, masukkan '''parameter UCX pada perintah mpirun untuk memanfaatkan protokol UCX''' (Unified Communication X) guna mendapatkan performa lebih:
--mca pml ucx --mca osc ucx
Contoh lengkap SLURM submission script dengan CPU 64 core, RAM 32GB, dan proses MPI 64:
#!/bin/bash
#SBATCH '''--ntasks=64'''
#SBATCH --mem=32GB
#SBATCH --time=1:00:00
#SBATCH --output=result-%j.out
#SBATCH --error=result-%j.err
# MODULE
module load openmpi
# dan module load lain yang dibutuhkan
# RUN COMMAND
'''mpirun -np 64''' '''--mca pml ucx --mca osc ucx''' <program-MPI...>


=== '''SLURM Satu Node MPI + OpenMP'''  ===
# Perintah menjalankan LAMMPS
Contoh: user ingin menggunakan 128 threads CPU dengan pembagian 16 MPI processes dam 8 OMP thread per MPI (Total CPU terpakai = MPI x OMP. Penjelasan lebih detail kunjungi Hybrid MPI dan OMP). Pada SLURM, '''user mendeklarasikan variabel OMP melalui parameter SLURM_CPUS_PER_TASK dan SBATCH cpus-per-task.'''
mpirun --mca pml ucx --mca osc ucx --np $SLURM_NTASKS lmp -sf gpu -pk gpu $SLURM_GPUS -in $INPUT_FILE
{| class="wikitable"
</syntaxhighlight>
|+Parameter SBATCH SLURM untuk OpenMP / Hybrid
!Parameter
!Penjelasan
|-
|#SBATCH --cpus-per-task=<cpu-task>
|Jumlah komputasi CPU per ntask. Bila diterapkan ke MPI-OMP artinya jumlah OMP per MPI.
|}
|}
Berikut adalah contoh lengkap SLURM submission script dengan 16 proses MPI, 8 OMP per MPI, dan RAM 128GB. Perhatikan bahwa jumlah proses MPI mengikuti ntasks.
#!/bin/bash
#SBATCH --ntasks='''16'''
'''#SBATCH --cpus-per-task=8'''
#SBATCH --mem=128GB
#SBATCH --time=1-00:00:00
#SBATCH --output=result-%j.out
#SBATCH --error=result-%j.err
# MODULE
module load openmpi
# dan modul lain yang dibutuhkan
# RUN COMMAND
'''export OMP_NUM_THREADS=${SLURM_CPUS_PER_TASK}'''
mpirun -np '''16''' --mca pml ucx --mca osc ucx <program-MPI...>


== '''Contoh SLURM Submission Script Banyak Node CPU''' ==
== '''Parameter SBATCH esensial''' ==
Pada HPC, program dengan dukungan komputasi paralel (seperti MPI dan ekstensi lib. paralel lainnya) dapat dijalankan secara paralel dengan banyak node sekaligus. '''SLURM menggunakan parameter SBATCH nodes dan ntasks-per-node''' untuk menjalankan komputasi paralel banyak node.
Parameter SBATCH berfungsi untuk mengatur alokasi komputasi (CPU, RAM, GPU, time limit) dan output program. SLURM mempunyai ratusan opsi untuk parameter SBATCH dimana pada tutorial ini kami memberikan daftar SBATCH yang esensial untuk menjalankan komputasi di ALELEON Supercomputer.
{| class="wikitable"
|+Parameter SBATCH SLURM untuk banyak node
!Parameter
!Penjelasan
|-
|#SBATCH --nodes=<nodes>
|Jumlah node yang akan dipakai.
|-
|#SBATCH --ntasks-per-node=<cpu-cores>
|Jumlah ntasks per node.
|}
'''Sementara itu jumlah memori yang dideklarasikan (SBATCH mem) adalah dan sudah otomatis per node''' (sehingga nilai maksimal 250GB). Tidak ada parameter total mem atau mem-per-node.


=== '''SLURM Banyak Node MPI''' ===
=== Format Penulisan SBATCH ===
'''Perhatikan bahwa total task MPI task adalah nodes X ntasks-per-node'''. Contoh ketika user ingin menggunakan 2 node, 128 threads per node, dan RAM 192GB per node maka konfigurasi SBATCH menjadi:
SBATCH ditulis dengan format <code>'''#SBATCH --<nama-parameter>=<nilai>'''</code> sesuai contoh berikut<syntaxhighlight lang="bash">
#SBATCH --nodes=2
# --- Contoh penulisan SBATCH yang benar
#SBATCH --ntasks-per-node=128
#SBATCH --ntasks=32
#SBATCH --mem=192GB
#SBATCH --mem=64GB
Total proses MPI dari konfigurasi tersebut adalah 2 x 128 = '''256 proses MPI'''. Berikut adalah contoh lengkap SLURM submission script untuk menjalankan konfigurasi diatas:
#SBATCH --time=01:00:00
#!/bin/bash
#SBATCH --output=result-%j.txt
#SBATCH --error=error-%j.txt
#SBATCH --nodes=2
#SBATCH --ntasks-per-node=128
#SBATCH --mem=192GB
#SBATCH --time=10:00:00
#SBATCH --output=chem-%j.out
#SBATCH --error=chem-%j.out
# MODULE
module load openmpi
# atau modul lain yang dibutuhkan
# RUN COMMAND
'''mpirun -np 256''' --mca pml ucx --mca osc ucx <program-MPI...>
=== '''SLURM Banyak Node MPI + OpenMP''' ===
Kita gunakan contoh MPI + OpenMP sebelumnya dengan 16 ntasks dan 8 cpus-per-task (16 proses MPI dan 8 OMP per MPI) per node. Bila dijalankan 2 node misalnya, maka parameter akan menjadi:
  #SBATCH --nodes=2
#SBATCH --ntasks-per-node=16
#SBATCH --cpus-per-task=8
Total proses MPI tetap mengikuti aturan nodes x ntasks-per-node yaitu 2 x 16 = 32 proses MPI. Contoh lengkap SLURM submission script:
#!/bin/bash
#SBATCH --nodes=2
#SBATCH --ntasks-per-node=16
#SBATCH --cpus-per-task=8
#SBATCH --mem=128GB
#SBATCH --time=1-00:00:00
#SBATCH --output=result-%j.out
#SBATCH --error=result-%j.err
# MODULE
module load openmpi
# atau modul yang dibutuhkan
# RUN COMMAND
'''export OMP_NUM_THREADS=${SLURM_CPUS_PER_TASK}'''
mpirun -np 32 --mca pml ucx --mca osc ucx <program-MPI...>


== '''Contoh SLURM Submission Script GPU''' ==
# --- Contoh penulisan SBATCH yang salah
Berikut adalah parameter khusus untuk menggunakan GPU node dimana user akan menjalankan komputasi di partisi khusus GPU bernama '''gpu_ampere'''.
#SBATCH --ntasks = 32
#SBATCH --mem= 64GB
#SBATCH --mem = 64 GB
</syntaxhighlight>
=== #SBATCH --partition ===
Menentukan jenis partisi (Compute Node) untuk menjalankan job komputasi user. ALELEON Supercomputer mempunyai 2 partisi Compute Node:
{| class="wikitable"
{| class="wikitable"
|+Parameter SBATCH SLURM untuk GPU Node
!Partisi Compute Node
!Parameter
!Menulis SBATCH
!Penjelasan
|-
|-
|#SBATCH --partition=gpu_ampere
|'''epyc''' (Compute Node CPU)
|Memasukkan komputasi ke partisi GPU (yaitu bernama gpu_ampere)
|Merupakan partisi default
 
* user tidak perlu menulis SBATCH parameter untuk epyc
|-
|-
|#SBATCH --gres=gpu:<jumlah-GPU>
|'''ampere''' (Compute Node GPU)
|Contoh menggunakan 2 GPU:
|<code>#SBATCH --partition=ampere</code>
$SBATCH --gres=gpu:2
|}
|}
Contoh lengkap SLURM Submission script dengan 2 GPU, 16 CPU, dan RAM 32GB:
#!/bin/bash
'''#SBATCH --partition=gpu_ampere
#SBATCH --gres=gpu:2'''
#SBATCH --ntasks=16
#SBATCH --mem=32GB
#SBATCH --time=1:00:00
#SBATCH --output=result-%j.out
#SBATCH --error=result-%j.err
# MODULE
# module load yang dibutuhkan
# RUN COMMAND
# run command software...


== '''Contoh SLURM Submission Script Software Spesifik''' ==
=== #SBATCH --ntasks, --mem, dan --gpus ===
Terdapat software yang membutuhkan contoh SLURM submission script spesifik supaya dapat berjalan dengan baik. Kunjungi [[Software di HPC Aleleon Mk.II|'''Software di HPC Aleleon Mk.II''']].
ntasks, mem, dan gpus adalah parameter SBATCH utama untuk menentukan alokasi komputasi.
 
* '''ntasks''' -> alokasi jumlah '''core CPU.''' ALELEON Supercomputer mengaktifkan ''SMT (Simultaneous Multithreading)'' pada semua CPU sehingga ntasks mendefinisikan jumlah core thread CPU.
* '''mem''' -> alokasi jumlah '''memori RAM'''. Ditulis dengan satuan memori GB (Gigabyte).
* '''gpus''' -> alokasi jumlah '''GPU'''.  


== '''Membaca squeue''' ==
Berikut adalah panduan nilai maksimal masing-masing parameter untuk beberapa skenario penggunaan.
Sesuai penjelasan diatas, user dapat melihat status dan antrian jalannya program melalui perintah squeue.
[[Berkas:Status_squeue.png|al=|nir|jmpl|900x900px|Penjelasan bagian squeue]]
Info yang esensial untuk user adalah bagian STATE dan NODELIST(REASON). STATE (ST) memberikan kondisi jalannya program user sementara itu NODELIST(REASON) memberikan detail verbose status jalannya program user.  
{| class="wikitable"
{| class="wikitable"
|+Daftar STATE yang biasa muncul
! rowspan="2" |Skenario Penggunaan
!STATE
! colspan="3" |Nilai maksimal
!Singkatan
!Penjelasan
|-
|-
|R
!ntasks (CPU)
|RUN
!mem (RAM)
|Job berjalan
!gpus (GPU)
|-
|-
|PD
|Akumulasi ''concurrent'' job fair policy usage<sup>''1''</sup>
|PENDING
|128
|Job tertahan, lihat keterangan NODELIST
|128GB
|2
|-
|-
|CG
|Job non-MPI di epyc (Compute Node CPU)''<sup>2</sup>''
|COMPLETING
|128
|Job selesai dan dalam proses clean-up SLURM
|240GB
|0
|-
|-
|CA
|Job MPI di epyc (Compute Node CPU)<sup>''3''</sup>
|CANCELED
|384
|Job dibatalkan oleh user
|240GB
|0
|-
|-
|PR
|Semua jenis job di high-mem node epyc''<sup>4</sup>''
|PREEMPETED
|128
|Job dibatalkan oleh sys-admin Aleleon, alasan akan dikabarkan melalui email
|500GB
|0
|-
|-
|S
|Semua jenis job di ampere (Compute Node GPU)''<sup>5</sup>''
|SUSPENDED
|32
|Job ditahan oleh sys-admin Aleleon
|120GB
|}
|2
Pada saat job berjalan (RUNNING) maka NODELIST akan menampilkan info nama node tempat job berjalan. Sementara itu NODELIST akan memberikan alasan verbose pada saat job tidak berjalan (STATE selain RUNNING). Berikut adalah daftar NODELIST yang bisa terjadi di HPC Aleleon Mk.II:
{| class="wikitable"
|+Daftar NODELIST di HPC Aleleon Mk.II
!NODELIST
!Penjelasan
|-
|Resources
|Job menunggu alokasi resources (CPU, RAM, GPU) yang dipesan oleh SLURM submission script user
|-
|AssocMaxWallDurationPerJobLimit
|Job tidak dapat berjalan karena melewati batas walltime maksimum partisi
|-
|-
|QOSMaxCpuPerUserLimit
| colspan="4" |''Tim admin dapat membantu user untuk membedakan program MPI dan non-MPI.''
|Job melewati batas alokasi CPU user (lihat laman QOS User untuk penjelasan lebih lanjut).
* ''Daftar [[Daftar Software Komputasi dan Tutorial Penggunaan|'''software komputasi ALELEON''']] memberikan indikator program MPI atau non-MPI.''
* ''Dapat pula menghubungi admin untuk diskusi melalui email '''support@efisonlt.com'''.''
|}
|}
User dapat melapor ke admin melalui email support@efisonlt.com apabila menjumpai NODELIST yang tidak terdapat pada daftar diatas ketika job user tidak berjalan.
'''''Keterangan:'''''
# Limitasi '''fair policy usage''' untuk menjaga kualitas layanan ALELEON Supercomputer.
#* User dapat mengajukan permintaan membuka limitasi apabila job membutuhkan alokasi lebih.
#* Info lebih detail lihat laman [[Limitasi Fair Usage ALELEON Supercomputer|'''Limitasi Fair Usage ALELEON Supercomputer''']]
# Program non-MPI hanya dapat berjalan satu node (maks 128 core di epyc dan 32 core di ampere).
# Program MPI dapat berjalan ''multi-node (parallel computing)'' pada Partisi epyc yaitu lebih dari 128 core
#* Pada jumlah ntasks >128, SLURM otomatis menjalankan job secara multi-node.
#* Dalam kaitan ini, parameter mem adalah alokasi memori RAM per-node.
#* Info lebih detail lihat laman [[MPI ALELEON Supercomputer|'''MPI ALELEON Supercomputer''']].
#Partisi epyc mempunyai satu node dengan jumlah memori 500GB yaitu epyc001.
##Tambahkan parameter '''<code>#SBATCH --nodelist=epyc001</code>'''
#Jangan lupa untuk menggunakan compute node GPU, tambahkan parameter '''<code>#SBATCH --partition=ampere</code>'''
=== #SBATCH --time ===
Alokasi waktu maksimal untuk menjalankan job. Ditulis dengan format HH:MM:SS atau D-HH:MM:SS. ALELEON Supercomputer mengizinkan time maksimal 3 hari per job (72:00:00 atau 3-00:00:00).
 
* SLURM akan menghentikan job apabila berjalan melebihi time yang dialokasikan,
* SLURM juga dapat menghitung penggunaan Core Hour maksimal job berdasarkan time dan ntasks yang dialokasikan user. SLURM akan menahan job (status PENDING) apabila ntasks * time yang dialokasikan lebih besar dari sisa Core Hour user.
 
=== #SBATCH --output ===
SBATCH output membuat file untuk merekap output terminal jalannya program. User mendefinisikan nama dan format file.
* Terdapat pola penamaan dari SLURM yaitu %j untuk merekap nomor Job ID.
* Format file dibebaskan (biasanya menggunakan .txt atau .out).
Kebanyakan template submit script pada wiki ini memberikan contoh penamaan <code>#SBATCH --output=result-%j.txt</code> dimana ketika job berjalan (contoh) dengan job-ID 670, maka nama file output menjadi '''result-670.txt'''.
 
=== #SBATCH --error ===
SBATCH error membuat file untuk merekap output verbose program (status jalannya program dan error log ketika program gagal berjalan). File SBATCH error bermanfaat untuk melakukan ''troubleshooting'' ketika program gagal berjalan. Apabila membutuhkan support, admin biasanya akan meminta file output dari SBATCH error ini. Pola penamaan mengikuti SBATCH output di atas.
 
=== '''SBATCH untuk notifikasi email SLURM''' ===
SLURM ALELEON Supercomputer dapat mengirim notifikasi email kepada user dengan nama "Jojo" untuk mengabarkan status berjalannya job komputasi user. Silahkan tambahan SBATCH berikut pada submit script apabila user ingin menerima notifikasi email dari SLURM:  <syntaxhighlight lang="bash">
#SBATCH --mail-user=<alamat-email-user>
#SBATCH --mail-type=BEGIN,END,FAIL
</syntaxhighlight>SBATCH mail-type mengatur konten email notifikasi SLURM dengan pilihan opsi yang sekiranya berguna untuk user:
 
* BEGIN -> notifikasi job sudah mulai
* END -> notifikasi job sudah selesai beserta cuplikan 20 baris terakhir dari file SBATCH output dan error.
* FAIL -> notifikasi apabila job gagal berjalan atau berhenti tidak sewajarnya.
* TIME_LIMIT_50 -> job telah berjalan dengan durasi waktu 50% time limit.
* TIME_LIMIT_80 -> job telah berjalan dengan durasi waktu 80% time limit.
 
=== SBATCH lainnya untuk job MPI ===
Dalam menjalankan job MPI, user dapat menggunakan parameter SBATCH yang lebih kompleks seperti <code>nodes</code> (alokasi jumlah node), <code>mem-per-cpu</code> (alokasi jumlah RAM per core CPU), <code>mem-per-gpu</code> (alokasi jumlah RAM per GPU). <code>cpus-per-task</code> (alokasi jumlah core per proses MPI untuk skenario hybrid MPI / OMP job), dan lain-lainnya. Info lebih detail lihat laman [[MPI ALELEON Supercomputer|'''MPI ALELEON Supercomputer''']]
 
== '''Memuat Software dengan module load''' ==
Perintah <code>module load</code> (bagian dari [[Module Environment|'''Module Environment''']] untuk memuat modul software) pada Submit Script berfungsi supaya Compute Node dapat menjalankan software yang dibutuhkan job user. <syntaxhighlight lang="bash">
module load <nama-modul-software>
</syntaxhighlight>'''''Keterangan:'''''
 
* Tulis <code>module load</code> sebelum menulis script alur jalannya program.
 
* Template Submit Script pada masing-masing tutorial software komputasi di laman [[Daftar Software Komputasi dan Tutorial Penggunaan|'''Daftar Software Komputasi dan Tutorial Penggunaan''']] dapat memandu memilih modul software yang tepat.
* Daftar modul software yang lengkap dirangkum pada laman [[Katalog Software ALELEON Supercomputer|'''Katalog Software ALELEON Supercomputer''']].

Revisi terkini sejak 19 Oktober 2023 09.31

Halaman ini menjelaskan panduan memahami, membuat, dan mengisi SLURM Submit Script (atau disingkat Submit Script) yang merupakan 'formulir' untuk menjalankan komputasi ke Compute Node menggunakan sistem manajemen SLURM.

Struktur Submit Script

Submit Script mempunyai 4 bagian utama:

  1. Header #!/bin/bash (karena script ini ditulis dengan bahasa bash)
  2. Parameter SBATCH untuk mengalokasikan resources job seperti CPU, RAM, GPU, time, dll.
    • Pada penggunaan superkomputer, user menentukan sendiri jumlah alokasi komputasi (CPU, RAM, GPU, time limit) yang akan dipakai untuk menjalankan komputasi asalkan tidak melebihi kapasitas Compute Node ALELEON Supercomputer.
  3. Apabila membutuhkan, memuat modul software tertentu untuk menjalankan komputasi user dengan Module Environment
  4. Alur perintah menjalankan program user.
Struktur dan contoh SLURM Submit Script

Berikut adalah beberapa contoh nyata Submit Script:

Contoh Submit Script menjalankan software R
#!/bin/bash

# -------------------------------------------------------------
# | Template SLURM Submit Script
# | Software        : R
# | Versi           : 4.3.0
# |
# | NOTES: 
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini bersifat referensi.
# |    User dapat mengubah bagian yang sekiranya perlu diubah.
# -------------------------------------------------------------

# --------------------------------------------------
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------

# Alokasi jumlah core thread CPU
#SBATCH --ntasks=32

# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=128GB

# Alokasi limit waktu menjalankan job. 
# Format HH:MM:SS atau D-HH:MM:SS
#SBATCH --time=2-00:00:00

# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt

# Definisi file untuk menampung output error log    
#SBATCH --error=error-%j.txt 

# Nama input file R dengan format file-nya
INPUT_FILE='dataumat.R'

# Memuat modul software R yang akan digunakan user
module load R/4.3.0-GCC11.3-MKL

# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------

# Perintah menjakankan R
Rscript ${INPUT_FILE}
Contoh Submit Script menjalankan software LAMMPS
#!/bin/bash
  
# ------------------------------------------------------------------------
# | Template SLURM Submit Script
# | Software        : LAMMPS
# | Versi           : 2022.06.23u4
# |
# | NOTES: 
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini adalah referensi - user dapat mengubah bagian yang 
# |    sekiranya perlu diubah.
# ------------------------------------------------------------------------

# --------------------------------------------------
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------

# Partisi compute node GPU
#SBATCH --partition=ampere

# Alokasi jumlah GPU 
#SBATCH --gpus=1

# Alokasi jumlah core thread CPU
#SBATCH --ntasks=16

# Rekomendasi 2 thread OMP secara umum
#SBATCH --cpus-per-task=2

# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=64GB

# Alokasi limit waktu menjalankan job 
#SBATCH --time=10:00:00

# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt

# Definisi file untuk menampung output error log    
#SBATCH --error=error-%j.txt  

# Nama input file LAMMPS dengan format file-nya
INPUT_FILE='zobarne.lammps' 

# Memuat modul software LAMMPS versi GPU
module load lammps/2022.06.23u4-GCC11.3-AOCL4.0-CUDA12.1

# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------

# Export threading OMP 
export OMP_NUM_THREADS=$SLURM_CPUS_PER_TASK 

# Perintah menjalankan LAMMPS
mpirun --mca pml ucx --mca osc ucx --np $SLURM_NTASKS lmp -sf gpu -pk gpu $SLURM_GPUS -in $INPUT_FILE

Parameter SBATCH esensial

Parameter SBATCH berfungsi untuk mengatur alokasi komputasi (CPU, RAM, GPU, time limit) dan output program. SLURM mempunyai ratusan opsi untuk parameter SBATCH dimana pada tutorial ini kami memberikan daftar SBATCH yang esensial untuk menjalankan komputasi di ALELEON Supercomputer.

Format Penulisan SBATCH

SBATCH ditulis dengan format #SBATCH --<nama-parameter>=<nilai> sesuai contoh berikut:

# --- Contoh penulisan SBATCH yang benar
#SBATCH --ntasks=32
#SBATCH --mem=64GB
#SBATCH --time=01:00:00
#SBATCH --output=result-%j.txt
#SBATCH --error=error-%j.txt

# --- Contoh penulisan SBATCH yang salah
#SBATCH --ntasks = 32
#SBATCH --mem= 64GB 
#SBATCH --mem = 64 GB

#SBATCH --partition

Menentukan jenis partisi (Compute Node) untuk menjalankan job komputasi user. ALELEON Supercomputer mempunyai 2 partisi Compute Node:

Partisi Compute Node Menulis SBATCH
epyc (Compute Node CPU) Merupakan partisi default
  • user tidak perlu menulis SBATCH parameter untuk epyc
ampere (Compute Node GPU) #SBATCH --partition=ampere

#SBATCH --ntasks, --mem, dan --gpus

ntasks, mem, dan gpus adalah parameter SBATCH utama untuk menentukan alokasi komputasi.

  • ntasks -> alokasi jumlah core CPU. ALELEON Supercomputer mengaktifkan SMT (Simultaneous Multithreading) pada semua CPU sehingga ntasks mendefinisikan jumlah core thread CPU.
  • mem -> alokasi jumlah memori RAM. Ditulis dengan satuan memori GB (Gigabyte).
  • gpus -> alokasi jumlah GPU.

Berikut adalah panduan nilai maksimal masing-masing parameter untuk beberapa skenario penggunaan.

Skenario Penggunaan Nilai maksimal
ntasks (CPU) mem (RAM) gpus (GPU)
Akumulasi concurrent job fair policy usage1 128 128GB 2
Job non-MPI di epyc (Compute Node CPU)2 128 240GB 0
Job MPI di epyc (Compute Node CPU)3 384 240GB 0
Semua jenis job di high-mem node epyc4 128 500GB 0
Semua jenis job di ampere (Compute Node GPU)5 32 120GB 2
Tim admin dapat membantu user untuk membedakan program MPI dan non-MPI.
  • Daftar software komputasi ALELEON memberikan indikator program MPI atau non-MPI.
  • Dapat pula menghubungi admin untuk diskusi melalui email support@efisonlt.com.

Keterangan:

  1. Limitasi fair policy usage untuk menjaga kualitas layanan ALELEON Supercomputer.
  2. Program non-MPI hanya dapat berjalan satu node (maks 128 core di epyc dan 32 core di ampere).
  3. Program MPI dapat berjalan multi-node (parallel computing) pada Partisi epyc yaitu lebih dari 128 core
    • Pada jumlah ntasks >128, SLURM otomatis menjalankan job secara multi-node.
    • Dalam kaitan ini, parameter mem adalah alokasi memori RAM per-node.
    • Info lebih detail lihat laman MPI ALELEON Supercomputer.
  4. Partisi epyc mempunyai satu node dengan jumlah memori 500GB yaitu epyc001.
    1. Tambahkan parameter #SBATCH --nodelist=epyc001
  5. Jangan lupa untuk menggunakan compute node GPU, tambahkan parameter #SBATCH --partition=ampere

#SBATCH --time

Alokasi waktu maksimal untuk menjalankan job. Ditulis dengan format HH:MM:SS atau D-HH:MM:SS. ALELEON Supercomputer mengizinkan time maksimal 3 hari per job (72:00:00 atau 3-00:00:00).

  • SLURM akan menghentikan job apabila berjalan melebihi time yang dialokasikan,
  • SLURM juga dapat menghitung penggunaan Core Hour maksimal job berdasarkan time dan ntasks yang dialokasikan user. SLURM akan menahan job (status PENDING) apabila ntasks * time yang dialokasikan lebih besar dari sisa Core Hour user.

#SBATCH --output

SBATCH output membuat file untuk merekap output terminal jalannya program. User mendefinisikan nama dan format file.

  • Terdapat pola penamaan dari SLURM yaitu %j untuk merekap nomor Job ID.
  • Format file dibebaskan (biasanya menggunakan .txt atau .out).

Kebanyakan template submit script pada wiki ini memberikan contoh penamaan #SBATCH --output=result-%j.txt dimana ketika job berjalan (contoh) dengan job-ID 670, maka nama file output menjadi result-670.txt.

#SBATCH --error

SBATCH error membuat file untuk merekap output verbose program (status jalannya program dan error log ketika program gagal berjalan). File SBATCH error bermanfaat untuk melakukan troubleshooting ketika program gagal berjalan. Apabila membutuhkan support, admin biasanya akan meminta file output dari SBATCH error ini. Pola penamaan mengikuti SBATCH output di atas.

SBATCH untuk notifikasi email SLURM

SLURM ALELEON Supercomputer dapat mengirim notifikasi email kepada user dengan nama "Jojo" untuk mengabarkan status berjalannya job komputasi user. Silahkan tambahan SBATCH berikut pada submit script apabila user ingin menerima notifikasi email dari SLURM:

#SBATCH --mail-user=<alamat-email-user> 
#SBATCH --mail-type=BEGIN,END,FAIL

SBATCH mail-type mengatur konten email notifikasi SLURM dengan pilihan opsi yang sekiranya berguna untuk user:

  • BEGIN -> notifikasi job sudah mulai
  • END -> notifikasi job sudah selesai beserta cuplikan 20 baris terakhir dari file SBATCH output dan error.
  • FAIL -> notifikasi apabila job gagal berjalan atau berhenti tidak sewajarnya.
  • TIME_LIMIT_50 -> job telah berjalan dengan durasi waktu 50% time limit.
  • TIME_LIMIT_80 -> job telah berjalan dengan durasi waktu 80% time limit.

SBATCH lainnya untuk job MPI

Dalam menjalankan job MPI, user dapat menggunakan parameter SBATCH yang lebih kompleks seperti nodes (alokasi jumlah node), mem-per-cpu (alokasi jumlah RAM per core CPU), mem-per-gpu (alokasi jumlah RAM per GPU). cpus-per-task (alokasi jumlah core per proses MPI untuk skenario hybrid MPI / OMP job), dan lain-lainnya. Info lebih detail lihat laman MPI ALELEON Supercomputer

Memuat Software dengan module load

Perintah module load (bagian dari Module Environment untuk memuat modul software) pada Submit Script berfungsi supaya Compute Node dapat menjalankan software yang dibutuhkan job user.

module load <nama-modul-software>

Keterangan:

  • Tulis module load sebelum menulis script alur jalannya program.