Skip to content

Commit

Permalink
ANSYS CLI Update & Spelling Pass
Browse files Browse the repository at this point in the history
  • Loading branch information
@The-Scott-Flinders
The-Scott-Flinders committed Feb 23, 2022
1 parent 1895ea1 commit fe52cbc
Showing 1 changed file with 46 additions and 39 deletions.
85 changes: 46 additions & 39 deletions docs/source/software/ansys.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ANSYS Engineering Suite
=======
Status
=======
ANSYS 2021R2 is the current version of the ANSYS Suite installed on the HPC. Both Single-Node (-smp) and Multi-Node (-dis) execution is supported.
ANSYS 2021R2 is the current version of the ANSYS Suite installed on the HPC. Both Single-Node (-smp) and Multi-Node (-dis) execution is supported as well as GPU acceleration.


.. _ANSYS: https://www.ansys.com/
Expand All @@ -23,56 +23,63 @@ To run a job with ANSYS on the HPC you will need the following:
- An ANSYS Script file
- Any reference file(s) (eg, a .db file)

Ensure that the paths to anything in the script file reflect where it lives on the HPC, not your local machine.
Ensure that the paths to anything in the script file reflect where it lives on the HPC, not your local machine. Below are some exmaple command-line examples to get you started.

You can then invoke ANSYS (after loading the ANSYS Module) in 'batch' mode for a single script like so:
Replace all <OPTIONS> to suit your requirements.

1. Single-Node (Single-Node)
1. Shared-Memory Parallel (Single-Node)
``ansys212 -smp -np $SLURM_NTASKS -db <DB File Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_FILE > PATH_TO_OUTPUT_FILE``

2. Distributed Mode (Multi-Node)
``ansys212 -dis -np $SLURM_NTASKS -db <DB FILE Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_FILE > PATH_TO_OUTPUT_FILE``

- ansys212 -smp -np <CPUS> -bd <DB File Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_FILE
2. Distributed Mode (Multi-Node)
3. Hybrid Distributed Mode (Multi-Node Shared-Memory Parallel)
``ansys212 -dis -np $SLURM_NTASKS -nt $SLURM_CPUS_PER_TASK -db <DB FILE Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_FILE > PATH_TO_OUTPUT_FILE``


- ansys212 -dis -np <CPUS> -bd <DB FILE Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_FILE > PATH_TO_OUTPUT_FILE
4. GPU Hybrid Distributed Mode (Multi-Node Shared-Memory Parallel with GPU Acceleration)
``ansys212 -dis -np $SLURM_NTASKS -nt $SLURM_CPUS_PER_TASK -acc nvidia -na <GPU_COUNT> -db <DB FILE Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_FILE > PATH_TO_OUTPUT_FILE``

+++++++++++++++++++++++
ANSYS CLI Quick List
+++++++++++++++++++++++
The following is a quick list of some of the common CLI options.


+-------------------+--------------------------------------------+
| CLI Option | Description |
+===================+============================================+
| -acc nvidia | Enable GPU Compute Acceleration |
+-------------------+--------------------------------------------+
| -dis | Run ANSYS in Distributed (Multi-Node) Mode |
+-------------------+--------------------------------------------+
| \-np value | Specify the Number of CPU's: -np 12 |
+-------------------+--------------------------------------------+
| -smp | Run ANSYS in Single-Node Mode |
+-------------------+--------------------------------------------+
| -g | Start the Graphical User interface |
+-------------------+--------------------------------------------+
| -b | Enable ANSYS Batch mode. Needs -s. |
+-------------------+--------------------------------------------+
| -i | Full Input file path |
+-------------------+--------------------------------------------+
| -o | Full Output File Path |
+-------------------+--------------------------------------------+
| -s | Read the Ansys Startup Script |
+-------------------+--------------------------------------------+
| -dir /path | The Working Diretory of ANSYS |
+-------------------+--------------------------------------------+
| -db | Initial Allocation for the .DB File |
+-------------------+--------------------------------------------+
| \-m value | RAM Allocation for ANSYS. -m 40000 |
+-------------------+--------------------------------------------+
| \< /path/ | Script file Path for batch Mode |
+-------------------+--------------------------------------------+
| \> /path/file.out | Path to store ANSYS Output to file |
+-------------------+--------------------------------------------+
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| CLI Option | Description |
+===================+====================================================================================================================+
| -acc nvidia | Enable GPU Compute Acceleration |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| \-na value | The number GPU per Compute Node ANSYS should use. Current Max: 2 |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -dis | Run ANSYS in Distributed (Multi-Node) Mode |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| \-np value | In SMP mode, specify the number of CPU's to use. In Distributed/Hybrid mode, specify the number of Tasks/Processes |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| \-nt value | Specify the number of threads per process in Hybrid mode |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -smp | Run ANSYS in Single-Node Mode |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -g | Start the Graphical User interface |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -b | Enable ANSYS Batch mode. Needs -s. |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -i | Full Input file path |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -o | Full Output File Path |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -s | Read the Ansys Start-up Script |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -dir /path | The Working Directory of ANSYS |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| -db | Initial Allocation for the ANSYS .db file. Can be omitted. |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| \-m value | RAM Allocation for ANSYS, in MB. Can be omitted. |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| \< /path/ | Script file Path for batch Mode |
+-------------------+--------------------------------------------------------------------------------------------------------------------+
| \> /path/file.out | Path to store ANSYS Output to file |
+-------------------+--------------------------------------------------------------------------------------------------------------------+


+++++++++++++++++++++++++
Expand Down

0 comments on commit fe52cbc

Please sign in to comment.