-
Notifications
You must be signed in to change notification settings - Fork 1
/
subvaspT3000
685 lines (568 loc) · 16 KB
/
subvaspT3000
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
#!/bin/bash
# subvasp - VASP submit script
# The script was originally written by Reuti from Philipps Universitat Marburg ([email protected]) and then updated accordingly.
PGM_NAME="subvasp"
PGM_VERSION="1.6"
if [ -L "$0" ]; then
SCRIPT_ROOT=$(dirname $(readlink -f "$0"))
else
SCRIPT_ROOT=$(dirname "$0")
fi
OUTPUT_OPERATION=">"
#
# Setup the default values for the user options.
#
time_p="24"
memory_default="1024"
cpunr="16"
pernode=16
resources='ib16_64g' # To check abailable ques: qstat -q
version_default=${VASP_VERSION:-5.4.4+}
calculation_directory="."
cpfile='(INCAR,POTCAR,KPOINTS,POSCAR)'
cleantime=60 #in sec
#
# Routine for the display of the usage description of the
# command.
#
function usage
{
cat <<-EOF
$PGM_NAME $PGM_VERSION
Usage: $PGM_NAME [-ahlkyYz] [-j JOB-ID] [-m SIZE] [-N NAME] [-q RESOURCE-REQUEST-LIST]
[-p CPUS] [-f PPN] [-t TIME] [-T TIME(in sec)] [-v VERSION] [-w DIRECTORY_PATH] --help
See \`man /home/bmondal/script/${PGM_NAME}man' for more information.
EOF
exit 2
}
function display_defaults
{
cat <<-EOF
Defaults: -m $memory_default
-t $time_p (parallel)
-T $cleantime (in sec)
-v $version_default
-q $resources
-p $cpunr
-f $pernode
-l $cpfile
EOF
}
#
# If there is an unrecoverable error: display a message and exit.
#
function printExit
{
case $1 in
[iI]) echo INFO: "$2" ;;
[wW]) echo WARNING: "$2" ;;
[eE]) echo ERROR: "$2" ; exit 1 ;;
*) echo "$1" ;;
esac
}
#
# Test, whether we can access the given file for input.
#
function testFile
{
if [ ! -r "$1" -o ! -f "$1" ] ; then
if [ "$2" = "return" ] ; then
returncode="-1"
else
printExit E "Inputfile \"$1\" was not found."
fi
else
returncode="0"
fi
return "$returncode"
}
#
# Test, whether we can access the given file for input.
#
function testDirectory
{
if [ ! -r "$1" -o ! -d "$1" ] ; then
if [ "$2" = "return" ] ; then
returncode="-1"
else
printExit E "Inputdirectory \"$1\" was not found."
fi
else
returncode="0"
fi
return "$returncode"
}
#
# Special options which will quit the script.
#
function display_only()
{
OPTIND=1
while getopts :af:Hj:km:lN:q:p:t:T:v:w:yYz options ; do
case $options in
a) CMDOPT_A="1" ;;
z) CMDOPT_Z="1" ;;
\?) ;;
esac
done
}
#
# Process options from the command line or the rc files.
#
function settings()
{
OPTIND=1
while getopts :aj:kf:m:lN:q:p:t:T:v:w:yYz options ; do
case $options in
a) ;;
j) CMDOPT_J="1"
jobid=$OPTARG
if [ "${jobid:${#jobid}-1:1}" = "@" ]; then
OUTPUT_OPERATION=">>"
fi ;;
k) CMDOPT_K="1" ;;
l) cpfile='flist1' ;;
m) mmemory=$OPTARG ;;
N) CMDOPT_N="1"
jobtitle=$OPTARG ;;
q) resources="$OPTARG" ;;
p) cpunr=$OPTARG ;;
f) pernode=$OPTARG ;;
t) CMDOPT_T="1"
time=$OPTARG ;;
T) CMDOPT_T="1"
cleantime=$OPTARG ;;
v) version=$OPTARG ;;
w) calculation_directory=$OPTARG ;;
y) CMDOPT_Y="1" ;;
Y) CMDOPT_YY="1" ;;
z) ;;
\?) printExit E "Invalid option: -$OPTARG." ;;
esac
done
if [ -n "$CMDOPT_Y" -o -n "$CMDOPT_YY" ]; then
exec 4>&1
exec >&2
fi
}
#
# Test, whether there are any user inputs. Else display the usage
# description of the command.
#
if [ -z "$1" ] || [ "$1" = '-h' ] || [ "$1" = '--help' ] ; then
usage
fi
#
# Test special options, which will quit the processing.
#
display_only "$@"
#
# Test the three possible default files, before the command line
# is tested for the various options.
#
if [ -n "$CMDOPT_A" -o -n "$CMDOPT_Z" ]; then
echo "$PGM_NAME $PGM_VERSION"
fi
if [ -n "$CMDOPT_A" ]; then
display_defaults
fi
if [ -n "$CMDOPT_Z" ]; then
echo "Processed option file(s):"
fi
program=${0##*/sub}
declare -a DEFAULT_FILE_LOCATION
DEFAULT_FILE_LOCATION[1]=$SCRIPT_ROOT/subrc
DEFAULT_FILE_LOCATION[2]=~/.subrc
if [ `pwd` != ~ ]; then
DEFAULT_FILE_LOCATION[3]=.subrc
fi
for DEFAULT_FILE in ${DEFAULT_FILE_LOCATION[@]}; do
if [ -f "$DEFAULT_FILE" -a -r "$DEFAULT_FILE" ]; then
PARAMETER=`sed -n -e "/^ *$program /s/$program *//p" $DEFAULT_FILE`
if [ -n "$PARAMETER" ]; then
if [ -n "$CMDOPT_Z" ]; then
echo "$DEFAULT_FILE: $PARAMETER"
fi
settings $PARAMETER
fi
fi
done
#
# Special case for -a and -z option.
#
if [ -n "$CMDOPT_Z" ]; then
echo
fi
if [ -n "$CMDOPT_A" -o -n "$CMDOPT_Z" ]; then
exit 2
fi
#
# Now process the command line.
#
settings "$@"
#
# Shift the arguments up to the input without the option prefix "-".
# This should be the filename.
#
shift $((OPTIND-1))
#
# Transfer the default values.
#
if [ -z "$mmemory" ]; then
mmemory="$memory_default"
fi
#
# Test the option string for spaces.
#
if [ "$resources" != "${resources// /}" ]; then
printExit E "The option string supplied to -q must not contain any spaces."
fi
qmltmp=${resources#*_}
ppnltmp=${resources%_*}
pernodelimit=${ppnltmp: -2}
queue_memory_limit=$(( ${qmltmp%g*} / pernodelimit * 1024 )) # GB to MB conversion
if [[ $mmemory -gt $queue_memory_limit ]];then
printf "\n\e[38;5;9;4m++ memory warning:\e[0m Hi $USER, you are asking for more memory/core than allowed."
printf "\nPlease fix the memory. Else I can also set to maximum allowed memory possible in this queue for you.\n"
printf "\nQueue: $resources"
printf "\nAllowed memory: $queue_memory_limit MB; You requested: $mmemory MB per core in each node.\n\n"
echo "-- Do you want me to reset and continue? If yes press y/Y/yes/YES else press ENTER to quite."
read contin
if [[ ${contin,, } = y* ]]; then
mmemory=$queue_memory_limit
else
exit
fi
fi
#
# Adjust the number of used cores.
#
if [[ $pernode -gt $pernodelimit ]]; then
printf "\n\e[38;5;9;4m++ ppn warning:\e[0m "
echo "Hi $(whoami), you have supplied more ppn ($pernode) than allowed ($pernodelimit) in this queue."
if [[ $cpunr -gt $pernodelimit ]]; then
pernode=$pernodelimit
else
pernode=$cpunr
fi
echo "So, ppn has been adjusted to its maximum limit of this queue (or to reqiured CPUnr): $pernode"
fi
if [[ $cpunr -lt $pernodelimit ]]; then
pernode=$cpunr
elif [[ $pernode -eq $pernodelimit ]]; then
:
else
printf "\n\e[38;5;9;4m++ ppn-cpunr mismatch warning:\e[0m "
echo "Hi $(whoami), you have supplied less ppn ($pernode) than allowed ($pernodelimit) in this queue."
echo "But your requested CPUnr is greater than requested ppn."
pernode=$pernodelimit
echo "So, for better performance ppn has been adjusted to its maximum limit of this queue: $pernode"
fi
nnode=$((cpunr/pernode))
exnode=$((nnode*pernode))
if [[ $cpunr -gt $exnode ]]; then
printf "\n\e[38;5;9;4m++ node warning:\e[0m Hi $(whoami) the cpu no. you used is more than the multiple of allowed ppn"
printf "\nof this queue. So, you have been allocated 1 full extra node for better performance setup."
printf "\nPlease in future try to avoid this.\n"
((nnode++))
cpunr=$((pernode*nnode))
fi
#
# Is the requested version of VASP available?
#
if [ -z "$version" ]; then
version="$version_default"
fi
#
# Defines the location of the programs.
#
pversion=${version%-*}
case "$pversion" in
5.4.4+) binary_location="/chemsoft/vasp/5.4.4_intel_mpi/bin" ;;
5.4.4+c) binary_location="/home/bmondal/local/vasp-5.4.4_const_intel/bin" ;;
*) printExit E "Unknown program version requested."
esac
ppversion=${version#*-}
case "$ppversion" in
n) vaspbinary="vasp_ncl" ;;
g) vaspbinary="vasp_gam" ;;
*) vaspbinary="vasp_std"
esac
#
# Setup the default locations for the submitscript and the output/error
# files.
#
submitfiledir=$HOME/cmd
[ -d $submitfiledir ] || mkdir $submitfiledir || printExit E "Can't create \"$submitfiledir\"."
[ -r $submitfiledir -a -w $submitfiledir ] || printExit E "Invalid permissions for \"$submitfiledir\"."
stdoutdir=$HOME/err
[ -d $stdoutdir ] || mkdir $stdoutdir || printExit E "Can't create \"$stdoutdir\"."
[ -r $stdoutdir -a -w $stdoutdir ] || printExit E "Invalid permissions for \"$stdoutdir\"."
chkdir=$HOME/chk
[ -d $chkdir ] || mkdir $chkdir || printExit E "Can't create \"$chkdir\"."
[ -r $chkdir -a -w $chkdir ] || printExit E "Invalid permissions for \"$chkdir\"."
#
# Assemble the names for the input, output and error file.
#
jobname="$calculation_directory"
if testDirectory "$jobname" "return" ; then
pushd $jobname > /dev/null
indirectory=`pwd -P`
popd > /dev/null
jobname=$indirectory
else
printExit E "No directory \"$calculation_directory\" was found."
fi
#
# Set some other filenames.
#
jobname=${jobname##*/}
if [ ! "$CMDOPT_N" ]; then
jobtitle=$jobname
else
if [ "${jobtitle:${#jobtitle}-1:1}" = "#" ]; then
jobtitle="${jobtitle:0:${#jobtitle}-1}$jobname"
fi
if [ "${jobtitle:${#jobtitle}-1:1}" = "@" ]; then
jobtitlepath=${indirectory//\//.}
jobtitlepath=${jobtitlepath#.*.*.}
jobtitlepath=${jobtitlepath#*.}
jobtitle=${jobtitle:0:${#jobtitle}-1}$jobtitlepath
fi
fi
submitfile=$submitfiledir/$jobname.$$.vasp.sh
stderrfile=$stdoutdir/$jobname.stderr
stdoutfile=$stdoutdir/$jobname.stdout
rm -f $submitfile
rm -f $stderrfile
rm -f $stdoutfile
#
# Adjust the time according of being a serial or parallel job.
#
if [ -z "$CMDOPT_T" ]; then
time=$time_p
fi
if [ "${time#*:}" != "$time" ]; then
time_h=${time%:*}
time_m=${time#*:}
if [ -z "$time_h" ]; then
time_h="0";
fi
if [ -z "$time_m" ]; then
time_m="0";
fi
if ! expr "$time_h" : '[[:digit:]]*$' >/dev/null || ! expr "$time_m" : '[[:digit:]]*$' >/dev/null ; then
printExit E "Value for time not numeric."
fi
time=$(((time_h * 60 + time_m) * 60))
else
time=`echo $time | tr "[a-z]" "[A-Z]"`
if expr INFINITY : $time >/dev/null; then
time=INFINITY
else
if ! expr "$time" : '[[:digit:]]*$' >/dev/null; then
printExit E "Value for time not numeric."
fi
time=$((time * 3600))
fi
fi
#
# Get the final eMail address from the user's .forward file.
#
#FORWARD=~/.forward
#if [ -f "$FORWARD" -a -r "$FORWARD" ]; then
# USER=`cat $FORWARD`
#else
# printExit E "Please put your email address in a file \`~/.forward'."
#fi
#
# Give the user some feedback, that all tests went okay, and the job is to
# be submitted.
#
printf "\n\e[38;5;200m++ Hi $(whoami)\e[0m"
printf "\n*********** \e[38;5;34mYour Submit Job Summary\e[0m *****************\n"
echo "Submitting a VASP calculation for: ${indirectory##*/}"
echo "Memory: $mmemory MB, Time: $time seconds"
echo "Queue: $resources, CPU no.: $cpunr, Node: (nodes=$nnode:ppn=$pernode)"
echo "========================================================="
echo " "
#
# Open the file descriptor 3 for the output of the assembled
# submit script.
#
exec 3> $submitfile
function header1
{
#
# Write the standard header to the submit file. This lines will be there in every case.
#
cat >&3 <<-EOF
#!/bin/bash
#PBS -N $jobtitle
#PBS -o $stdoutdir -e $stdoutdir
#PBS -l nodes=${nnode}:ppn=$pernode
#PBS -l walltime=$((time+cleantime)),pmem=${mmemory}MB,mem=$((mmemory*pernode))MB
#PBS -m ea
#PBS -r n
EOF
#
# If a job id was given to wait for, do it.
#
if [ -n "$CMDOPT_J" ] ; then
echo "#PBS -W depend=afterok:$jobid" >&3
fi
#
# If the user specify some extra options, include this line in the
# submit file.
#
if [ -n "$resources" ] ; then
echo "#PBS -q $resources" >&3
fi
}
#
# Generate the whole script now.
#
function CreateScratch_CopyInput
{
cat >&3 <<-EOF
#========================================================
#************* Prepare the job folders in scratch *******
echo "+ Preparing scratch: "
TMP_DIR=/scratch/vasp_\${USER}.\${PBS_JOBNAME}.\${PBS_JOBID%%.*}
printf "+ Copy Input to local node scratch: \${SOURCE_INPUT_DIR} --> \$TMP_DIR\\n"
for N in \$NODE_LIST; do
echo "Node: \$N"
ssh -x \$N "mkdir -p \$TMP_DIR && cp \${SOURCE_INPUT_DIR}/\${CP_FILE_LIST} \$TMP_DIR/"
done
echo
EOF
}
function BookKeeping
{
BookKeepFile="$HOME/T3000_book_keeping"
if [ -f "$BookKeepFile" ]; then
:
else
echo '# date user pbs_jobname short_job_path pbs_jobid: node_list' > $BookKeepFile
fi
if [ "$cpfile" == 'flist1' ]; then
flist={INCAR,KPOINTS,POTCAR,POSCAR,WAVECAR,CHGCAR}
else
flist={INCAR,KPOINTS,POTCAR,POSCAR}
fi
short_s=$(cut -c -30 <<<${indirectory}) # Collects -le 30 char from begining`
cat >&3 <<-EOF
#=======================================================
#**** Puts the PBS job details in the book keeping *****
#**** file for future inspection, if needed. *****
USER=\$(whoami)
SOURCE_INPUT_DIR=$indirectory
short_source=$short_s # Collects -le 30 char from begining
CP_FILE_LIST=$flist
NODE_LIST=\$(cat \$PBS_NODEFILE | uniq)
printf "%-35s %-15s %-15s %-31s %-9s" "\$(date)" \$USER \${PBS_JOBNAME} \${short_source} \${PBS_JOBID%%.*}: >> $BookKeepFile
echo \$NODE_LIST >> $BookKeepFile
EOF
}
function CopyOutput
{
cat >&3 <<-EOF
#=======================================================
#******* Copy the outut files from scratch to home *****
printf "+ Copy Output to Home: \$TMP_DIR --> $indirectory\\n\\n"
cp \$TMP_DIR/* $indirectory/
EOF
}
function CleanScratch
{
cat >&3 <<-EOF
#=======================================================
#************ Cleaning scratch *************************
echo "+ Cleaning scratch: "
for N in \$NODE_LIST; do
echo "Node: \$N -- \$TMP_DIR"
ssh -x \$N rm -rf \$TMP_DIR
done
printf "\\n+ End: Good work. I am done.\\n"
EOF
}
function header2
{
cat >&3 <<-EOF
#=======================================================
#*********** Export all the necessary paths ************
umask 022
ulimit -c 0
export OMP_NUM_THREADS=1
#Give 1min to clean scratch because 'trap' command is not working here as expected
#Don't worry. I have already added extra ${cleantime} sec in the PBS_WALLTIME beforehand.
export MPIEXEC_TIMEOUT=\$((PBS_WALLTIME-${cleantime}))
export PATH="$binary_location:"\$PATH # vasp binary path
module load intel/2017v4
EOF
}
function JobRun
{
# The stack size need to be set to unlimited for large calculations for e.g. large supercell.
# Else there will be SIGSEGV
cat >&3 <<-EOF
#=======================================================
#********** Run the job ********************************
trap 'echo "*** Get SIGTERM signal";' TERM
cd \$TMP_DIR
mpiexec -n $cpunr --hostfile \$PBS_NODEFILE bash -c "ulimit -Ss unlimited && $vaspbinary" $OUTPUT_OPERATION $jobtitle.out
EOF
}
header1
header2
BookKeeping
CreateScratch_CopyInput
JobRun
CopyOutput
CleanScratch
#
# End of the parallel configuration.
#
#
# Give back the error, to avoid confusion.
#
#echo "exit \$joberror" >&3
#
# Close the file descriptor for the submit file.
#
exec 3>&-
#
# Now, there are only two things left to do:
# Submit the submitfile, and afterwards delete it.
# (Unless "keep" option selected.)
#
if [ -z "$CMDOPT_K" ] ; then
if [ -n "$CMDOPT_Y" -o -n "$CMDOPT_YY" ] ; then
JOB_ID=$(qsub $submitfile)
JOB_ID=${JOB_ID%%.*}
if [ -n "$CMDOPT_Y" ]; then
echo -n "$JOB_ID" >&4
fi
if [ -n "$CMDOPT_Y" -a -n "$CMDOPT_YY" ] ; then
echo -n " " >&4
fi
if [ -n "$CMDOPT_YY" ]; then
echo -n "$jobtitle" >&4
fi
echo >&4
else
qsub $submitfile
fi
rm -f $submitfile
else
printf "\e[38;5;4m++ Keeping the submitfile. Necessary command to submit this job:\e[0m\n"
echo -e " \e[38;5;20m qsub $submitfile \e[0m"
fi
printf "\n+++++++++ \e[38;5;200mBye!! Have a nice day.\e[0m +++++++++++++++++\n\n"
printf "\n\e[38;5;1m**Alert: If you kill a running job manually, cleaning scratch wouldn't be complete.\e[0m \n"
printf "\e[38;5;1m You have to copy the files back and clean the scratch manually. Sorry for that. \e[0m \n\n"
#
# Well, that's all. Now exit in a proper way.
#
sleep 1
exit 0