Skip to content

Commit

Permalink
Merge pull request #28 from flindersuni/feature/ansys-matlab
Browse files Browse the repository at this point in the history 
ANSYS CLI & Matlab Quick-Guide
  • Loading branch information
@The-Scott-Flinders
The-Scott-Flinders committed Dec 6, 2021
2 parents a31e33d + 39616e9 commit 26b4836
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 2 deletions.
94 changes: 93 additions & 1 deletion docs/source/software/ansys.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ ANSYS Engineering Suite
=======
Status
=======
Currently Under Development. Contact the HPC Support Team for more information.
ANSYS 2021R2 is the current version of the ANSYS Suite installed on the HPC.

Development on tighter Graphical User Interfaces is currently under investigation.


==========
Overview
Expand All @@ -13,3 +16,92 @@ The ANSYS Engineering Suite is a comprehensive software suite for engineering si
The new HPC ANSYS integration aims to bring the Remote Solver Manager to DeepThought - allowing
users to leverage the HPC from their desktops and familiar ANSYS interface.


=================
Known Issues
=================
The Intel MPI Library shipped with ANSYS is not 100% compatible with DeepThought. Running with the -smp flag will disable MPI and allow you to run ANSYS as normal on a single node.


================================
Quickstart Command Line Guide
================================

To run a job with ANSYS on the HPC you will need the following:
- A ANSYS Script file
- Ay 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.

You can then invoke ANSYS (after loading the ANSYS Module) in 'batch' mode for a single script like so:

- ansys212 -smp -np <CPUS> -b -s -R PATH_TO_SCRIPT_FILE
- ansys212 -smp -np <CPUS> -bd <DB File Memory Allocation> -m <SLURM Memory Allocation> -b -s < PATH_TO_SCRIPT_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 |
+-------------------+---------------------------------------+
| -np | Specify the Number of CPU's |
+-------------------+---------------------------------------+
| -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. |
+-------------------+---------------------------------------+
| -R /path/ | Script file Path for batch Mode |
+-------------------+---------------------------------------+


+++++++++++++++++++++++++
ANSYS Program Quick List
+++++++++++++++++++++++++
The following table lists the ANSYS programs and their associated CLI command


+-------------------+---------------------------------------+
| Program | Name |
+===================+=======================================+
| Mechanical ADPL | ansys212, ansys2021R2 |
+-------------------+---------------------------------------+
| Workbench | runwb2 |
+-------------------+---------------------------------------+
| CFX | cfx5 |
+-------------------+---------------------------------------+
| FLUENT | fluent |
+-------------------+---------------------------------------+
| ICEM CFD | icemcfd |
+-------------------+---------------------------------------+
| POLYFLOW | polyman |
+-------------------+---------------------------------------+
| CFD-Post | cfdpost |
+-------------------+---------------------------------------+
| Icepak | icepak |
+-------------------+---------------------------------------+
| TurboGrid | cfxtg |
+-------------------+---------------------------------------+
| AUTODYN | autodyn212 |
+-------------------+---------------------------------------+


19 changes: 18 additions & 1 deletion docs/source/software/matlab.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ Mathworks MATLAB
=======
Status
=======
Currently Under Development. Contact the HPC Support Team for more information.
Matlab 2020b is the currently installed version on the HPC.

investigation is under way to enable tighter GUI integration and better workload management.


.. MathWorks MATLAB: https://au.mathworks.com/
Expand All @@ -16,3 +19,17 @@ Overview
Parallel Server, the new MATLAB Integration will enable the full power of DeepThought
and a greatly enhanced user experience.


======================================
MATLAB Quickstart Command Line Guide
======================================

To run a job with MATLAB on the HPC you will need the following:
- A MATLAB Script file
- Any Datasets (eg, a .csv)

Ensure that the paths to anything in the script file reflect where it lives on the HPC, not your local machine.

You can then invoke MATLAB (after loading the MATLAB Module) like so:

- matlab -r _PATH_TO_SCRIPT_FILE

0 comments on commit 26b4836

Please sign in to comment.