Abaqus: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(reformat license file instructions)
(Marked this version for translation)
 
(381 intermediate revisions by 5 users not shown)
Line 3: Line 3:
__FORCETOC__
__FORCETOC__
<translate>
<translate>
<!--T:1-->
<!--T:20819-->
[https://www.3ds.com/products-services/simulia/products/abaqus/ Abaqus FEA] is a software suite for finite element analysis and computer-aided engineering.
[https://www.3ds.com/products-services/simulia/products/abaqus/ Abaqus FEA] is a software suite for finite element analysis and computer-aided engineering.


= Using your own license = <!--T:2-->
= Using your own license = <!--T:20820-->
Abaqus is available on Compute Canada clusters, but you must provide your own license. Create in your account a file named <tt>$HOME/.licenses/abaqus.lic</tt> containing this single line:
Abaqus software modules are available on our clusters; however, you must provide your own license. To configure your account on a cluster, log in and create a file named <code>$HOME/.licenses/abaqus.lic</code> containing the following two lines which support versions 202X and 6.14.1 respectively. Next, replace <code>port@server</code> with the flexlm port number and server IP address (or fully qualified hostname) of your Abaqus license server.


<!--T:20821-->
{{File
{{File
|names=abaqus.lic
|name=abaqus.lic
|contents=
|contents=
prepend_path("LM_LICENSE_FILE","port@server", ";")
prepend_path("ABAQUSLM_LICENSE_FILE","port@server")
prepend_path("LM_LICENSE_FILE","port@server")
}}
}}


...replacing <code>port@server</code> with the port number and name of your Abaqus license server.
<!--T:20822-->
If your license has not been set up for use on an Alliance cluster, some additional configuration changes by the Alliance system administrator and your local system administrator will need to be done. Such changes are necessary to ensure the flexlm and vendor TCP ports of your Abaqus server are reachable from all cluster compute nodes when jobs are run via the queue. So we may help you get this done, write to [[Technical support|technical support]]. Please be sure to include the following three items:
* flexlm port number
* static vendor port number
* IP address of your Abaqus license server.
You will then be sent a list of cluster IP addresses so that your administrator can open the local server firewall to allow connections from the cluster on both ports. Please note that a special license agreement must generally be negotiated and signed by SIMULIA and your institution before a local  license may be used remotely on Alliance hardware.


Your license server must be reachable by our compute nodes, so your firewall will need to be configured appropriately. This usually requires our technical team to get in touch with the technical people managing your license software. Please contact our [[Technical support|technical support]] and we will provide a list of IP addresses used by our clusters and obtain the information we need on the port and IP address of your server.
= Cluster job submission = <!--T:20823-->
Below are prototype Slurm scripts for submitting thread and mpi-based parallel simulations to single or multiple compute nodes.  Most users will find it sufficient to use one of the <b>project directory scripts</b> provided in the <i>Single node computing</i> sections. The optional <code>memory=</code> argument found in the last line of the scripts is intended for larger memory or problematic jobs where 3072MB offset value may require tuning. A listing of all Abaqus command line arguments can be obtained by loading an Abaqus module and running: <code>abaqus -help | less</code>.


= Submission script = <!--T:3-->
<!--T:20824-->
Below is an example submission script for a small Abaqus Explicit job running on four cores:
Single node jobs that run less than one day should find the <i>project directory script</i> located in the first tab sufficient. However, single node jobs that run for more than a day should use one of the restart scripts.  Jobs that create large restart files will benefit by writing to local disk through the use of the SLURM_TMPDIR environment variable utilized in the <b>temporary directory scripts</b> provided in the two rightmost tabs of the single node standard and explicit analysis sections.  The restart scripts shown here will continue jobs that have been terminated early for some reason.  Such job failures can occur if a job reaches its maximum requested runtime before completing and is killed by the queue or if the compute node the job was running on crashed due to an unexpected hardware failure.  Other restart types are possible by further tailoring of the input file (not shown here) to continue a job with additional steps or change the analysis (see the documentation for version specific details).


{{File|contents=
<!--T:20825-->
Jobs that require large memory or larger compute resources (beyond that which a single compute node can provide) should use the mpi scripts in the <b>multiple node sections</b> below to distribute computing over arbitrary node ranges determined automatically by the scheduler.  Short scaling test jobs should be run to determine wall-clock times (and memory requirements) as a function of the number of cores (2, 4, 8, etc.) to determine the optimal number before running any long jobs.
 
== Standard analysis == <!--T:20826-->
Abaqus solvers support thread-based and mpi-based parallelization.  Scripts for each type are provided below for running Standard Analysis type jobs on Single or Multiple nodes respectively.  Scripts to perform multiple node job restarts are not currently provided.
 
=== Single node computing === <!--T:20827-->
 
<!--T:20868-->
<tabs>
<tab name="project directory script">
{{File
  |name="scriptsp1.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G              # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !
 
<!--T:20869-->
module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version
 
<!--T:20870-->
#module load StdEnv/2016      # Uncomment to use
#module load abaqus/2020      # Uncomment to use
 
<!--T:20871-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
 
<!--T:20872-->
rm -f testsp1* testsp2*
abaqus job=testsp1 input=mystd-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
}}
 
<!--T:20828-->
To write restart data every N=12 time increments specify in the input file:
*RESTART, WRITE, OVERLAY, FREQUENCY=12
To write restart data for a total of 12 time increments specify instead:
*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO
To check for completed restart information do:
egrep -i "step|start" testsp*.com testsp*.msg testsp*.sta
Some simulations may benefit by adding the following to the Abaqus command at the bottom of the script:
order_parallel=OFF
 
<!--T:20873-->
</tab>
<tab name="project directory restart script">
{{File
  |name="scriptsp2.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#!/bin/bash
#SBATCH --time=1-00:00
#SBATCH --account=def-group    # Specify account
#SBATCH --mem=2500M
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4
#SBATCH --cpus-per-task=4     # Specify number of cores
#SBATCH --mem=8G              # Specify total memory > 5G
module load abaqus/6.14.1
#SBATCH --nodes=1              # Do not change !
 
<!--T:20874-->
module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version
 
<!--T:20917-->
unset SLURM_GTIDS
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"


abaqus job=Job-SBS-ALU-EXPLICIT-01 input=2018-04-14-SBS-ALUMINUM-EXPLICIT-01.inp memory="2 gb" scratch=$SCRATCH cpus=4 interactive
<!--T:20875-->
rm -f testsp2* testsp1.lck
abaqus job=testsp2 oldjob=testsp1 input=mystd-sim-restart.inp \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
}}
}}


= Abaqus command line options =
<!--T:20829-->
The restart input file should contain:
*HEADING
*RESTART, READ
 
<!--T:20876-->
</tab>
<tab name="temporary directory script">
{{File
  |name="scriptst1.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G              # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !
 
<!--T:20877-->
module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version


You can get a list of Abaqus' command line options with <code>abaqus -help</code>.
<!--T:20878-->
There are a lot of options, so you may wish to pipe the output into a pagination program, e.g.:
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR


{{Command|prompt=[name@gra-vdi4]$  
<!--T:20879-->
|abaqus -help {{!}} less
rm -f testst1* testst2*
cd $SLURM_TMPDIR
while sleep 6h; do
  cp -f * $SLURM_SUBMIT_DIR 2>/dev/null
done &
WPID=$!
abaqus job=testst1 input=$SLURM_SUBMIT_DIR/mystd-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f * $SLURM_SUBMIT_DIR
}}
}}


= Using the graphical interface =
<!--T:20830-->
To write restart data every N=12 time increments specify in the input file:
*RESTART, WRITE, OVERLAY, FREQUENCY=12
To write restart data for a total of 12 time increments specify instead:
*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO
To check the completed restart information do:
egrep -i "step|start" testst*.com testst*.msg testst*.sta
 
<!--T:20880-->
</tab>
<tab name="temporary directory restart script">
{{File
  |name="scriptst2.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G              # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !
 
<!--T:20881-->
module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version
 
<!--T:20882-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR
 
<!--T:20883-->
rm -f testst2* testst1.lck
cp testst1* $SLURM_TMPDIR
cd $SLURM_TMPDIR
while sleep 3h; do
  cp -f testst2* $SLURM_SUBMIT_DIR 2>/dev/null
done &
WHILEPID=$!
abaqus job=testst2 oldjob=testst1 input=$SLURM_SUBMIT_DIR/mystd-sim-restart.inp \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f testst2* $SLURM_SUBMIT_DIR
}}


== Graham VDI ==
<!--T:20831-->
see [[Graham#Volta_GPU_nodes_on_Graham Graham VDI Nodes]]<br>
The restart input file should contain:
The gra-vdi machine can be used to run Abaqus interactively with the Sharcnet licenses by any Compute Canada member. Further details regarding how to connect with tigervnc are described below. The license can also be used for running jobs by connecting to dusky.sharcnet.ca. Once connected load the following module:
*HEADING
  *RESTART, READ


module load abaqus/2019-sn
<!--T:20884-->
</tab>
</tabs>


If an Abaqus job fails to get a license upon startup, it must be manually killed otherwise it will sit idle on the compute node until its "sqsub -r runtime" limit is reached, and the queue automatically kills it offOne can tell if a job is in an idle state by inspecting the job output file then killing it with the <code>sqkill</code> or <code>scancel</code> commands.
=== Multiple node computing === <!--T:20832-->
Users with large memory or compute needs (and correspondingly large licenses) can use the following script to perform mpi-based computing over an arbitrary range of nodes ideally left to the scheduler to  automatically determineA companion template script to perform restart multinode jobs is not currently provided due to additional limitations when they can be used.


<pre>
[roberpj@dus241:~/test-abaqus] cat ofile.93249
Abaqus JOB myjob
Abaqus 6.13-3
"standard" license request queued for the License Server.
Total time in queue: 0 seconds.
"standard" license request queued for the License Server.
Total time in queue: 30 seconds.
"standard" license request queued for the License Server.
Total time in queue: 60 seconds.
etc
</pre>


===Running CAE GUI on a viz or VDI workstation ===
<!--T:20885-->
{{File
  |name="scriptsp1-mpi.txt"
  |lang="sh"
  |contents=
!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
# SBATCH --nodes=2            # Best to leave commented
#SBATCH --ntasks=8            # Specify number of cores
#SBATCH --mem-per-cpu=16G      # Specify memory per core
#SBATCH --cpus-per-task=1      # Do not change !
 
<!--T:20886-->
module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version
 
<!--T:20887-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
 
<!--T:20888-->
rm -f testsp1-mpi*
 
<!--T:20889-->
unset hostlist
nodes="$(slurm_hl2hl.py --format MPIHOSTLIST {{!}} xargs)"
for i in `echo "$nodes" {{!}} xargs -n1 {{!}} uniq`; do hostlist=${hostlist}$(echo "['${i}',$(echo "$nodes" {{!}} xargs -n1 {{!}} grep $i {{!}} wc -l)],"); done
hostlist="$(echo "$hostlist" {{!}} sed 's/,$//g')"
mphostlist="mp_host_list=[$(echo "$hostlist")]"
export $mphostlist
echo "$mphostlist" > abaqus_v6.env
 
<!--T:20890-->
abaqus job=testsp1-mpi input=mystd-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_NTASKS interactive mp_mode=mpi
}}
 
== Explicit analysis == <!--T:20833-->
Abaqus solvers support thread-based and mpi-based parallelization.  Scripts for each type are provided below for running explicit analysis type jobs on single or multiple nodes respectively.  Template scripts to perform multinode job restarts are not currently provided pending further testing.
 
=== Single node computing === <!--T:20834-->
 
 
<!--T:20891-->
<tabs>
<tab name="project directory script">
{{File
  |name="scriptep1.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change
 
<!--T:20892-->
module load abaqus/2021
 
<!--T:20893-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
 
<!--T:20894-->
rm -f testep1* testep2*
abaqus job=testep1 input=myexp-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
}}
 
<!--T:20835-->
To write restart data for a total of 12 time increments specify in the input file:
*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO
Check for completed restart information in relevant output files:
egrep -i "step|restart" testep*.com testep*.msg testep*.sta
 
<!--T:20895-->
</tab>
<tab name="project directory restart script">
{{File
  |name="scriptep2.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change
 
<!--T:20896-->
module load abaqus/2021
 
<!--T:20897-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
 
<!--T:20898-->
rm -f testep2* testep1.lck
for f in testep1*; do [[ -f ${f} ]] && cp -a "$f" "testep2${f#testep1}"; done
abaqus job=testep2 input=myexp-sim.inp recover \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
}}
 
<!--T:20836-->
No input file modifications are required to restart the analysis.
 
<!--T:20899-->
</tab>
<tab name="temporary directory script">
{{File
  |name="scriptet1.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change
 
<!--T:20900-->
module load abaqus/2021
 
<!--T:20901-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR
 
<!--T:20902-->
rm -f testet1* testet2*
cd $SLURM_TMPDIR
while sleep 6h; do
  cp -f * $SLURM_SUBMIT_DIR 2>/dev/null
done &
WPID=$!
abaqus job=testet1 input=$SLURM_SUBMIT_DIR/myexp-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f * $SLURM_SUBMIT_DIR
}}
 
<!--T:20837-->
To write restart data for a total of 12 time increments specify in the input file:
*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO
Check for completed restart information in relevant output files:
egrep -i "step|restart" testet*.com testet*.msg testet*.sta
 
<!--T:20903-->
</tab>
<tab name="temporary directory restart script">
{{File
  |name="scriptet2.txt"
  |lang="sh"
  |contents=
#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change
 
<!--T:20904-->
module load abaqus/2021
 
<!--T:20905-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR
 
<!--T:20906-->
rm -f testet2* testet1.lck
for f in testet1*; do cp -a "$f" $SLURM_TMPDIR/"testet2${f#testet1}"; done
cd $SLURM_TMPDIR
while sleep 3h; do
  cp -f * $SLURM_SUBMIT_DIR 2>/dev/null
done &
WPID=$!
abaqus job=testet2 input=$SLURM_SUBMIT_DIR/myexp-sim.inp recover \
  scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
  mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f  * $SLURM_SUBMIT_DIR
}}
 
<!--T:20838-->
No input file modifications are required to restart the analysis.
 
<!--T:20907-->
</tab>
</tabs>
 
 
=== Multiple node computing === <!--T:20839-->
 
<!--T:20908-->
{{File
  |name="scriptep1-mpi.txt"
  |lang="sh"
  |contents=
!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --ntasks=8            # Specify number of cores
#SBATCH --mem-per-cpu=16000M  # Specify memory per core
# SBATCH --nodes=2            # Specify number of nodes (optional)
#SBATCH --cpus-per-task=1      # Do not change !
 
<!--T:20909-->
module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version
 
<!--T:20910-->
unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
# uncomment next line when using abaqus/2021
export I_MPI_HYDRA_TOPOLIB=ipl
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
 
<!--T:20911-->
rm -f testep1-mpi*
 
<!--T:20912-->
unset hostlist
nodes="$(slurm_hl2hl.py --format MPIHOSTLIST {{!}} xargs)"
for i in `echo "$nodes" {{!}} xargs -n1 {{!}} uniq`; do hostlist=${hostlist}$(echo "['${i}',$(echo "$nodes" {{!}} xargs -n1 {{!}} grep $i {{!}} wc -l)],"); done
hostlist="$(echo "$hostlist" {{!}} sed 's/,$//g')"
mphostlist="mp_host_list=[$(echo "$hostlist")]"
export $mphostlist
echo "$mphostlist" > abaqus_v6.env
 
<!--T:20913-->
abaqus job=testep1-mpi input=myexp-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_NTASKS interactive mp_mode=mpi
}}
 
== Node memory == <!--T:20840-->
An estimate for the total slurm node memory (--mem=) required for a simulation to run fully in ram (without being virtualized to scratch disk) can be obtained by examining the Abaqus output <code>test.dat</code> file.  For example, a simulation that requires a fairly large amount of memory might show:
</translate>
 
<source lang="bash">
                  M E M O R Y  E S T I M A T E
 
PROCESS      FLOATING PT      MINIMUM MEMORY        MEMORY TO
              OPERATIONS          REQUIRED          MINIMIZE I/O
            PER ITERATION          (MB)              (MB)
 
    1          1.89E+14            3612              96345
</source>
 
<translate>
<!--T:20841-->
To run your simulation interactively and monitor the memory consumption, do the following:<br>
1) ssh into a cluster, obtain an allocation on a compute node (such as gra100), run abaqus ie.
 
<!--T:20914-->
{{Commands
|salloc --time=0:30:00 --cpus-per-task=8 --mem=64G --account=def-piname
|module load abaqus/6.14.1  OR  module load abaqus/2020
|unset SLURM_GTIDS
|abaqus job=test input=Sample.inp scratch=$SCRATCH cpus=8 mp_mode=threads interactive
}}
 
<!--T:20916-->
2) ssh into the cluster again, ssh into the compute node with the allocation, run top ie.
 
<!--T:20915-->
{{Commands|ssh gra100
|top -u $USER}}
 
<!--T:20843-->
3) watch the VIRT and RES columns until steady peak memory values are observed
 
<!--T:20844-->
To completely satisfy the recommended "MEMORY TO OPERATIONS REQUIRED MINIMIZE I/O" (MRMIO) value, at least the same amount of non-swapped physical memory (RES) must be available to Abaqus.  Since the RES will in general be less than the virtual memory (VIRT) by some relatively constant amount for a given simulation, it is necessary to slightly over-allocate the requested Slurm node memory <code>-mem=</code>.  In the above sample Slurm script, this over-allocation has been hardcoded to a conservative value of 3072MB based on initial testing of the standard Abaqus solver.  To avoid long queue wait times associated with large values of MRMIO, it may be worth investigating the simulation performance impact associated with reducing the RES memory that is made available to Abaqus significantly below the MRMIO.  This can be done by lowering the <code>-mem=</code> value which in turn will set an artificially low value of <code>memory=</code> in the Abaqus command (found in the last line of the slurm script).  In doing this one should be careful the RES does not dip below the MINIMUM MEMORY REQUIRED (MMR) otherwise Abaqus will exit due to Out of Memory (OOM).  As an example, if your MRMIO is 96GB try running a series of short test jobs with <code>#SBATCH --mem=8G, 16G, 32G, 64G</code> until an acceptable minimal performance impact is found, noting that smaller values will result in increasingly larger scratch space used by temporary files.
 
= Graphical use = <!--T:20845-->
Abaqus can be run interactively in graphical mode on a cluster or gra-vdi using VNC by following these steps:
 
== On a cluster == <!--T:20846-->
1. Connect to a compute node (3hr salloc time limit) with [[VNC#Compute_nodes|TigerVNC]]<br>
2. Open a new terminal window and enter the following<br>
module load StdEnv/2020 abaqus/2021
3. Start the application with<br>
abaqus cae -mesa
 
== On gra-vdi == <!--T:20847-->
1. Connect to gra-vdi with [[VNC#VDI_nodes|TigerVNC]]<br><br>
2. Open a new terminal window and enter one of the following:
module load CcEnv StdEnv/2016 abaqus/6.14.1 or
module load CcEnv StdEnv/2016 abaqus/2020 or
module load CcEnv StdEnv/2020 abaqus/2021
3. Start the application with<br>
abaqus cae
 
<!--T:20848-->
For abaqus to start in gui mode  must be at least <b>one</b> free cae license (not in use).  The SHARCNET license has 2 free and 2 reserved licenses.  If all 4 are in use according to:
 
<!--T:20918-->
[gra-vdi3:~] abaqus licensing lmstat -c $ABAQUSLM_LICENSE_FILE -a | grep "Users of cae"
Users of cae:  (Total of 4 licenses issued;  Total of 4 licenses in use)


To connect, we recommend installing the tigervnc client on your desktop, as described in https://www.sharcnet.ca/help/index.php/Remote_Graphical_Connections.  The best vdi machine at Sharcnet to run Abaqus on interactivly in GUI mode is currently <b>gra-vdi.computecanada.ca</b>.  This machine is located at uw therefore the uwo engineering/robarts combined licenses cannot be use.  To start Abaqus GUI on gra-vdi do the following:<br>
<!--T:20919-->
Then the following error messages will occur when you attempt to start abaqus cae:


<pre>
<!--T:20920-->
1) connect to gra-vdi.computecanada.ca with tigervnc
[gra-vdi3:~] abaqus cae
2) module load StdEnv
ABAQUSLM_LICENSE_FILE=27050@license3.sharcnet.ca
3) module load abaqus/2019-sn
/opt/sharcnet/abaqus/2020/Commands/abaqus cae
4) abaqus cae
No socket connection to license server manager.
</pre>
Feature:      cae
License path:  27050@license3.sharcnet.ca:
FLEXnet Licensing error:-7,96
For further information, refer to the FLEXnet Licensing documentation,
or contact your local Abaqus representative.
Number of requested licenses: 1
Number of total licenses:    4
Number of licenses in use:    2
Number of available licenses: 2
Abaqus Error: Abaqus/CAE Kernel exited with an error.


Previously, Sharcnet recommended using <b>vdi-centos6.user.sharcnet.ca</b> with tigervnc with the following procedure. it is likely this machine will be shut down May1 along with all other sharcnet legacy systems.
= Site-specific use = <!--T:20850-->
== SHARCNET license ==
SHARCNET provides a small but free license consisting of 2 cae and 35 execute tokens where usage limits are imposed 10 tokens/user and 15 tokens/group.  For groups that have purchased dedicated tokens, the free token usage limits are added to their reservation.  The free tokens are available on a first come first serve basis and mainly intended for testing and light usage before deciding whether or not to purchase dedicated tokens.  Costs for dedicated tokens (in 2021) were approximately CAD$110 per compute token and CAD$400 per GUI token: submit a ticket to request an official quote.  The license can be used by any Alliance researcher, but only on SHARCNET hardware.  Groups that purchase dedicated tokens to run on the SHARCNET license server may likewise only use them on SHARCNET hardware including gra-vdi (for running Abaqus in full graphical mode) and Graham or Dusky clusters (for submitting compute batch jobs to the queue). Before you can use the license you must contact [[Technical support]] and request access. In your email 1) mention that it is for use on SHARCNET systems and 2) include a copy/paste of the following <code>License Agreement</code> statement with your full name and username entered in the indicated locations. Please note that every user must do this it cannot be done one time only for a group; this includes PIs who have purchased their own dedicated tokens.


<pre>
=== License agreement === <!--T:20851-->
1) connect to vdi-centos6.user.sharcnet.ca with tigervnc
<pre>----------------------------------------------------------------------------------
2) run the following two commands ...
Subject: Abaqus SHARCNET Academic License User Agreement
module load intel/12.1.3 abaqus/6.14.2-sn
abaqus cae
</pre>


==Check license status==
<!--T:20852-->
This email is to confirm that i "_____________" with username "___________" will
only use “SIMULIA Academic Software” with tokens from the SHARCNET license server
for the following purposes:


Load the Abaqus module and run tne following commands.  Note that 1 CAE & 19 standard tokens are reserved for a research group who purchased them and these will always appear in use. To purchase a CAE or standard compute licenses (to ensure access) open a ticket, pro-rated pricing will be explained if during the middle of the license year commencing each mid January.
<!--T:20853-->
1) on SHARCNET hardware where the software is already installed
2) in affiliation with a Canadian degree-granting academic institution
3) for education, institutional or instruction purposes and not for any commercial
  or contract-related purposes where results are not publishable
4) for experimental, theoretical and/or digital research work, undertaken primarily
  to acquire new knowledge of the underlying foundations of phenomena and observable
  facts, up to the point of proof-of-concept in a laboratory   
-----------------------------------------------------------------------------------</pre>


===All features===
=== Configure license file === <!--T:20854-->
Configure your license file as follows, noting that it is only usable on SHARCNET systems: Graham, gra-vdi and Dusky.
</translate>
<source lang="bash">
[gra-login1:~] cat ~/.licenses/abaqus.lic
prepend_path("LM_LICENSE_FILE","27050@license3.sharcnet.ca")
prepend_path("ABAQUSLM_LICENSE_FILE","27050@license3.sharcnet.ca")
</source>


<pre>
<translate>
abaqusstat
<!--T:20855-->
</pre>
If your Abaqus jobs fail with the error message [*** ABAQUS/eliT_CheckLicense rank 0 terminated by signal 11 (Segmentation fault)] in the slurm output file, verify if your <code>abaqus.lic</code> file contains ABAQUSLM_LICENSE_FILE to use abaqus/2020.  If your Abaqus jobs fail with an error message starting [License server machine is down or not responding, etc.] in the output file verify your <code>abaqus.lic</code> file contains LM_LICENSE_FILE to use abaqus/6.14.1 as shown.  The <code>abaqus.lic</code> file shown contains both so you should not see this problem.


===CAE feature===
=== Query license server === <!--T:20661-->
Log into graham, load abaqus and then run one of the following:
<source lang="bash">
ssh graham.alliancecan.ca
module load StdEnv/2020
module load abaqus
</source>


<pre>
<!--T:20921-->
[roberpj@vdi-centos6:~] abaqusstat | grep cae
I) Check the SHARCNET license server for started and queued jobs:
Users of cae: (Total of 3 licenses issued;  Total of 1 license in use)
</translate>
  "cae" v61.8, vendor: ABAQUSLM
<source lang="bash">
</pre>
abaqus licensing lmstat -c $LM_LICENSE_FILE -a | egrep "Users|start|queued"
</source>
<translate>
<!--T:20856-->
II) Check the SHARCNET license server for started and queued jobs also showing reservations by purchasing groups:
</translate>
<source lang="bash">
abaqus licensing lmstat -c $LM_LICENSE_FILE -a | egrep "Users|start|queued|RESERVATION"
</source>
<translate>
<!--T:20857-->
III) Check the SHARCNET license server for only cae, standard and explicit product availability:
</translate>
<source lang="bash">
abaqus licensing lmstat -c $LM_LICENSE_FILE -a | grep "Users of" | egrep "cae|standard|explicit"
</source>
<translate>
<!--T:20858-->
When the output of query I) above indicates that a job for a particular username is queued this means the job has entered the "R"unning state from the perspective of <code>squeue -j jobid</code> or <code>sacct -j jobid</code> and is therefore idle on a compute node waiting for a license.  This will have the same impact on your account priority as if the job were performing computations and consuming CPU time. Eventually when sufficient licenses come available the queued job will start.  To demonstrate, the following shows the license server and queue output for the situation where a user submits two jobs, but only the first job acquires enough licenses to start:
</translate>


===Standard feature===
[roberpj@dus241:~] sq
          JOBID    USER      ACCOUNT          NAME  ST  TIME_LEFT  NODES  CPUS  MIN_MEM  NODELIST (REASON)
          29801  roberpj  def-roberpj  scriptep1.txt  R    2:59:18      1    12      8G  dus47 (None)
          29802  roberpj  def-roberpj  scriptsp1.txt  R    2:59:33      1    12      8G  dus28 (None)


<pre>
[roberpj@dus241:~] abaqus licensing lmstat -c $LM_LICENSE_FILE -a | egrep "Users|start|queued|RESERVATION"
[roberpj@vdi-centos6:~] abaqusstat | grep standard
  Users of abaqus:  (Total of 78 licenses issued;  Total of 71 licenses in use)
Users of standard:  (Total of 40 licenses issued;  Total of 38 licenses in use)
      roberpj dus47 /dev/tty (v62.2) (license3.sharcnet.ca/27050 275), start Thu 8/27 5:45, 14 licenses
  "standard" v61.8, vendor: ABAQUSLM
      roberpj dus28 /dev/tty (v62.2) (license3.sharcnet.ca/27050 729) queued for 14 licenses
</pre>


===Mapping from tokens to CPUs for Abaqus standard/explicit===
<translate>
=== Specify job resources === <!--T:20859-->
To ensure optimal usage of both your Abaqus tokens and our resources, it's important to carefully specify the required memory and ncpus in your Slurm script.  The values can be determined by submitting a few short test jobs to the queue then checking their utilization.  For <b>completed</b> jobs use <code>seff JobNumber</code> to show the total <i>Memory Utilized</i> and <i>Memory Efficiency</i>. If the <i>Memory Efficiency</i> is less than ~90%, decrease the value of the <code>#SBATCH --mem=</code> setting in your Slurm script accordingly.  Notice that the <code>seff JobNumber</code> command also shows the total <i>CPU (time) Utilized</i> and <i>CPU Efficiency</i>. If the <i>CPU Efficiency</i> is less than ~90%, perform scaling tests to determine the optimal number of CPUs for optimal performance and then update the value of <code>#SBATCH --cpus-per-task=</code> in your Slurm script.  For <b>running</b> jobs, use the <code>srun --jobid=29821580 --pty top -d 5 -u $USER</code> command to watch the %CPU, %MEM and RES for each Abaqus parent process on the compute node. The %CPU and %MEM columns display the percent usage relative to the total available on the node while the RES column shows the per process resident memory size (in human readable format for values over 1GB). Further information regarding how to [[Running jobs#Monitoring_jobs|monitor jobs]] is available on our documentation wiki


=== Core token mapping === <!--T:20860-->
</translate>
<pre>
<pre>
CPUS  1  2 8  12  16  24 32 64 128
TOKENS 5  6  7 8 10 12 14 16  19  21  25 28 34 38
TOKENS 5   6 8  12  14 16 19 21 28  38
CORES  1  2  3  4   6   8  12  16  24 32 48 64 96 128
</pre>
</pre>
<translate>
<!--T:20861-->
where TOKENS = floor[5 X CORES^0.422]


See also https://deviceanalytics.com/abaqus-token-calculator
== Western license == <!--T:20862-->
The Western site license may only be used by Western researchers on hardware located at Western's campus.  Currently, the Dusky cluster is the only system that satisfies these conditions. Graham and gra-vdi are excluded since they are located on Waterloo's campus.  Contact the Western Abaqus license server administrator <jmilner@robarts.ca> to inquire about using the Western Abaqus license.  You will need to provide your username and possibly make arrangements to purchase tokens.  If you are granted access then you may proceed to configure your <code>abaqus.lic</code> file to point to the Western license server as follows:


===Example of token consumption with consecutively run jobs===
=== Configure license file === <!--T:20863-->
Configure your license file as follows, noting that it is only usable on Dusky.


<pre>
</translate>
1) abaqus cae -mesa
<source lang="bash">
Abaqus License Manager checked out the following license(s):
[dus241:~] cat .licenses/abaqus.lic
"cae" release 6.11 from license3.sharcnet.ca
prepend_path("LM_LICENSE_FILE","27000@license4.sharcnet.ca")
<1 out of 2 licenses remain available>.
prepend_path("ABAQUSLM_LICENSE_FILE","27000@license4.sharcnet.ca")
</source>
<translate>
<!--T:20864-->
Once configured, submit your job as described in the <i>Cluster job submission</i> section above.  If there are any problems submit a problem ticket to [[Technical support|technical support]].  Specify that you are using the Abaqus Western license on dusky and provide the failed job number along with a paste of any error messages as applicable.


2) abaqus cae -mesa
= Online documentation = <!--T:20865-->
Abaqus License Manager checked out the following license(s):
The full Abaqus documentation (latest version) can be accessed on gra-vdi as shown in the following steps.
"cae" release 6.11 from license3.sharcnet.ca
<0 out of 2 licenses remain available>.


3) PARALLEL JOB USING 2CPU
<!--T:20866-->
sqsub -r 1h --nompirun --mpp=6G -q mpi -n 2 -N 1 -o ofile.%J
Account preparation:
abaqus cpus=2 mp_mode=mpi interactive input=heattransfermanifold_cavity.inp job=job_par3
# connect to <b>gra-vdi.computecanada.ca</b> with tigervnc as described [[VNC#VDI_Nodes | here]]
Abaqus/Standard checked out 6 tokens.
# open a terminal window on gra-vdi and type <code>firefox</code> (hit enter)
<29 out of 35 licenses remain available>.
# in the address bar type <code>about:config</code> (hit enter) -> click the <I>I accept the risk!</i> button
# in the search bar type <code>unique</code> then double click <code>privacy.file_unique_origin</code> to change true to false


4) ADDITIONAL PARALLEL JOB USING 4CPU
<!--T:20867-->
sqsub -r 1h --nompirun --mpp=6G -q mpi -n 4 -N 1 -o ofile.%J
View documentation:
abaqus cpus=4 mp_mode=mpi interactive input=heattransfermanifold_cavity.inp job=job_par3
# connect to <b>gra-vdi.computecanada.ca</b> with tigervnc as described [[VNC#VDI_Nodes | here]]
Abaqus/Standard checked out 8 tokens.
# open a terminal window on gra-vdi and type <code>firefox </code> (hit enter)
<21 out of 35 licenses remain available>.
# in the search bar copy paste one of the following:<br><code>file:///opt/sharcnet/abaqus/2020/doc/English/DSSIMULIA_Established.htm</code>, or<br><code>file:///opt/sharcnet/abaqus/2021/doc/English/DSSIMULIA_Established.htm</code>
# find a topic by clicking for example: <i>Abaqus -> Analysis -> Analysis Techniques -> Analysis Continuation Techniques</i>


5) SUMMARY
[roberpj@viz10-uwo:~] abaqusstat | grep abaqus
Users of abaqus:  (Total of 35 licenses issued;  Total of 16 licenses in use)
[roberpj@viz10-uwo:~] abaqusstat | grep standard
Users of standard:  (Total of 35 licenses issued;  Total of 16 licenses in use)
</pre>
</translate>
</translate>

Latest revision as of 17:50, 13 November 2024

Other languages:

Abaqus FEA is a software suite for finite element analysis and computer-aided engineering.

Using your own license[edit]

Abaqus software modules are available on our clusters; however, you must provide your own license. To configure your account on a cluster, log in and create a file named $HOME/.licenses/abaqus.lic containing the following two lines which support versions 202X and 6.14.1 respectively. Next, replace port@server with the flexlm port number and server IP address (or fully qualified hostname) of your Abaqus license server.


File : abaqus.lic

prepend_path("ABAQUSLM_LICENSE_FILE","port@server")
prepend_path("LM_LICENSE_FILE","port@server")


If your license has not been set up for use on an Alliance cluster, some additional configuration changes by the Alliance system administrator and your local system administrator will need to be done. Such changes are necessary to ensure the flexlm and vendor TCP ports of your Abaqus server are reachable from all cluster compute nodes when jobs are run via the queue. So we may help you get this done, write to technical support. Please be sure to include the following three items:

  • flexlm port number
  • static vendor port number
  • IP address of your Abaqus license server.

You will then be sent a list of cluster IP addresses so that your administrator can open the local server firewall to allow connections from the cluster on both ports. Please note that a special license agreement must generally be negotiated and signed by SIMULIA and your institution before a local license may be used remotely on Alliance hardware.

Cluster job submission[edit]

Below are prototype Slurm scripts for submitting thread and mpi-based parallel simulations to single or multiple compute nodes. Most users will find it sufficient to use one of the project directory scripts provided in the Single node computing sections. The optional memory= argument found in the last line of the scripts is intended for larger memory or problematic jobs where 3072MB offset value may require tuning. A listing of all Abaqus command line arguments can be obtained by loading an Abaqus module and running: abaqus -help | less.

Single node jobs that run less than one day should find the project directory script located in the first tab sufficient. However, single node jobs that run for more than a day should use one of the restart scripts. Jobs that create large restart files will benefit by writing to local disk through the use of the SLURM_TMPDIR environment variable utilized in the temporary directory scripts provided in the two rightmost tabs of the single node standard and explicit analysis sections. The restart scripts shown here will continue jobs that have been terminated early for some reason. Such job failures can occur if a job reaches its maximum requested runtime before completing and is killed by the queue or if the compute node the job was running on crashed due to an unexpected hardware failure. Other restart types are possible by further tailoring of the input file (not shown here) to continue a job with additional steps or change the analysis (see the documentation for version specific details).

Jobs that require large memory or larger compute resources (beyond that which a single compute node can provide) should use the mpi scripts in the multiple node sections below to distribute computing over arbitrary node ranges determined automatically by the scheduler. Short scaling test jobs should be run to determine wall-clock times (and memory requirements) as a function of the number of cores (2, 4, 8, etc.) to determine the optimal number before running any long jobs.

Standard analysis[edit]

Abaqus solvers support thread-based and mpi-based parallelization. Scripts for each type are provided below for running Standard Analysis type jobs on Single or Multiple nodes respectively. Scripts to perform multiple node job restarts are not currently provided.

Single node computing[edit]

File : "scriptsp1.txt"

#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G               # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !

module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version

#module load StdEnv/2016       # Uncomment to use
#module load abaqus/2020       # Uncomment to use

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"

rm -f testsp1* testsp2*
abaqus job=testsp1 input=mystd-sim.inp \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"


To write restart data every N=12 time increments specify in the input file:

*RESTART, WRITE, OVERLAY, FREQUENCY=12

To write restart data for a total of 12 time increments specify instead:

*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO

To check for completed restart information do:

egrep -i "step|start" testsp*.com testsp*.msg testsp*.sta

Some simulations may benefit by adding the following to the Abaqus command at the bottom of the script:

order_parallel=OFF
File : "scriptsp2.txt"

#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G               # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !

module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"

rm -f testsp2* testsp1.lck
abaqus job=testsp2 oldjob=testsp1 input=mystd-sim-restart.inp \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"


The restart input file should contain:

*HEADING
*RESTART, READ
File : "scriptst1.txt"

#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G               # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !

module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR

rm -f testst1* testst2*
cd $SLURM_TMPDIR
while sleep 6h; do
   cp -f * $SLURM_SUBMIT_DIR 2>/dev/null
done &
WPID=$!
abaqus job=testst1 input=$SLURM_SUBMIT_DIR/mystd-sim.inp \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f * $SLURM_SUBMIT_DIR


To write restart data every N=12 time increments specify in the input file:

*RESTART, WRITE, OVERLAY, FREQUENCY=12

To write restart data for a total of 12 time increments specify instead:

*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO

To check the completed restart information do:

egrep -i "step|start" testst*.com testst*.msg testst*.sta
File : "scriptst2.txt"

#!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --cpus-per-task=4      # Specify number of cores
#SBATCH --mem=8G               # Specify total memory > 5G
#SBATCH --nodes=1              # Do not change !

module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR

rm -f testst2* testst1.lck
cp testst1* $SLURM_TMPDIR
cd $SLURM_TMPDIR
while sleep 3h; do
   cp -f testst2* $SLURM_SUBMIT_DIR 2>/dev/null
done &
WHILEPID=$!
abaqus job=testst2 oldjob=testst1 input=$SLURM_SUBMIT_DIR/mystd-sim-restart.inp \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f testst2* $SLURM_SUBMIT_DIR


The restart input file should contain:

*HEADING
*RESTART, READ

Multiple node computing[edit]

Users with large memory or compute needs (and correspondingly large licenses) can use the following script to perform mpi-based computing over an arbitrary range of nodes ideally left to the scheduler to automatically determine. A companion template script to perform restart multinode jobs is not currently provided due to additional limitations when they can be used.


File : "scriptsp1-mpi.txt"

!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
# SBATCH --nodes=2             # Best to leave commented
#SBATCH --ntasks=8             # Specify number of cores
#SBATCH --mem-per-cpu=16G      # Specify memory per core
#SBATCH --cpus-per-task=1      # Do not change !

module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"

rm -f testsp1-mpi*

unset hostlist
nodes="$(slurm_hl2hl.py --format MPIHOSTLIST | xargs)"
for i in `echo "$nodes" | xargs -n1 | uniq`; do hostlist=${hostlist}$(echo "['${i}',$(echo "$nodes" | xargs -n1 | grep $i | wc -l)],"); done
hostlist="$(echo "$hostlist" | sed 's/,$//g')"
mphostlist="mp_host_list=[$(echo "$hostlist")]"
export $mphostlist
echo "$mphostlist" > abaqus_v6.env

abaqus job=testsp1-mpi input=mystd-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_NTASKS interactive mp_mode=mpi


Explicit analysis[edit]

Abaqus solvers support thread-based and mpi-based parallelization. Scripts for each type are provided below for running explicit analysis type jobs on single or multiple nodes respectively. Template scripts to perform multinode job restarts are not currently provided pending further testing.

Single node computing[edit]

File : "scriptep1.txt"

#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change

module load abaqus/2021

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"

rm -f testep1* testep2*
abaqus job=testep1 input=myexp-sim.inp \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"


To write restart data for a total of 12 time increments specify in the input file:

*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO

Check for completed restart information in relevant output files:

egrep -i "step|restart" testep*.com testep*.msg testep*.sta
File : "scriptep2.txt"

#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change

module load abaqus/2021

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"

rm -f testep2* testep1.lck
for f in testep1*; do [[ -f ${f} ]] && cp -a "$f" "testep2${f#testep1}"; done
abaqus job=testep2 input=myexp-sim.inp recover \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"


No input file modifications are required to restart the analysis.

File : "scriptet1.txt"

#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change

module load abaqus/2021

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR

rm -f testet1* testet2*
cd $SLURM_TMPDIR
while sleep 6h; do
   cp -f * $SLURM_SUBMIT_DIR 2>/dev/null
done &
WPID=$!
abaqus job=testet1 input=$SLURM_SUBMIT_DIR/myexp-sim.inp \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f * $SLURM_SUBMIT_DIR


To write restart data for a total of 12 time increments specify in the input file:

*RESTART, WRITE, OVERLAY, NUMBER INTERVAL=12, TIME MARKS=NO

Check for completed restart information in relevant output files:

egrep -i "step|restart" testet*.com testet*.msg testet*.sta
File : "scriptet2.txt"

#!/bin/bash
#SBATCH --account=def-group    # specify account
#SBATCH --time=00-06:00        # days-hrs:mins
#SBATCH --mem=8000M            # node memory > 5G
#SBATCH --cpus-per-task=4      # number cores > 1
#SBATCH --nodes=1              # do not change

module load abaqus/2021

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"
echo "SLURM_SUBMIT_DIR =" $SLURM_SUBMIT_DIR
echo "SLURM_TMPDIR = " $SLURM_TMPDIR

rm -f testet2* testet1.lck
for f in testet1*; do cp -a "$f" $SLURM_TMPDIR/"testet2${f#testet1}"; done
cd $SLURM_TMPDIR
while sleep 3h; do
   cp -f * $SLURM_SUBMIT_DIR 2>/dev/null
done &
WPID=$!
abaqus job=testet2 input=$SLURM_SUBMIT_DIR/myexp-sim.inp recover \
   scratch=$SCRATCH cpus=$SLURM_CPUS_ON_NODE interactive \
   mp_mode=threads memory="$((${SLURM_MEM_PER_NODE}-3072))MB"
{ kill $WPID && wait $WPID; } 2>/dev/null
cp -f  * $SLURM_SUBMIT_DIR


No input file modifications are required to restart the analysis.


Multiple node computing[edit]

File : "scriptep1-mpi.txt"

!/bin/bash
#SBATCH --account=def-group    # Specify account
#SBATCH --time=00-06:00        # Specify days-hrs:mins
#SBATCH --ntasks=8             # Specify number of cores
#SBATCH --mem-per-cpu=16000M   # Specify memory per core
# SBATCH --nodes=2             # Specify number of nodes (optional)
#SBATCH --cpus-per-task=1      # Do not change !

module load StdEnv/2020        # Latest installed version
module load abaqus/2021        # Latest installed version

unset SLURM_GTIDS
export MPI_IC_ORDER='tcp'
# uncomment next line when using abaqus/2021
export I_MPI_HYDRA_TOPOLIB=ipl
echo "LM_LICENSE_FILE=$LM_LICENSE_FILE"
echo "ABAQUSLM_LICENSE_FILE=$ABAQUSLM_LICENSE_FILE"

rm -f testep1-mpi*

unset hostlist
nodes="$(slurm_hl2hl.py --format MPIHOSTLIST | xargs)"
for i in `echo "$nodes" | xargs -n1 | uniq`; do hostlist=${hostlist}$(echo "['${i}',$(echo "$nodes" | xargs -n1 | grep $i | wc -l)],"); done
hostlist="$(echo "$hostlist" | sed 's/,$//g')"
mphostlist="mp_host_list=[$(echo "$hostlist")]"
export $mphostlist
echo "$mphostlist" > abaqus_v6.env

abaqus job=testep1-mpi input=myexp-sim.inp \
  scratch=$SCRATCH cpus=$SLURM_NTASKS interactive mp_mode=mpi


Node memory[edit]

An estimate for the total slurm node memory (--mem=) required for a simulation to run fully in ram (without being virtualized to scratch disk) can be obtained by examining the Abaqus output test.dat file. For example, a simulation that requires a fairly large amount of memory might show:

                   M E M O R Y   E S T I M A T E
  
 PROCESS      FLOATING PT       MINIMUM MEMORY        MEMORY TO
              OPERATIONS           REQUIRED          MINIMIZE I/O
             PER ITERATION           (MB)               (MB)
  
     1          1.89E+14             3612              96345

To run your simulation interactively and monitor the memory consumption, do the following:
1) ssh into a cluster, obtain an allocation on a compute node (such as gra100), run abaqus ie.

[name@server ~]$ module load abaqus/6.14.1  OR  module load abaqus/2020
[name@server ~]$ unset SLURM_GTIDS


2) ssh into the cluster again, ssh into the compute node with the allocation, run top ie.

[name@server ~]$ ssh gra100
[name@server ~]$ top -u $USER


3) watch the VIRT and RES columns until steady peak memory values are observed

To completely satisfy the recommended "MEMORY TO OPERATIONS REQUIRED MINIMIZE I/O" (MRMIO) value, at least the same amount of non-swapped physical memory (RES) must be available to Abaqus. Since the RES will in general be less than the virtual memory (VIRT) by some relatively constant amount for a given simulation, it is necessary to slightly over-allocate the requested Slurm node memory -mem=. In the above sample Slurm script, this over-allocation has been hardcoded to a conservative value of 3072MB based on initial testing of the standard Abaqus solver. To avoid long queue wait times associated with large values of MRMIO, it may be worth investigating the simulation performance impact associated with reducing the RES memory that is made available to Abaqus significantly below the MRMIO. This can be done by lowering the -mem= value which in turn will set an artificially low value of memory= in the Abaqus command (found in the last line of the slurm script). In doing this one should be careful the RES does not dip below the MINIMUM MEMORY REQUIRED (MMR) otherwise Abaqus will exit due to Out of Memory (OOM). As an example, if your MRMIO is 96GB try running a series of short test jobs with #SBATCH --mem=8G, 16G, 32G, 64G until an acceptable minimal performance impact is found, noting that smaller values will result in increasingly larger scratch space used by temporary files.

Graphical use[edit]

Abaqus can be run interactively in graphical mode on a cluster or gra-vdi using VNC by following these steps:

On a cluster[edit]

1. Connect to a compute node (3hr salloc time limit) with TigerVNC
2. Open a new terminal window and enter the following

module load StdEnv/2020 abaqus/2021

3. Start the application with

abaqus cae -mesa

On gra-vdi[edit]

1. Connect to gra-vdi with TigerVNC

2. Open a new terminal window and enter one of the following:

module load CcEnv StdEnv/2016 abaqus/6.14.1 or
module load CcEnv StdEnv/2016 abaqus/2020 or
module load CcEnv StdEnv/2020 abaqus/2021

3. Start the application with

abaqus cae

For abaqus to start in gui mode must be at least one free cae license (not in use). The SHARCNET license has 2 free and 2 reserved licenses. If all 4 are in use according to:

[gra-vdi3:~] abaqus licensing lmstat -c $ABAQUSLM_LICENSE_FILE -a | grep "Users of cae"
Users of cae:  (Total of 4 licenses issued;  Total of 4 licenses in use)

Then the following error messages will occur when you attempt to start abaqus cae:

[gra-vdi3:~] abaqus cae
ABAQUSLM_LICENSE_FILE=27050@license3.sharcnet.ca
/opt/sharcnet/abaqus/2020/Commands/abaqus cae
No socket connection to license server manager.
Feature:       cae
License path:  27050@license3.sharcnet.ca:
FLEXnet Licensing error:-7,96
For further information, refer to the FLEXnet Licensing documentation,
or contact your local Abaqus representative.
Number of requested licenses: 1
Number of total licenses:     4
Number of licenses in use:    2
Number of available licenses: 2
Abaqus Error: Abaqus/CAE Kernel exited with an error.

Site-specific use[edit]

SHARCNET license[edit]

SHARCNET provides a small but free license consisting of 2 cae and 35 execute tokens where usage limits are imposed 10 tokens/user and 15 tokens/group. For groups that have purchased dedicated tokens, the free token usage limits are added to their reservation. The free tokens are available on a first come first serve basis and mainly intended for testing and light usage before deciding whether or not to purchase dedicated tokens. Costs for dedicated tokens (in 2021) were approximately CAD$110 per compute token and CAD$400 per GUI token: submit a ticket to request an official quote. The license can be used by any Alliance researcher, but only on SHARCNET hardware. Groups that purchase dedicated tokens to run on the SHARCNET license server may likewise only use them on SHARCNET hardware including gra-vdi (for running Abaqus in full graphical mode) and Graham or Dusky clusters (for submitting compute batch jobs to the queue). Before you can use the license you must contact Technical support and request access. In your email 1) mention that it is for use on SHARCNET systems and 2) include a copy/paste of the following License Agreement statement with your full name and username entered in the indicated locations. Please note that every user must do this it cannot be done one time only for a group; this includes PIs who have purchased their own dedicated tokens.

License agreement[edit]

----------------------------------------------------------------------------------
Subject: Abaqus SHARCNET Academic License User Agreement

This email is to confirm that i "_____________" with username "___________" will
only use “SIMULIA Academic Software” with tokens from the SHARCNET license server
for the following purposes:

1) on SHARCNET hardware where the software is already installed
2) in affiliation with a Canadian degree-granting academic institution
3) for education, institutional or instruction purposes and not for any commercial
   or contract-related purposes where results are not publishable
4) for experimental, theoretical and/or digital research work, undertaken primarily
   to acquire new knowledge of the underlying foundations of phenomena and observable
   facts, up to the point of proof-of-concept in a laboratory    
-----------------------------------------------------------------------------------

Configure license file[edit]

Configure your license file as follows, noting that it is only usable on SHARCNET systems: Graham, gra-vdi and Dusky.

[gra-login1:~] cat ~/.licenses/abaqus.lic
prepend_path("LM_LICENSE_FILE","27050@license3.sharcnet.ca")
prepend_path("ABAQUSLM_LICENSE_FILE","27050@license3.sharcnet.ca")

If your Abaqus jobs fail with the error message [*** ABAQUS/eliT_CheckLicense rank 0 terminated by signal 11 (Segmentation fault)] in the slurm output file, verify if your abaqus.lic file contains ABAQUSLM_LICENSE_FILE to use abaqus/2020. If your Abaqus jobs fail with an error message starting [License server machine is down or not responding, etc.] in the output file verify your abaqus.lic file contains LM_LICENSE_FILE to use abaqus/6.14.1 as shown. The abaqus.lic file shown contains both so you should not see this problem.

Query license server[edit]

Log into graham, load abaqus and then run one of the following:

ssh graham.alliancecan.ca
module load StdEnv/2020
module load abaqus

I) Check the SHARCNET license server for started and queued jobs:

abaqus licensing lmstat -c $LM_LICENSE_FILE -a | egrep "Users|start|queued"

II) Check the SHARCNET license server for started and queued jobs also showing reservations by purchasing groups:

abaqus licensing lmstat -c $LM_LICENSE_FILE -a | egrep "Users|start|queued|RESERVATION"

III) Check the SHARCNET license server for only cae, standard and explicit product availability:

abaqus licensing lmstat -c $LM_LICENSE_FILE -a | grep "Users of" | egrep "cae|standard|explicit"

When the output of query I) above indicates that a job for a particular username is queued this means the job has entered the "R"unning state from the perspective of squeue -j jobid or sacct -j jobid and is therefore idle on a compute node waiting for a license. This will have the same impact on your account priority as if the job were performing computations and consuming CPU time. Eventually when sufficient licenses come available the queued job will start. To demonstrate, the following shows the license server and queue output for the situation where a user submits two jobs, but only the first job acquires enough licenses to start:

[roberpj@dus241:~] sq
         JOBID     USER      ACCOUNT           NAME  ST  TIME_LEFT  NODES  CPUS  MIN_MEM  NODELIST (REASON) 
         29801  roberpj  def-roberpj  scriptep1.txt   R    2:59:18      1    12       8G   dus47 (None) 
         29802  roberpj  def-roberpj  scriptsp1.txt   R    2:59:33      1    12       8G   dus28 (None) 
[roberpj@dus241:~] abaqus licensing lmstat -c $LM_LICENSE_FILE -a | egrep "Users|start|queued|RESERVATION"
 Users of abaqus:  (Total of 78 licenses issued;  Total of 71 licenses in use)
     roberpj dus47 /dev/tty (v62.2) (license3.sharcnet.ca/27050 275), start Thu 8/27 5:45, 14 licenses
     roberpj dus28 /dev/tty (v62.2) (license3.sharcnet.ca/27050 729) queued for 14 licenses

Specify job resources[edit]

To ensure optimal usage of both your Abaqus tokens and our resources, it's important to carefully specify the required memory and ncpus in your Slurm script. The values can be determined by submitting a few short test jobs to the queue then checking their utilization. For completed jobs use seff JobNumber to show the total Memory Utilized and Memory Efficiency. If the Memory Efficiency is less than ~90%, decrease the value of the #SBATCH --mem= setting in your Slurm script accordingly. Notice that the seff JobNumber command also shows the total CPU (time) Utilized and CPU Efficiency. If the CPU Efficiency is less than ~90%, perform scaling tests to determine the optimal number of CPUs for optimal performance and then update the value of #SBATCH --cpus-per-task= in your Slurm script. For running jobs, use the srun --jobid=29821580 --pty top -d 5 -u $USER command to watch the %CPU, %MEM and RES for each Abaqus parent process on the compute node. The %CPU and %MEM columns display the percent usage relative to the total available on the node while the RES column shows the per process resident memory size (in human readable format for values over 1GB). Further information regarding how to monitor jobs is available on our documentation wiki

Core token mapping[edit]

TOKENS 5  6  7  8  10  12  14  16  19  21  25  28  34  38
CORES  1  2  3  4   6   8  12  16  24  32  48  64  96 128

where TOKENS = floor[5 X CORES^0.422]

Western license[edit]

The Western site license may only be used by Western researchers on hardware located at Western's campus. Currently, the Dusky cluster is the only system that satisfies these conditions. Graham and gra-vdi are excluded since they are located on Waterloo's campus. Contact the Western Abaqus license server administrator <jmilner@robarts.ca> to inquire about using the Western Abaqus license. You will need to provide your username and possibly make arrangements to purchase tokens. If you are granted access then you may proceed to configure your abaqus.lic file to point to the Western license server as follows:

Configure license file[edit]

Configure your license file as follows, noting that it is only usable on Dusky.

[dus241:~] cat .licenses/abaqus.lic
prepend_path("LM_LICENSE_FILE","27000@license4.sharcnet.ca")
prepend_path("ABAQUSLM_LICENSE_FILE","27000@license4.sharcnet.ca")

Once configured, submit your job as described in the Cluster job submission section above. If there are any problems submit a problem ticket to technical support. Specify that you are using the Abaqus Western license on dusky and provide the failed job number along with a paste of any error messages as applicable.

Online documentation[edit]

The full Abaqus documentation (latest version) can be accessed on gra-vdi as shown in the following steps.

Account preparation:

  1. connect to gra-vdi.computecanada.ca with tigervnc as described here
  2. open a terminal window on gra-vdi and type firefox (hit enter)
  3. in the address bar type about:config (hit enter) -> click the I accept the risk! button
  4. in the search bar type unique then double click privacy.file_unique_origin to change true to false

View documentation:

  1. connect to gra-vdi.computecanada.ca with tigervnc as described here
  2. open a terminal window on gra-vdi and type firefox (hit enter)
  3. in the search bar copy paste one of the following:
    file:///opt/sharcnet/abaqus/2020/doc/English/DSSIMULIA_Established.htm, or
    file:///opt/sharcnet/abaqus/2021/doc/English/DSSIMULIA_Established.htm
  4. find a topic by clicking for example: Abaqus -> Analysis -> Analysis Techniques -> Analysis Continuation Techniques