Area Detector: Installation Guide

Introduction

This is a guide for installing and building the areaDetector. This guide is only valid for releases 2.0 and later of areaDetector. This guide is intended for both areaDetector users and developers. areaDetector can be obtained as a release or by cloning from the github repository. This guide provides instructions for installing and building on linux. The guidelines should also work for darwin, i. e. macOS. At this time there are no guidelines for windows, vxWorks, or RTEMS.

The build process attempts to make the build process easy for typical cases but allow site specific overrides. areaDetector uses many other products:

External Products

TIFF, ZLIB, JPEG, SZIP, and HDF5 are all required. GRAPHICSMAGIC is optional. These are described in a later section.

iocCore

Any relatively recent 3.14 release of iocCore should work.

EPICS modules

asynDriver is required. Some synApps components are required, in particular CALC, BUSY, SSCAN, and AUTOSAVE. These are discussed in a later section.

Configuration Products

A configuration tool is required for configuration of areaDetector plugins. ADCORE has support for the following tools: MEDM, EDM, CSS, and pyQt. These are discussed in a later section.

Image Viewer Products

One or more of the following GUI tool are desirable for viewing image files: ImageJ, HDFView, and IDL.

After all the required products have been installed and a release of areaDetector has been downloaded then do the following in the top level directory:

Copy files:

cp EXAMPLE_RELEASE_PATHS.local RELEASE_PATHS.local
cp EXAMPLE_RELEASE_LIBS.local RELEASE_LIBS.local
cp EXAMPLE_RELEASE_PRODS.local RELEASE_PRODS.local
        

Edit RELEASE_PATHS.local

The definitions for SUPPORT, AREA_DETECTOR, and EPICS_BASE must all be changed. All definitions must include the full path name. The definitions for HDF5 and SZ may need to be changed. If GRAPHICS_MAGIC is installed then the definitions for it may also need to be changed.

Edit RELEASE_LIBS.local

The location of ASYN must be specified with a full path name. If You have built the version that appears no changes are necessary.

Edit RELEASE_PRODS.local

The definitions for CALC, BUSY, SSCAN, and AUTOSAVE must have a full path name. If You have built the versions that appear no changes are necessary.

make

Just type:

make
      

If this fails then some required products has probably not been installed. Read more of this manual and install what is missing. When areaDetector builds successfully go to the next step.

Run SimDetector

cd ADCore/iocs/simDetectorIOC/iocBoot/iocSimDetector
make
cp envPaths envPaths.linux
 ../../bin/linux-x86_64/simDetectorApp st.cmd.linux
       

If this works successfully then go to next step.

Congradulations!!!

You can ignore the rest of this document.

NOTE MARK I suggest the following changes for EXAMPLE_RELEASE_PATHS.local:

XXX_DIR

Change this to XXX_LIB. This requires a change in ADApp/commonDriverMakefile.

XX_INCLUDES= -I

Change this to XX_INCLUDE=. This requires a change in ADApp/pluginSrc/Makefile.

Change statement order

Put related things together.

ZLIB, TIFF, and JPEG

What about these? Should they also appear in RELEASE_PATHS.local OR maybe they should not appear and SZLIB should also not appear. Note that HDF5 and GRAPHICS_MAGICK MUST appear since they do not follow normal rules for /usr/local.

Thus the EXAMPLE_RELEASE_PATHS.local becomes:

# The following 3 definitions must be changed for each site
SUPPORT=/home/install/epics/support
AREA_DETECTOR=/home/git/areaDetector
EPICS_BASE=${SUPPORT}/base-3.14.12.3

# Define the location of HDF5
HDF5=/usr/local/hdf5
HDF5_LIB=${HDF5}/lib
HDF5_INCLUDE=${HDF5}/include

# Define the location of Graphics Magic
GRAPHICS_MAGICK=/usr/local
GRAPHICS_MAGICK_LIB=${GRAPHICS_MAGICK}/lib
GRAPHICS_MAGICK_INCLUDE=${GRAPHICS_MAGICK}/include/GraphicsMagick

#MARK either remove SZLIB or also have defs for TIFF, JPEB, and ZLIB
# Define the location of SZLIB
SZLIB=/usr/local
SZ_LIB=${SZLIB}/lib
SZ_INCLUDE=${SZLIB}/include

#Define TIFF, JPEG, and ZLIB ???

Downloading a release of areaDetector

From github

This requires that you have signed on to github and have generated an ssh key and put it in git hub. To sign on to github go to: Join github This site also gives instructions for installing git. The instructions for generating an ssh key are: ssh-key

To download areaDetector via git just execute:

git clone --recursive git@github.com:areaDetector/areaDetector.git

Release Site

See areaDetector

NOTE: no 2.0 release of areaDetector is currently available. Thus the only want to get it is through github.

External Products Required for Building areaDetector

The product descrbes in this section are not part of epics (base, modules, or extensions) but are used by areaDetector plugins. Some may already be installed or your system so before reading this section just try to build areaDetector, especially ADCore. If it builds this section can be ignored. If it does not then this section can be used to locate and install any missing components.

The instructions in this section were the result of installing all the components on a new laptop on which I installed fedora 20. Before installing I had already built iocCore, asynDriver, and the required synApps components.

For each product the source was downloaded from a product download site and then built. It may be easier to download pre-built modules, but downloading the sources and building should work on more varieties of linux and darwin.

Each site provides some combination of .zip, .tar, .tar.gz, etc. If the file is a zip file then just execute:

unzip file.zip

If the file is any flavor of tar just execute:

tar xf file

All of the following products put the result of unzip or tar into a sub-directory. cd to that directory and follow the instructions for the appropriate sub-section.

If the instructions in the following subsections are used then RELEASE_PATHS.local, except for the first three definitions, should be:

# The following 3 definitions must be changed for each site

SUPPORT=/home/install/epics/support
AREA_DETECTOR=/home/git/areaDetector
EPICS_BASE=${SUPPORT}/base-3.14.12.3

# Define the location of HDF5
HDF5=/usr/local/hdf5
HDF5_DIR=${HDF5}/lib
HDF5_INCLUDES= -I${HDF5}/include

# Define the location of SZLIB
SZLIB=/usr/local
SZ_DIR=${SZLIB}/lib
SZ_INCLUDES= -I${SZLIB}/include

# Define the location of Graphics Magic
GRAPHICS_MAGICK=/usr/local
GRAPHICS_MAGICK_DIR=${GRAPHICS_MAGICK}/lib
GRAPHICS_MAGICK_INCLUDES= -I${GRAPHICS_MAGICK}/include/GraphicsMagick

TIFF

This can be download from libTIFF

Then click on the Master Download Site and download the latest stable release.

After the latest release is unziped cd to the release and execute the commands:

./configure
make
sudo make install

The include and library files are installed by default into /usr/local

ZLIB

This can be download from zlib

Then look for latest release download.

After untaring the release

./configure
make
sudo make install

The include and library files are installed by default into /usr/local

JPEG

This can be download from libjpeg

Read the instructions from the web site about installing. I suggest that it be installed into /usr/local instead of /usr. Thus to install:

./configure --prefix=/usr/local  \
     --mandir=/usr/share/man \
     --with-jpeg8  \
     --disable-static \
     && \
    sed -i -e '/^docdir/ s/$/\/libjpeg-turbo-1.3.0/'   \
     -e '/^exampledir/ s/$/\/libjpeg-turbo-1.3.0/' Makefile &&
make
make test
sodo make install

SZIP

This can be download from SZIP

Then click on SZIP Source and download the release that appears.

After the latest release is untared, cd to the release and execute the commands:

./configure --prefix=/usr/local
make
make check
sudo make install

HDF5

Start at: HDF Group

The click on Downloads, then Current Release, then HDF5 Software, then Source Code, then latest release.

After the latest release is untared, cd to the release and execute that command:

./configure --prefix=/usr/local/hdf5 
make
make check   
sudo make install
make check-install

GRAPHICSMAGICK

To build this from mercurial repository:

hg clone http://hg.code.sf.net/p/graphicsmagick/code graphicsmagick-code
cd graphicsmagick-code/
./configure
make
sudo make install

However when I tried to build areaDetector with GrahicsMagick enabled the build failed with:

...
/usr/bin/ld: /usr/local/lib/libGraphicsMagick++.a(Image.o):
relocation R_X86_64_32S against `_ZTVN6Magick5ImageE'
can not be used when making a shared object; recompile with -fPIC
/usr/local/lib/libGraphicsMagick++.a: could not read symbols: Bad value
collect2: error: ld returned 1 exit status

EPICS Products Required for Building areaDetector

areaDetector is based on asyn which is based on EPICS base and also uses several components from synApps.

The normal way of installing the EPICS components is to install and build ASYN and all synApp components under a single directory located by SUPPORT in file RELEASE_PATHS.local. All definitions in this file must have full path names.

The expected version of ASYN appears in file RELEASE_LIBS.local If You want a different version then this file must be edited.

The required synApps components appear is file RELEASE_PRODS.local. This file also shows which version of each component is expected. If You want a different version then this file must be edited.

Configuration Products

In order to configure the plugins You must install one or more of the following: MEDM, EDM, CSS, pyQT.

MEDM

At present X11 is not avaliable for fedora 20. Thus I can not build MEDM.

EDM

At present X11 is not avaliable for fedora 20. Thus I can not build EDM.

CSS

pyQt

Image Viewer Products

ImageJ

IDL

Installation Details

RELEASE_PATHS.local

RELEASE_LIBS.local

RELEASE_PRODS.local

iocBoot/ioc*