diff --git a/documentation/areaDetectorDoc.html b/documentation/areaDetectorDoc.html index ecc9cc1..2d3a0d2 100755 --- a/documentation/areaDetectorDoc.html +++ b/documentation/areaDetectorDoc.html @@ -10,7 +10,7 @@

areaDetector: EPICS Area Detector Support

- August 15, 2009

+ August 23, 2009

Mark Rivers

@@ -68,6 +68,7 @@
  • IDL Viewer
    • +
  • Installation, configuration, and startup

    •  

    @@ -1793,5 +1794,146 @@

    ADEpicsShutter.adl

    ADEpicsShutter.png +

    Installation, configuration, and running

    +

    + Installation: source code version

    +

    + After obtaining a copy of the distribution, it must be installed and built for use + at your site. These steps only need to be performed once for the site (unless versions + of the module running under different releases of EPICS and/or the other required + modules are needed).

    +
      +
    1. Create an installation directory for the module, usually this will end with
      +
      + .../support/ +
      +
      2. +
    2. Place the distribution file in this directory. Then issue the commands (Unix style) + 
      tar xvzf areaDetectorRX-Y.tgz
+
+
      + where X-Y is the release.
      3. +
    3. This creates a <top> application.
      + 
      .../support/areaDetectorRX-Y
+
      +
      4. +
    4. Download all required supporting modules if you don't already have them. This includes + asyn, autosave, busy, etc.
      5. +
    5. Edit the configure/RELEASE file and set the paths to your installation + of EPICS base and to your versions of supporting modules.
      6. +
    6. Run gnumake in the top level directory and check for any compilation + errors.
      7. +
    +

    + Installation: prebuilt version

    +

    Prebuilt versions of areaDetector are provide for Windows (win32-x86), Cygwin (cygwin-x86), + and Linux (linux-x86). Follow these steps to use the prebuilt version:

    +
      +
    1. Create an installation directory for the module. On Windows I typically use C:\EPICS\support. + On Linux I typically use /home/ACCOUNT/epics/support, where ACCOUNT is the name of the account + that is normally used to run the detector software, e.g. marccd on a marCCD detector, mar345 on + a mar345 detector, etc.
      2. +
    2. Place the distribution file in this directory. Then issue the commands (Unix style) + 
      tar xvzf areaDetectorPrebuilt_RX-Y.tgz
      +
      3. +
    3. In the iocBoot directory make a copy of the example ioxXXX directory for the detector + you are using and give it a new local name. By doing this you will be able to update + to later versions of areaDetector without overwriting modifications you make in + the iocXXX directory.
      4. +
    4. In the new iocXXX directory you just created edit st.cmd to change the PV prefix + $(P) to one that is unique to your site. PV prefixes must be unique on the subnet, + and if you use the default prefix there could be a conflict with other detectors + of the same type.
      5. +
    5. In the same iocXXX directory edit the file envPaths to point to the locations + of all of the support modules on your system. Normally this is handled by the EPICS + build system, but when using the prebuilt version this must be manually edited. + Do not worry about the path to EPICS_BASE, it is not required.
      6. +
    +

    + Installation: medm

    +

    areaDetector provides display/control screens for the medm + Motif Editor and Display Manager. A prebuilt version of medm for Windows can be found in the + EPICS WIN32 Extensions. For Linux one can build medm + from source code, which requires downloading and building + EPICS base first. Alternatively I provide a prebuilt version of + medm for Linux in the + EPICS_Linux_binraries.tar package. + To use this version copy the medm executable to some location in your PATH, e.g. /usr/local/bin, or ~/bin, etc. + Copy the 2 shareable libraries libCom.so and libca.so to a location which is in your LD_LIBRARY_PATH. + To use either the source code or prebuilt version you need to have the OpenMotif package installed. This + typically is not installed by default with recent versions of Linux. Go to + www.openmotif.org + and download and install the appropriate RPM package for your Linux version.

    +

    + Configuration

    +

    Before running an areaDetector application it is usually necessary to configure a number of items.

    + +

    + Running the IOC

    +

    Each example IOC directory comes with a Linux script (start_epics) or a Windows batch file (start_epics.bat) or both + depending on the architectures that the detector runs on. These scripts provide simple examples of how to start + medm and the EPICS IOC. For example, for the mar345 iocBoot/iocMAR345/start_epics contains the following:

    + 
    +    medm -x -macro "P=13MAR345_1:, R=cam1:, I=image1:, ROI=ROI1:, NETCDF=netCDF1:, TIFF=TIFF1:, JPEG=JPEG1:, NEXUS=Nexus1:" mar345.adl &
+    ../../bin/linux-x86/mar345App st.cmd
+
    +

    This script starts medm in execute mode with the appropriate medm display file and macro parameters, running it in the background. It then + runs the IOC application. This script assumes that iocBoot/iocMAR345 is the default directory when it is run, which could be added to the + command or set in the configuration if this script is set as the target of a desktop shortcut, etc. The script assumes that EPICS_DISPLAY_PATH + has been defined to be a location where the mar345.adl and related displays that it loads can be found. You will need to edit the script + in your copy of the iocXXX directory to change the prefix (P) from 13MAR345_1: to whatever prefix you chose for your IOC. The start_epics script + could also be copied to a location in your PATH (e.g. /home/mar345/bin/start_epics). Add a command like + cd /home/mar345/epics/support/areaDetector/1-5/iocBoot/iocMAR345 at the beginning of the script and then type + start_epics from any directory to start the EPICS IOC.