Installation and quick start

Quick start
A quick start guide.

Detailed installation instructions
Installation instruction for special system requirements.

Quick start

To quickly get a working copy of PACLib follow these instructions.

Set some environment variables.
Execute the following commands. You may also add these lines to your .tcshrc file (Solaris) or maybe your .bashrc file (Linux). You do not need to set CVSROOT if you download a release version of PACLib.
Here is the .tcshrc file version:
```
	# PACLib settings...
	setenv PAC_HOME          $HOME/PACLib
	setenv PAC_MODULEPATH    $PAC_HOME/lib
	setenv PAC_CXXFLAGS      -DPAC_DEBUG
	setenv PKG_CONFIG_PATH   $PAC_HOME/lib/pkgconfig
  
```
Here is the .bashrc file version:
```
	# PACLib settings...
  	export PAC_HOME=$HOME/PACLib
	export PAC_MODULEPATH=$PAC_HOME/lib
	export PAC_CXXFLAGS=-DPAC_DEBUG
	export PKG_CONFIG_PATH=$PAC_HOME/lib/pkgconfig
  
```
NOTE: On some GNU/Linux distributions (OpenSUSE) you have to add /opt/gnome/lib/pkgconfig to the PKG_CONFIG_PATH!
Download the source code.
Get the UNIX/Linux source code:
- PACLib (2008-12-22): Download
- FFTW (Version 2.1.5): Download
and install it on your system.
Note:
- PACLib is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (GNU LGPL) as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
- This PACLib distribution contains an extended redistribution of the TORCH project. The added code is published under GNU GPL. For details see source code.
- FFTW (Version 2.1.5) is not part of PACLib and is needed for the PACLib module FilterSMV. Version 3.X is not working with this module.
Setup and compile PACLib.
- Unix
  Now change your working path to the PACLib path (cd PACLib) and execute the following commands...
```
    SETUP
    BUILD
    
```
  ...in the following directories:
  - ext/UUID
  - PACBase
  - PACSoftwareModules/PACStdImageConverter
  - PACSoftwareModules/PACStdImageFilters
  - PACSoftwareModules/PACImageFileIO_* ( here * could be JPG/PNG/BMP/PPM/...)
  - PACTools
  Should this cause any problems it might be due to incorrectly set paths or uninstalled packages. Sometimes the resource files are not readed, then you can try the following:
```
    source /home/paclib/.tcshrc
    
```
  This should set the correct paths but it will also overwrite your PAC_HOME and PAC_MODULEPATH variables. Please reset them to the correct values as detailed above before carrying on. Also tell Christian or Oliver about the problem so that your path settings can be rectified.
  Under Linux make sure that the compiler is actually called with the preprocessor directive -D__linux__, because this enables some special linux parts in the PACLib source files. The define is usually specified in the linux gcc configuration files by default.
Create a test module.
Next you can create a test module and a test program to learn how to work with PACLib. First create the test module with the following commands. Make sure you are still in the main PACLib directory and PAC_HOME is set correctly. PAC_HOME also needs to be set if your are working under Windows.
```
  bin/PACCreateModuleFiles PACTools/PACCreateModuleFiles/module.config
  
```
This command creates a new subdirectory called MyModule which contains the module source and makefiles. Change into this directory and execute:
```
  SETUP
  BUILD
  
```
Now the module installed in PAC_HOME/lib.
Create a test program.
Now create the test program. A program skeletton can be created with the program PACCreateProgramFiles. Make sure you are in the main PACLib path and execute the following command:
```
  bin/PACCreateProgramFiles MyProg
  
```
This creates a new directory called MyProg. Change to this directory and execute the following two commands:
```
  SETUP
  BUILD
  
```
The program executable is now installed under PAC_HOME/bin.
Execute your test program.
Change to the main PACLib directory and execute the following command:
```
  bin/MyProg
  
```
This runs the test program. You can now edit the module sources in MyModule/source and the program source in MyProg/source.
If it's already 5pm go windsurfing.... ;-)

Detailed installation instructions

PACLib use the GNU make tools (autoconf, automake, libtool, etc.). An online-book about the GNU Autotools is installed on the PACLib homepage. The PACLib CVS-source comes without a configure script and without makefiles, but we have added a SETUP (to create the configure script) and a BUILD script (to create makefiles, libs and bins) to control the GNU-Automake tools. The GNU Autotools will generate the configure script and makefiles from template files (configure.in and Makefile.am). Each subproject includes its own Makefile.am file which specify the source and header files for the project. The configure.in is used to create a configure script with the autoconf tool. This script (configure) will determine your system setup and create system specific Makefiles.

Creating the configure script

In the PACLib directory you will find a SETUP script. This script will call some programs that create a configure script. This configure script can be used to create platform specific makefiles.

Creating the makefiles

In addition to the SETUP script you will find a BUILD script. This script will call the configure script and execute the make command. After this call you should have the binaries in the PACLib/bin and the libraries in PACLib/lib directory.

Attention

The environment variable PAC_HOME should be set to your PACLib directory before calling BUILD.

If you want to have more control over the installation process, you should call the configure script yourself. You can get more informations about the supported options with the command: configure --help

Perception-Action Components Library - PACLib
developed by the Cognitive Systems Group

Installation and quick start

Quick start

Detailed installation instructions

Get the source

Setup the configure script

Creating the configure script

Creating the makefiles