Personal tools
You are here: Home → Documentation → Install Guide
Document Actions

Install Guide

Install guide for Adun (v 0.72+) on Linux/Unix systems.


Contents



    Note this document is only for installing from source on linux. If you are installing on a mac you should use the automatic installer package.


Requirements


    Adun requires a few libraries so it can be installed. Unfortunately we cannot be exhaustive here. If you have trouble installing these packages the best place to look is the relevant webpages.

Objective-C Compiler


The Objective-C part of gcc must be present for Adun (aswell as gnustep-core) to be installed. The full gcc package includes this automatically but many distro installs leave it out. If its isn't present you need to install the libobjc library  and the Objective-C headers. The rpm packages for these will be called libobjc-xxxx.rpm and gcc-obj-xxxx.rpm, where xxxx is your gcc version (gcc --version to find out). You can often find these on the cd used to install your linux distribution. If not try rpmfind.net etc. or your relevant distribution package repository.

GNUstep Libraries


    Important!  Adun requires the core library versions included with gnustep-startup 0.16.1 or later - (gnustep-startup-0.18 preferred).

    The easiest way to install the GNUstep libraries is to use the gnustep-startup binary package. Information on the package is available here. For a direct download click here. Installation instructions are provided with the downloaded package - see the file INSTALL in the source directory.  ( If you want more control over the installation you can also choose to install all the libraries independantly following the gnustep build guide.)

  • note: Using synaptic or apt-get will automatically install the objc compiler mentioned below
  • note: After installing these packages it is important to source the GNUstep shell script. The gnustep-startup package will inform you of this and any other necessary steps when its finished. If you did not use gnustep-startup see the gnustep build guide for instructions.

GSL


GSL is a scientific library that Adun utilises to perform various calculations. It can be downloaded here.

  • If you build GSL from source it is installed by default into /usr/local/lib. This directory is not usually in the library path  so you have to add it manually. There are two ways to do this
    • "export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib" 
      • This is for the bash shell. You should add this line to your shell login file (for bash .bash_profile or .bashrc)
    • as root run "ldconfig /usr/local/lib" after you have installed gsl.


Optional Packages


    Adun can also benefit from the following packages -   

  • Doxygen - builds documentation on the program. Extremely useful for developers

  • icc - the Intel C-compiler. You can use icc to compile the Adun Base library. This can result in a significant speed boost.

    Go here for links to all mentioned packages.

      Installing From Source


          N.B. - You must have sourced the Gnustep installation script  (usually at  /usr/GNUstep/System/Library/Makefiles/GNUstep.sh ) before installation. If you change to root to install you'll most likely have to source it again.

          Once the above libraries are present installing Adun is easy.  This section concentrates on building Adun from source. All steps are performed as your normal user. (Note: for RPMS see the relevant section below) -

              1. Install the main program.

                • In the untared Adun source directory type "make debug=No"

                • If you are using gnustep-make 2.0 (this implies gnustep-startup-0.18 or greater)

                  • type "make install"

                • If you are using a previous version of gnustep-make

                  • type "make install GNUSTEP_INSTALLATION_DIR=$GNUSTEP_USER_ROOT

                • At this point you can start Adun ("openapp UL" or "openapp UL.app") and run simulations - see the quickstart guide.

                • However to perform analysis on the results you need to complete step 2. To use the ResultsConverter tool step 3 must be completed.

              2. Install the Tools

                • cd to the Tools directory and "make install"

                • Note: In order for the Tools to work the next step must be completed.

              3. Install the Plugins

                • To install the plugins you have to run Adun at least once.

                • Once Adun has been run once, cd to the Plugins directory and type "make".

                • NB - Thats just "make" not "make install"

              Thats it. Adun is installed and ready to use. See the Quickstart Guide for a fast overview on how to use the program and its main features.


              Installing To Other Locations


              Note: This section assumes gnustep-make 2.0 is being used.

              By default Adun is installed into $(HOME)/GNUstep. To change this behaviour use -

              • make installl GNUSTEP_INSTALLATION_DOMAIN=$(domain)

              in steps 1 & 2.  Specifiying LOCAL for $(domain) will install Adun globally.

              However Adun assumes two of its components, AdunCore and AdunServer, are installed in the users home directory, so it must be told where the new executables are. To do this each user must run the following commands,
              • defaults set AdunServer AdunCorePath  $(PATH_TO_ADUN_CORE_EXECUTABLE) 
              • defaults set  UL AdunServerPath  $(PATH_TO_ADUN_SERVER_EXECUTABLE) 

              If you used LOCAL they will be in $GNUSTEP_LOCAL_ROOT/Tools.

              Currently plugins must be installed per-user. So each user must complete step 3 above individually.

              Uninstalling


                  If you want to uninstall Adun repeat steps 1 & 3 above but replace "install" with "uninstall".  To remove a plugin simply remove the folder with the corresponding name from adun/Plugins/Analyse.

              RPMS


              Note: No rpms are available yet  we're working on it.

                  For those who have never used an rpm before heres the simplest way to do it.
              1. Download the rpm closest to your distribution
              2. Type "su". You'll need the root password.
              3. Type "rpm -ivh name_of_the_rpm_here"
              RPMS can be quite fickle sometimes. If it wont install the best thing to do is install from source.


              Comments

                 
                                If you have any question or comments on installing Adun please use the "add Comment" button below. Comments on using specific package managers (apt-get, yum, synaptic etc) to ease the install process are especially welcome.
               
              Powered by Plone