Submit Script ALELEON Supercomputer: Perbedaan antara revisi

Dari ALELEON by EFISON
(menambahkan struktur SLURM Script)
(→‎Struktur Submit Script: menambah contoh script)
 
(37 revisi perantara oleh pengguna yang sama tidak ditampilkan)
Baris 1: Baris 1:
Halaman ini menjelaskan panduan memahami dan mengisi parameter resources pada SLURM Script beserta contohnya berdasarkan hardware ALELEON Supercomputer.   
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 SLURM Script''' ==
=='''Struktur Submit Script'''==
Secara umum, Submit Script atau SLURM Script dipecah menjadi 4 bagian penting.
Submit Script mempunyai 4 bagian utama:
[[Berkas:Jcscriptrev.png|nir|jmpl|624x624px|'''Contoh template EFIRO Job Composer untuk menjalankan program ORCA''']]
Penjelasan dan langkah user membuat SLURM Script:


# Menulis header '''#!/bin/bash''' karena SLURM Script adalah bash script.
#Header '''#!/bin/bash''' (karena script ini ditulis dengan bahasa bash)
# '''Membuat dan menentukan parameter SBATCH''' untuk mengalokasikan resources job seperti CPU, RAM, GPU, time, dll.
#'''Parameter SBATCH''' untuk mengalokasikan resources job seperti CPU, RAM, GPU, time, dll.
# [[Module Environment|'''Memuat software yang dibutuhkan untuk menjalankan job user dengan Module Environment.''']] Apabila user tidak memuat modul software yang benar maka job tidak akan berjalan.
#*''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.''
# Menulis perintah untuk menjalankan program user.
# 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]'''
# Alur perintah menjalankan program user.


|
[[Berkas:Slurmsubmitscript.png|al=|nir|jmpl|''Struktur dan contoh SLURM Submit Script'']]Berikut adalah beberapa contoh nyata Submit Script:


=== '''Lauk apa yang akan dipesan?''' ===
* Template Submit Script untuk masing-masing software komputasi tersedia di laman [[Daftar Software Komputasi dan Tutorial Penggunaan|'''Daftar Software Komputasi dan Tutorial Penggunaan''']]
Dalam menggunakan superkomputer, '''user menentukan sendiri alokasi resources komputasi untuk menjalankan job''' seperti '''jumlah core CPU, RAM, GPU, walltime, file output, notifikasi email, threading CPU, dll'''. Analogikan seperti kita hendak pesan bungkus di warung makan nasi padang di mana kita menentukan sendiri berapa porsi yang mau dibungkus, jenis lauk, dan jumlahnya. 
=='''Resources ALELEON Supercomputer di SLURM'''==
Sebelum menentukan alokasi resource job, user harus mengetahui spesifikasi hardware dari ALELEON Supercomputer:


* '''Partisi epyc''' atau pengelompokan '''Compute Node CPU.'''
{| class="wikitable mw-collapsible mw-collapsed"
** '''3 Node''' (unit server), '''total 192 core fisik / 384 core thread CPU'''
!Contoh Submit Script menjalankan software R
** Masing-masing node berisikan:
|-
*** 64 core fisik / 128 core thread CPU
|<syntaxhighlight lang="bash" line="1">
*** RAM 240GB.
#!/bin/bash
** Secara default, komputasi pada ALELEON Supercomputer diarahkan ke Partisi epyc.
* '''Partisi gpu_ampere''' atau pengelompokan '''Compute Node GPU'''
** '''1 Node''', '''total 2 GPU'''
*** CPU 64 core fisik / 128 core thread CPU
*** RAM 125GB.


Info lebih detail dapat dipelajari pada laman '''[[Spesifikasi ALELEON Supercomputer]]'''.
# -------------------------------------------------------------
# | 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.
# -------------------------------------------------------------


== '''Core Thread CPU pada ALELEON Supercomputer''' ==
# --------------------------------------------------
EFISON menggunakan CPU [https://www.amd.com/en/products/cpu/amd-epyc-7702p '''AMD EPYC 7702P'''] pada Partisi epyc dan [https://www.amd.com/en/products/cpu/amd-ryzen-threadripper-3990x '''AMD Threadripper 3990X'''] pada Partisi gpu_ampere'''.''' EFISON mengaktifkan '''SMT (Simultaneous Multi-Threading)''' pada semua CPU AMD di ALELEON Supercomputer sehingga masing-masing CPU mempunyai '''2 core thread per 1 core fisik'''. 
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------


Secara default, '''penggunaan CPU pada ALELEON Supercomputer didasarkan pada core thread, termasuk [[Core Hour|penghitungan penggunaan komputasi CPU Core Hour user]]'''.
# Alokasi jumlah core thread CPU
#SBATCH --ntasks=32


=='''Parameter Resources SBATCH Esensial'''==
# Alokasi jumlah memori RAM (satuan GB)
Terdapat ratusan jenis [https://slurm.schedmd.com/sbatch.html parameter SBATCH pada SLURM] dari yang standar hingga ''advanced''. Admin EFISON merangkum parameter esensial yang digunakan pada ALELEON Supercomputer.
#SBATCH --mem=128GB


=== Menggunakan Compute Node CPU / Partisi epyc ===
# Alokasi limit waktu menjalankan job.
Berikut adalah parameter SBATCH yang direkomendasikan dan secara umum dapat digunakan untuk semua jenis job:
# Format HH:MM:SS atau D-HH:MM:SS
# user mengisi parameter dengan mengganti bagian yang ditandai dengan ////
#SBATCH --time=2-00:00:00
#SBATCH --nodes=////
#SBATCH --ntasks=////
#SBATCH --mem=////
#SBATCH --time=////
#SBATCH --output=////
#SBATCH --error=////


* '''nodes'''
# Definisi file untuk menampung output terminal
** Alokasi jumlah '''node''' yang digunakan.
#SBATCH --output=result-%j.txt
** Contoh mengalokasikan 1 node: '''#SBATCH --nodes=1'''
* '''ntasks'''
** Alokasi jumlah '''core thread CPU''' yang digunakan.
** Contoh mengalokasikan 32 core thread CPU: '''#SBATCH --ntasks=32'''
* '''mem'''
** Alokasi '''kapasitas RAM''' '''per node''' yang digunakan, diikuti dengan satuan KB, MB, atau GB.
** Contoh mengalokasikan RAM 32GB: '''#SBATCH --mem=32GB'''
* '''time'''
** Alokasi '''walltime (waktu maksimal)''' yang diizinkan untuk menjalankan job, mengikuti format penulisan:
*** HH:MM:SS. Contoh alokasi 2 jam: '''#SBATCH --time=02:00:00'''
*** D-HH:MM:SS. Contoh alokasi 2 hari: '''#SBATCH --time=2-00:00:00'''
* '''output'''
** Merekap '''output program yang keluar di terminal'''. User memberikan sendiri nama file (satu kata tanpa spasi) diikuti dengan format file seperti .txt atau .out yang sering digunakan.
** Terdapat penamaan pattern dari SLURM yaitu '''%j''' yang merekap job-ID.
** Contoh penamaan output yang sering digunakan: '''#SBATCH --output=result-%j.txt'''
** Apabila job berjalan dengan no. ID 2555, maka nama output menjadi '''result-2555.txt'''
* '''error'''
** Merekap '''output verbose program''' yaitu status jalannya program seperti "job sudah berjalan!" dan error log ketika program gagal selesai.
** Output error sangat bermanfaat bagi user untuk melakukan troubleshooting disaat program gagal berjalan. Admin EFISON selalu merekomendasikan user untuk selalu menggunakan parameter error ini.
** Format penamaan mengikuti parameter output diatas, contoh: '''#SBATCH --error=error-%j.txt'''
|


=== Menggunakan Compute Node GPU / Partisi gpu_ampere ===
# Definisi file untuk menampung output error log   
Secara umum mengikuti format SBATCH yang sama dengan menggunakan Partisi epyc, diikuti dengan tambahan:
#SBATCH --error=error-%j.txt
# user mengisi parameter dengan mengganti bagian yang ditandai dengan ////
'''#SBATCH --partition=gpu_ampere'''
'''#SBATCH --gres=gpu:////'''
#SBATCH --ntasks=////
#SBATCH --mem=////
#SBATCH --time=////
#SBATCH --output=////
#SBATCH --error=////


* '''partition=gpu_ampere'''
# Nama input file R dengan format file-nya
** Mengalokasikan job ke Compute Node GPU gpu_ampere
INPUT_FILE='dataumat.R'
* '''gres=gpu:<jumlah-GPU>'''
** Alokasi '''Jumlah GPU''' yang digunakan.
** Contoh mengalokasikan 1 GPU: '''#SBATCH --gres=gpu:1'''
** Contoh mengalokasikan 2 GPU: '''#SBATCH --gres=gpu:2'''


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


=== Notifikasi Status Jalannya Job via E-mail ===
# -------------------------------------------------
SLURM pada ALELEON Supercomputer dapat mengirim notifikasi email kepada user untuk mengabarkan apabila job user sudah berjalan atau selesai. SLURM ALELEON Supercomputer menggunakan nama email '''Jojo''' untuk mengirim notifikasi email. User dapat menambahkan parameter berikut untuk menerima notifikasi email dari SLURM:
# RUN SCRIPT
#SBATCH --mail-user=////
# -------------------------------------------------
#SBATCH --mail-type=begin
#SBATCH --mail-type=end


* '''mail-user'''
# Perintah menjakankan R
** Alamat email user untuk menerima notifikasi SLURM
Rscript ${INPUT_FILE}
* '''mail-type=begin'''
</syntaxhighlight>
** Notifikasi email yang menginfokan job sudah mulai.
|}
* '''mail-type=end'''
{| class="wikitable mw-collapsible mw-collapsed"
** Notifikasi email yang menginfokan job sudah selesai.
!Contoh Submit Script menjalankan software LAMMPS
** Sekaligus memberikan cuplikan 20 baris terakhir dari SBATCH output dan error job user.
|-
|<syntaxhighlight lang="bash" line="1">
#!/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
# --------------------------------------------------


==='''Menggunakan Paralelisasi Threading OpenMP atau BLAS'''===
# Partisi compute node GPU
Berikut adalah parameter tambahan untuk mengalokasikan threading per core para programyang menggunakan paralelisasi OpenMP (OMP), hybrid MPI/OMP, atau terintegrasi dengan BLAS:
#SBATCH --partition=ampere
#SBATCH --cpus-per-task=////
# diikuti dengan pengalokasikan threads contoh dengan OMP:
export OMP_NUM_THREADS='''$SLURM_CPUS_PER_TASK'''


* cpus-per-task
# Alokasi jumlah GPU
** Alokasi jumlah threading per ntasks.
#SBATCH --gpus=1
** User mendefinisikan jumlah threading (contoh ke OMP_NUM_THREADS) dengan variabel '''$SLURM_CPUS_PER_TASK.'''
** Contoh mengalokasikan 4 thread per core: '''$SBATCH --cpus-per-task=4'''


=='''Bagaimana Menentukan Alokasi Jumlah nodes, ntasks, dan mem'''==
# Alokasi jumlah core thread CPU
Seni dalam menggunakan superkomputer adalah kebebasan user dalam menentukan jumlah core prosesor, RAM, dan node yang akan digunakan. Apakah program user cukup menggunakan 8 core atau sekalian 64 core? Apakah program user hanya dapat berjalan pada 1 node atau bisa lebih? Apakah RAM 16GB sudah cukup atau butuh lebih?  Hal ini ditambah dengan '''ALELEON Supercomputer dan arsitektur AMD EPYC''' '''mempunyai beberapa aturan khusus supaya user dapat memanfaatkan kemampuan komputasinya dengan optimal'''. 
#SBATCH --ntasks=16


Admin EFISON merangkum ''rules of thumb'' bagi user untuk mengalokasikan jumlah resources komputasi dan melakukan optimasi performa pada ALELEON Supercomputer di:
# Rekomendasi 2 thread OMP secara umum
#SBATCH --cpus-per-task=2


[[Berkas:Wiki-13.jpg|1000x1000px]]
# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=64GB


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


=== Jumlah Core CPU: Kelipatan 4 ===
# Definisi file untuk menampung output terminal
Berdasarkan arsiktektur CPU AMD yang digunakan oleh ALELEON Supercomputer, user direkomendasikan untuk memilih jumlah core CPU (ntasks) berdasarkan kelipatan 4, dimulai dari 1,2,4, kemudian naik kelipatan 4 menjadi 8, 12, 16, 20, 24, 28, 32, 36, 40, dan seterusnya.
#SBATCH --output=result-%j.txt


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


=== Semakin Besar Jumlah Core CPU = Komputasi Semakin Cepat? ===
# Nama input file LAMMPS dengan format file-nya
Bisa iya bisa tidak. Besar jumlah core CPU yang dibutuhkan bergantung pada:
INPUT_FILE='zobarne.lammps'


* '''Apabila menjalankan program CPU:''' bergantung pada besarnya skala input komputasi user. Admin ALELEON Supercomputer sepenuhnya menyerahkan tanggung jawab kepada user untuk mengetahui sendiri apakah input komputasi yang dijalankan adalah skala kecil atau besar.  
# Memuat modul software LAMMPS versi GPU
** Input komputasi skala kecil cukup membutuhkan jumlah core kecil (rekomendasi dibawah 16) dan bisa jadi lambat apabila dijalankan dengan jumlah core besar.  
module load lammps/2022.06.23u4-GCC11.3-AOCL4.0-CUDA12.1
** Apabila user yakin bahwa input yang dijalankan adalah skala besar maka gunakan jumlah core CPU yang besar seperti 32, 64, 128, atau diatasnya.
* '''Apabila menjalankan program GPU:''' kebanyakan membutuhkan jumlah core kecil (dibawah 16) karena pada dasarnya semua komputasi dikerjakan oleh GPU. Cukup jarang ada program GPU yang membutuhkan jumlah core CPU besar.


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


=== Memperkirakan Kapasitas RAM yang Digunakan ===
# Export threading OMP
Apakah program user membutuhkan banyak RAM atau tidak? Tidak ada aturan baku untuk mengetahui hal ini karena bergantung dengan jenis software dan besarnya skala input yang dijalankan user. Admin EFISON dapat memberikan saran '''untuk menggunakan jumlah RAM 1GB per ntasks sebagai basis'''. Contoh:
export OMP_NUM_THREADS=$SLURM_CPUS_PER_TASK


* ntasks=8, alokasikan mem 8GB.
# Perintah menjalankan LAMMPS
* ntasks=32, alokasikan mem 32GB.
mpirun --mca pml ucx --mca osc ucx --np $SLURM_NTASKS lmp -sf gpu -pk gpu $SLURM_GPUS -in $INPUT_FILE
</syntaxhighlight>
|}


User dapat menggunakan kapasitas RAM yang lebih besar (contoh 2GB atau 4GB per ntasks) apabila user mengetahui bahwa program yang dijalankan membutuhkan kapasitas RAM besar atau program gagal berjalan dengan alokasi RAM 1GB per ntasks.  
== '''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 <code>'''#SBATCH --<nama-parameter>=<nilai>'''</code> sesuai contoh berikut:  <syntaxhighlight lang="bash">
# --- 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


=== Menentukan Jumlah Node: Program MPI versus Non-MPI ===
# --- Contoh penulisan SBATCH yang salah
Terdapat dua kategori besar pada program komputasi yang dijalankan pada superkomputer yaitu program MPI dan non-MPI:
#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"
!Partisi Compute Node
!Menulis SBATCH
|-
|'''epyc''' (Compute Node CPU)
|Merupakan partisi default


* Program MPI adalah program yang ditulis berdasarkan pemrograman MPI (Message Parallel Interface) di mana '''dapat berjalan secara paralel atau lebih dari satu node (multi-node)'''. Berjalan multi-node artinya dapat memanfaatkan lebih dari 128 core thread CPU pada ALELEON Supercomputer.
* user tidak perlu menulis SBATCH parameter untuk epyc
* Program non-MPI adalah program yang tidak ditulis dengan pemodelan MPI sehingga '''hanya dapat berjalan pada 1 node.'''
|-
|'''ampere''' (Compute Node GPU)
|<code>#SBATCH --partition=ampere</code>
|}


|
=== #SBATCH --ntasks, --mem, dan --gpus ===
ntasks, mem, dan gpus adalah parameter SBATCH utama untuk menentukan alokasi komputasi.


=== Program Non-MPI: Hanya Dapat Menggunakan 1 Node ===
* '''ntasks''' -> alokasi jumlah '''core CPU.''' ALELEON Supercomputer mengaktifkan ''SMT (Simultaneous Multithreading)'' pada semua CPU sehingga ntasks mendefinisikan jumlah core thread CPU.
Program non-MPI hanya dapat berjalan pada 1 node sehingga menggunakan alokasi ntasks antara '''1 hingga 128 core thread CPU'''.
* '''mem''' -> alokasi jumlah '''memori RAM'''. Ditulis dengan satuan memori GB (Gigabyte).
'''#SBATCH --nodes=1'''
* '''gpus''' -> alokasi jumlah '''GPU'''.
#SBATCH --ntasks=  #antara 1 - 128
'''User perlu mengetahui:'''  


* Program komputasi non-MPI dapat berjalan secara multi-core (lebih dari 1 core) atau hanya bisa berjalan dengan 1 core (ntasks=1) tergantung oleh jenis software dan pemrogramannya.
Berikut adalah panduan nilai maksimal masing-masing parameter untuk beberapa skenario penggunaan.
* Program komputasi non-MPI yang hanya berjalan 1 core sering terjadi pada program yang ditulis sendiri oleh user atau framework komputasi yang ditulis dengan standar pemrograman serial.  
{| class="wikitable"
* Bagi user yang tidak ingin programnya berjalan di ALELEON Supercomputer hanya dengan 1 core, Admin EFISON menyarankan untuk menguji terlebih dahulu dengan menjalankannya pada perangkat komputer pribadi dan lihat status penggunaan CPU-nya.
! rowspan="2" |Skenario Penggunaan
** User dapat mengganti coding apabila terjadi pada program yang ditulis sendiri.
! colspan="3" |Nilai maksimal
** Apabila menggunakan software komputasi maka user harus mencari alternatif software pengganti.
|-
!ntasks (CPU)
!mem (RAM)
!gpus (GPU)
|-
|Akumulasi ''concurrent'' job fair policy usage<sup>''1''</sup>
|128
|128GB
|2
|-
|Job non-MPI di epyc (Compute Node CPU)''<sup>2</sup>''
|128
|240GB
|0
|-
|Job MPI di epyc (Compute Node CPU)<sup>''3''</sup>
|384
|240GB
|0
|-
|Semua jenis job di high-mem node epyc''<sup>4</sup>''
|128
|500GB
|0
|-
|Semua jenis job di ampere (Compute Node GPU)''<sup>5</sup>''
|32
|120GB
|2
|-
| colspan="4" |''Tim admin dapat membantu user untuk membedakan program MPI dan non-MPI.''
* ''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'''.''
|}
'''''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).  


Untuk program komputasi non-MPI yang memanfaatkan paralelisasi threading OpenMP dan membutuhkan parameter OMP_NUM_THREAD, gunakan kombinasi parameter berikut:
* SLURM akan menghentikan job apabila berjalan melebihi time yang dialokasikan,
'''#SBATCH --nodes=1
* 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 --ntasks=1'''
#SBATCH --cpus-per-task=  #antara 1 - 128
export OMP_NUM_THREADS='''$SLURM_CPUS_PER_TASK'''
|


=== Program MPI: Menggunakan 1 Node atau Lebih ===
=== #SBATCH --output ===
Ketika menjalankan program MPI di ALELEON Supercomputer, user dapat mengalokasikan resources:
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'''.


* Tetap menggunakan 1 node / 128 core.
=== #SBATCH --error ===
* Menggunakan lebih dari 1 node / lebih dari 128 core.
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.


Apabila user menjalankan program komputasi yang tersedia di ALELEON Supercomputer, user dapat mengetahui bahwa program tersebut adalah MPI atau tidak dengan memperhatikan kolom "Dukungan MPI" di [https://wiki.efisonlt.com/wiki/Katalog_Software_ALELEON_Supercomputer#Daftar_Software_Komputasi_.28Global.29 '''tabel daftar software komputasi ALELEON Supercomputer'''].
=== '''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.


=== Pembagian Proses MPI Pada Core CPU ALELEON Supercomputer ===
=== SBATCH lainnya untuk job MPI ===
Terdapat tiga aturan pada perintah MPI (mpirun atau mpiexec) yang diberlakukan pada ALELEON Supercomputer yaitu:
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''']]


* Satu proses MPI mewakili satu core thread CPU atau satu ntasks. Artinya, '''jumlah proses MPI sama dengan jumlah ntasks.'''
== '''Memuat Software dengan module load''' ==
* Berlaku aturan kelipatan 4 pada jumlah ntasks.
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">
* Secara standar, total proses MPI akan selalu '''mengisi 2 core thread per core fisik'''. Artinya:
module load <nama-modul-software>
** Contoh '''32 proses MPI''' berjalan pada '''16 core fisik / 32 core thread.'''
</syntaxhighlight>'''''Keterangan:'''''  
** Contoh lain '''128 proses MPI''' berjalan pada '''64 core fisik / 128 core thread.'''  


|
* Tulis <code>module load</code> sebelum menulis script alur jalannya program.


=== Efisiensi Menjalankan Program MPI dan Penggunaan Multi-Node di ALELEON Supercomputer ===
* 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.
Terdapat hal teknis yang harus diketahui user untuk menjalankan program MPI dengan efisiensi performa yang baik pada sistem superkomputer apapun termasuk ALELEON Supercomputer seperti:
* Daftar modul software yang lengkap dirangkum pada laman [[Katalog Software ALELEON Supercomputer|'''Katalog Software ALELEON Supercomputer''']].
 
* Efisiensi core thread versus core fisik pada program MPI.
* Affinity mpirun (binding by core / thread / socket / dll).
* Bagaimana cara menjalankan MPI pada multi-node dengan efisien.
 
== '''Contoh SLURM Script''' ==
EFISON merangkum contoh SLURM script untuk penggunaan berbagai skenario komputasi pada laman '''[[Contoh SLURM Script]]'''.
 
=='''Contoh SLURM Script Software Spesifik'''==
EFISON juga merangkum contoh SLURM script untuk software komputasi saintifik pada laman '''[https://wiki.efisonlt.com/wiki/Software_di_HPC_Aleleon_Mk.II#Daftar_Software_Komputasi Software di HPC Aleleon Mk.II]'''.

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.