XSim Installation Instructions

These are instructions on installing the XSim product. Please see the XSim System Requirements first to make sure your system meets the requirements.

Windows XSim Software Installation

The XSim distribution package for 64bit Windows is a self-extracting executable installer. Invoke the installer by double clicking on it. The default installation path is:

C:\Program Files\Tech-X\XSim-1.0 (Windows 64-bit)

which includes the major & minor version of your software. To open the XSim software, go to the Start Menu, click on the Tech-X folder, click on XSim-1.0, then click on XSimComposer. See Fig. 2.

Fig. 2 Dialogs for Windows installation

Workaround for some Windows App Blocking

Some Windows Operating Systems are configured to only allow installation of applications acquired through the Windows store. If you find this to be the case right click the installer , select properties and check the Unblock box

Fig. 3 Windows app unblocking

Alternatively if Applications not from the Windows Store are blocked take the following steps.

1. Open Settings and click Apps

2. Select the option to allow Windows 10 to Allow apps from anywhere

Windows XSim Software Installation on a Network Share

These instructions outline how to install XSim to a shared network location. This method will allow users from multiple machines to access and run this installation of XSim on their local machines.

To start, ensure that you have the shared network location that you want to install to. It is easy to find instructions on how to set up network file sharing on Windows, but the quick steps for Windows 10 are:

1. Open Windows File Explorer.

2. Navigate to the folder you wish to share.

3. Right-click the item and choose Properties.

4. In the Properties dialog click the Sharing tab.

5. Click the Share button.

6. In the Network access dialog, choose the people on your network to share the folder with and click the Share button.

7. In the next frame of the Network access dialog, note the names in the Individual Items list. There will be the name you assigned it in step (6) and the UNC (Unified Naming Convention) Path of the shared directory, which will have the form \MACHINEpathtoshareddirectory.

8. Click the Done button in the Network access dialog.

9. At this point you can change the UNC Path to a single string by clicking the Advanced Sharing… button and then clicking the Share checkbox and typing a string.

10. Click Close in the Properties dialog.

Now that this folder is accessible, install to the folder by following the Windows Installation instructions above. When you get to the “Choose Install Location” step, type in the shared location as your installation location or click the Browse button and navigate to it. Note that you first go to the Network machine in the left pane (not This PC) and then you navigate down in directories according to the UNC Shared Path. One can install XSim from the machine where the folder is shared from, or from another machine that has access to the shared folder.

When running XSim from a network location, one can map the UNC Shared Path to a network drive on any machine that has access to the path. To do this from Windows Explorer on the machine where XSim will be run, navigate to the second to last folder in the UNC Shared Path, right-click on the icon for the last folder, and select the Map Network Drive menu item. At this time you will be prompted to select a drive letter and can change a couple settings. After making your choices press Finish.

For a concrete example, say we have the follow values:

- Installation Computer Name = JANESCOMPUTER
- Shared Folder = C:\Users\jane\Documents\myshare
  (shared on JACKSCOMPUTER)
- Folder UNC Shared Path = \\JANESCOMPUTER\jane  (note here Jane
  has chosen the advanced option of a single name "jane" to represent
  the full path of \Users\jane\Documents\myshare)
- XSim installation Folder = C:\Users\jane\Documents\myshare\XSim
- Mapped Network Drive on JACKSCOMPUTER = S:\

So, for this example, the drive S:\ will show up on JACKSCOMPUTER and is mapped to \JANESCOMPUTER\jane which is a share name for C:\Users\jane\Documents\myshare on JANESCOMPUTER. So, Jack should see S:\XSim as the installation location for XSim and he can conveniently run XSimComposer by double-clicking

S:\XSim\Contents\bin\XSimComposer.exe

Finally, to ensure all users have access to the license, the license should be copied to the Contents\engine\bin subdirectory next to the Vorpal engine. So, in our example, this would be on JANESCOMPUTER at the location:

C:\Users\jane\Documents\myshare\XSim\Contents\engine\bin\license.txt

inside the original installation of XSim. This is best done by using Windows Explorer rather than adding the license using the XSimComposer settings.

Windows Cluster XSim Software Installation

There are a few extra steps when installing on a Windows Cluster and we detail them here. XSim will work on a Windows cluster that uses Microsoft HPC Pack (Version 2012 R2 or later is required).

First, install XSim on the cluster headnode using the instructions above in the Network Share Section. The cluster license file will need to be copied into the correct location as described above and it will need to refer to the correct shared directory – normally a good choice for this directory would be a subdirectory of the UNC Shared Path alongside the XSim installation.

For operation on a Windows Cluster it is crucial to use the MPI that comes with Microsft HPC Pack. So, we must set aside the MPI that is distributed with XSim. Using the exmaple from the Network Share Section above, one would open a Command Prompt and execute the following commands:

S:\>cd XSim\Contents\engine\bin
S:\XSim\Contents\engine\bin>move mpiexec.exe mpiexecOFF.exe
      1 file(s) moved.
S:\XSim\Contents\engine\bin>move msmpi.dll msmpiOFF.dll
      1 file(s) moved.

This will ensure that the mpiexec.exe in the PATH variable will be the one on the system. This can be verified by the following:

S:\XSim\Contents\engine\bin>where mpiexec.exe
C:\Program Files\Microsoft MPI\Bin\mpiexec.exe

This completes the installation and now it can be tested using the “Running Vorpal on a Windows HPC Cluster” section of the User Guide.

Now (also following the exmaple in the Network Share Section above), Jack can use XSimComposer to create a simulation directory (say mysim) in the shared folder, for example:

S:\jack\simulations\mysim

This directory and, therefore, the simulation input will then be available to all the nodes on the cluster when a job is submitted.

Linux XSim Software Installation

The XSim distribution package for Linux is a gzipped tarball. Unpack the gzipped tarball into the directory in which you wish to install XSim. A typical location would be

/usr/local/XSim-1.0

The unzip and untar command is

$ cd /usr/local
$ tar xf XSim-1.0-Linux64.tar.gz

Or, if your Linux machine does not have OpenGL rendering support then you may want to install the “offscreen” version, in which case the file would be “XSim-11.0.0-Linux64-offscreen.tar.gz. After untarring, the user interface is started with the command:

$ cd XSim-1.0
$ ./XSimComposer.sh

If you plan to run the simulation engine or any other executable from the command-line then you will need to source the startup script:

$ source /usr/local/XSim-1.0/XSimComposer.sh
<execute engine, analyzers, etc.>

See the “Running Vorpal from the Command Line” section in the User Guide for more instructions. on command-line operations.

Mac OS X XSim Software Installation

Unpacking the DMG file:

The XSim distribution package for Mac OS X is a .dmg installer. Invoke the installer by double clicking on it. Drag the XSim-1.0 folder into your Applications folder (visible in the installer window). From the Application folder, double click on the XSimComposer icon in the XSim-1.0 folder. See Fig. 4. This default installation path is:

/Applications/XSim-1.0

Fig. 4 Dialog for the Mac installer

Workaround for signing issues:

As of El Capitan, Apple instituted GateKeeper, which by default prevents one from executing an unsigned application. The symptom can range from inability to install a license to being told the application is damaged as shown in Fig. 5.

Fig. 5 Warning that XSimComposer is damaged, put up by GateKeeper when code signing is not properly recognized.

If you are experiencing this, then close XSimComposer and open an XTerm and run the commands:

$ cd /Applications    # or wherever one has installed XSim-1.0
$ xattr -rd com.apple.quarantine XSim-1.0

Then reopen XSimComposer – the message should be gone.