2. Installation

2.1 How to obtain ADiMat

For academic, research, private or testing purposes, ADiMat is available free of charge. Binary versions are released routinely for Windows and Linux for download on the ADiMat server. MacOS users can use the Linux version in combination with the source code package of adimat-client. Users of other Unix versions like Solaris should be able to do the same.

2.2 Requirements

ADiMat was successfully used on:

• Windows
• Linux
• MacOS
• Solaris

Currently not all features are available in the Windows version. The mex-compiled derivative class mex_derivclass is not available on Windows.

ADiMat version 0.5.6 and higher uses the OpenSSL library to contact the transformation server. The Linux packages of ADiMat are compiled on Debian stable, thus they should run on most common Linux distributions. However, there are also statically linked packages, i.e. all required library code is in the executable. The Windows packages of ADiMat are statically linked.

Matlab or GNU Octave is needed to run the differentiated code.

2.3 Installation on Linux or Unix systems

1. Unpack the download archive. A directory called adimat-0.6.8-5613-GNU_Linux-i686 (32 Bit version) or adimat-0.6.8-5613-GNU_Linux-x86_64 (64 Bit version) is created. This is the ADiMat home directory. Before you proceed with the following steps, you may rename or move this directory as you like, for example to /opt/adimat.

2. Within Matlab (or Octave), navigate to the directory where you installed ADiMat, which contains this file (Install.txt). Execute the following command:

   ADiMat_startup
   

   This adds several directories of ADiMat to the path, and also sets the environment variable $ADIMAT_HOME. You probably wish to make this change permanent, to do this, execute ADiMat_startup from your startup.m (Matlab) or ~/.octaverc (Octave). For example add this line:

   run('/opt/adimat/ADiMat_startup');
   

1. Create an environment variable, ADIMAT_HOME, that contains the path to the ADiMat home directory. To do this, in your shell (sh, bash, or zsh) execute this command:

   export ADIMAT_HOME=/opt/adimat
   

   Add this line to your shell's startup file, e.g. ~/.bashrc, to set it at startup time.

2. You should also set your PATH variable to include $ADIMAT_HOME/bin, which you do by typing something like this in your ~/.bashrc

   export PATH=$PATH:$ADIMAT_HOME/bin
   

   Optionally, also set

   INFOPATH=$INFOPATH:$ADIMAT_HOME/share/doc/adimat
   

   to read this documentation in the info pager.

For any questions feel free to contact us via the ADiMat Users mailing list.

In order to build and install ADiMat from the sources, read the file BUILD in the base directory of the ADiMat source distribution.

2.4 Installation on Windows

1. Unpack the download archive. A directory called adimat-0.6.8-5613-mingw32-i686 is created. This is the ADiMat home directory. Before you proceed with the following steps, you are free to rename or move this directory as you like, for example to c:/adimat.

2. Within Matlab (or Octave), navigate to the directory where you installed ADiMat, which contains this file (Install.txt). Execute the following command:

   ADiMat_startup
   

   This adds several directories of ADiMat to the path, and also sets the environment variable $ADIMAT_HOME. You probably wish to make this change permanent, to do this, execute ADiMat_startup from your startup.m (Matlab) or ~/.octaverc (Octave). For example add this line:

   run('c:/adimat/ADiMat_startup');
   

1. Create an environment variable, ADIMAT_HOME, that contains the path to the ADiMat home directory. In the control panel, add the environment variable ADIMAT_HOME, for example with the value c:/adimat.

2. Also, you should also set your PATH variable to include %ADIMAT_HOME%\bin.

For any questions feel free to contact us via the ADiMat Users mailing list.

In order to build and install ADiMat from the sources, read the file BUILD in the base directory of the ADiMat source distribution.

2.5 Building and installation on MacOS

Users of MacOS should please proceed to install the Linux version first. There is only one binary program in the distribution, adimat-client, which will not work on MacOS. This must be replaced by compiling the adimat-client package from source on the MacOS system.

1. Download the adimat-client source package, adimat-client-0.6.8-5613-src.tar.gz from the download page.

2. Unpack the download archive in some temporary working directory. A directory called adimat-client-0.6.8-5613-src is created.

3. Install required software. To compile adimat-client you need the following third-party software:

   1. The autoconf and automake tools. See the reference section and this blog post
   2. The tool gengetopt. See the gengetopt home page
   3. The OpenSSL library and headers
   4. The libxml2 library and headers

4. Execute the bootstrap script, which runs the various autotools.

   ./bootstrap
   

5. Run configure, setting the prefix to your ADIMAT_HOME.

   ./configure --prefix=$ADIMAT_HOME
   

   You can use the options --with-openssl and --with-libxml2 to specify the location of the required libraries.

6. Run make and make install

   make
   make install
   

That's it! You should now have a new adimat-client binary in $ADIMAT_HOME/bin. For any questions feel free to contact us via the ADiMat Users mailing list.