Example: The NATIVE driver for Windows HPC

To launch a study on a Windows HPC cluster, you must use the AMEHPCStudyStart.bat script.

The following example shows a command launching a batch study on Windows using the NATIVE driver and Microsoft MPI as a remote shell (for details on Microsoft MPI setup see section Configuring a Windows platform for MPI). The HPC cluster nodes must be directly accessible on the network, therefore the following commands can typically be executed from one of the compute nodes. In a cmd shell:

Copy

set AME_HPC_PYTHON=%AME%\AMEPython.bat
cd /D %AME%\scripting\python\hpc
.\AMEHPCStudyStart.bat --driver NATIVE 
                       --remote-shell mpi
                       --machinefile Path\To\Machinefile.txt
                       --jobspernode 8
                       --dirmodel Path\To\InputModelsDirectory
                       --model AmesimModelFileName.ame
                       --wdir  Path\To\Output\Study\Directory     
                       --type batch    
                       --amepath %AME%
                       --compiler gcc64
                       --env SPLM_LICENSE_SERVER=PortNumber@Server
                       --env SC1D_LICENSING_TYPE=ugs

The command above launches a batch study using 8 jobs per compute node on the model AmesimModelFileName.ame that is located in the Path\To\InputModelsDirectory directory. The model is compiled using the gcc64 compiler and results are written in the Path\To\Output\Study\Directory directory (that must be shared between all compute nodes).

Using the NATIVE driver, the remote shell parameter is for now mandatory on Windows as only mpi is supported as explained in the section The NATIVE Driver. Furthermore, the path to the machinefile containing the compute node names must be provided to the NATIVE driver. The rest of the parameters are similar on Windows and Linux and are given to provide a minimal example. Refer to the full command line documentation provided in section AMEHPCStudystart for more details.

Note

The example considers that the AME environment variable is defined on all compute nodes and points to the Simcenter Amesim installation directory in the HPC cluster. The AME_HPC_PYTHON environment variable must be defined in the launch process only, before calling the AMEHPCStudyStart.bat script.