Supported platforms
-------------------
SimDiff Linux is supported on CentOS, RedHat, and Ubuntu.


If you require SimDiff to run on an platform or architecture that is
not listed above, please contact support@ensoftcorp.com for assistance.


Prerequisites
-------------
The required, recommended, and optional prerequisites for SimDiff are listed
here, along with an explanation of how SimDiff uses each one.  Except for
MATLAB + Simulink, all prerequisites are free and open source.

[Required]
* GLIBC:  SimDiff includes some native code (.so libraries) that require a
  GLIBC version of 2.12 or higher

* Shell:  SimDiff is launched using a shell script.  'bash' is recommended, but
  any shell compatible with '/bin/sh' should work

[Recommended]
* MATLAB + Simulink:  A basic model comparison can be done without Simulink,
  but it is required for some of the more advanced operations.  SimDiff Linux
  supports MATLAB R2008a and higher.

* csh:  Required for SimDiff to be able to connect to MATLAB.  Must be located
  at '/bin/csh'.  See Mathworks documentation for details:
  
      https://www.mathworks.com/help/matlab/matlab_external/introducing-matlab-engine.html
    
* wmctrl:  Used to reposition Simulink windows to make it easier to visualize
  differences

[Optional]
* xdg-utils:  SimDiff may need this on some older releases and uncommon
  platforms in order to open files and web links outside of SimDiff


Installation
------------
1. Unpacking

To install SimDiff, simply change to the directory in which you want to install
SimDiff, then execute the following command below, where "/path/to/" is the
path to the .tar.gz installation file.  For example, for 2024a:

	tar xzf /path/to/SimDiff-2024a-install-linux64.tar.gz

This will create a "simdiff" subdirectory containing the complete SimDiff
installation.

2. Environment

It is recommended to add the 'simdiff' directory to your system PATH.
Otherwise, it is possible for the integration with MATLAB/Simulink to fail.

The instructions for adding a program to the system path varies by shell.  For
the 'bash' shell, it is done by editing the file '.bash_profile' in your home
directory, as shown below.  Note that the line starting with "PATH=" has been
modified to include the full path to SimDiff.

Original .bash_profile:

		...
		# User specific environment and startup programs
		
		PATH=$PATH:$HOME/bin
		
		export PATH
		...

After installing SimDiff:

		...
		# User specific environment and startup programs
		
		PATH=/path/to/simdiff:$PATH:$HOME/bin
		
		export PATH
		...


Disable SELinux
---------------
To run SimDiff, you may need to disable SELinux.  To disable SELinux for the
current session, execute the following command with root permissions:
	/usr/sbin/setenforce

To disable SELinux permanently for all login sessions, edit /etc/selinux/config
with root permissions, changing the "SELINUX=enforcing" line to 
"SELINUX=disabled"
