:orphan:

.. ****************************************************************************
.. CUI
..
.. The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
..
.. The use, dissemination or disclosure of data in this file is subject to
.. limitation or restriction. See accompanying README and LICENSE for details.
.. ****************************************************************************

Install Instructions
====================

This document describes how to install the AFSIM |release| suite of applications, data and tools.

.. contents::
   :local:

Packaging of AFSIM Distribution
-------------------------------

The AFSIM distribution described below is for the standard unclassified release from the USAF, and contains executables, scenarios, documentation and source code. The distribution file will be named AFSIM-|release|-\ *<system-name>*\ , where *<system-name>* may be e.g. ``win64`` or ``lnx64-gcc4``. You may also have downloaded or received a CD or other medium that contains distribution files named slightly differently, which may contain some or all of the standard release components.

There are two options for loading an AFSIM distribution onto your system. You may simply extract an archive file (**.zip** on Windows or **.tar.gz** on Linux), which will not modify the system registry, PATH, etc. or you may use one of the installers (**.msi** on Windows or **.rpm/.deb** on Linux). If extracting an archive, the unpacked directory tree will always contain a top-level directory, referred to below as *<archive-name>*.   

Unpacking the archive results in the directory tree:

::

   <archive-name>\bin           (contains the compiled executables and binaries)
   <archive-name>\demos         (contains example demos)
   <archive-name>\documentation (contains the documentation)
   <archive-name>\resources     (contains application resources, e.g. models and maps)
   <archive-name>\scenarios     (contains scenarios <optional>)
   <archive-name>\swdev         (contains the source code)
   <archive-name>\tools         (contains the analyst tools)
   <archive-name>\training      (contains the training)

Installing AFSIM results in the same directory tree, but paths are prefixed with *<install-path>*\ \\AFSIM-\ |release|.

Windows
-------

Zip
^^^

The distribution files are in standard 'zip' format. The contents may be extracted to the desired location using Windows Extractor, 7-Zip, WinZip or some other compatible program.

To remove AFSIM, simply delete the folder that was previously extracted, as no other system modifications were made.

MSI
^^^

The distribution files are in standard **Windows Installer (MSI)** format. The contents may be installed by double clicking the MSI file in a file manager or by executing from the command line to begin the installation. Continue with selecting installation options as follows:

#. Welcome dialog, click **Next** to continue...

   .. image:: ../images/msi_opening_dialog.png

#. End-User License Agreement, click "I accept the terms in the License Agreement" then click **Next** to continue...

   .. image:: ../images/msi_eula_dialog.png

#. Choose whether to add AFSIM to the PATH environment variable, for the system or the current user only, and click **Next** to continue...

   .. image:: ../images/msi_options_dialog.png

#. Customize the features that will be installed and choose the install location if different than the default. Click **Next** to continue...

   .. image:: ../images/msi_setup_dialog.png

#. Click **Install** to begin installation with the previously selected options and setup...

   .. image:: ../images/msi_install_dialog.png

#. Progress dialog and status will show during installation.

   .. image:: ../images/msi_installing_dialog.png

#. Upon completion, click **Finish** to exit the Setup Wizard and begin using AFSIM. 

   .. image:: ../images/msi_complete_dialog.png
   
To uninstall go to **Add or Remove Programs** from the Windows Control Panel, find AFSIM |release| in the application list, and select Uninstall.

Linux
-----

Tarball
^^^^^^^

To extract the standard release, open a terminal window, change the directory to the desired location, and extract the contents of the archive:

.. parsed-literal::

   $ cd <path>
   $ tar -xzf AFSIM-|release|-lnx64-gcc4.tar.gz

To uninstall the package, simply delete the folder that was previously extracted, as no other system modifications were made.

RPM
^^^

To install the standard release, open a terminal window, change the directory to where the RPM file is located and install the package to /opt/afsim-\ |release| directory:

For a new install:

.. parsed-literal::

   $ cd <path>
   $ rpm -ivh AFSIM-|release|-lnx64-gcc4.rpm

For an upgrade install:

.. parsed-literal::

   $ cd <path>
   $ rpm -Uvh AFSIM-|release|-lnx64-gcc4.rpm

To uninstall the standard release, open a terminal window and uninstall the package.

::

   $ rpm -ev afsim

DEB
^^^

To install the standard release, open a terminal window, change the directory to where the DEB file is located and install the package to /opt/afsim-\ |release| directory:

.. parsed-literal::

   $ cd <path>
   $ dpkg -i AFSIM-|release|-lnx64-gcc4.deb

To uninstall the standard release, open a terminal window and uninstall the package.

::

   $ dpkg -r afsim