                                README FIRST!

Installing MOSFLM on most UNIX computers is really very easy; for several
systems you can pick up a gzip'd binary, which once it has been gunzip'd
will run straight away; you should really pick up the mosflm.hlp at the same
time from the same directory; this contains the on-line help which you use
when running mosflm. The file mosflm_user_guide.doc is a plain-text version
of the new HTML document mosflm_user_guide.html.

However, if you're reading this, you've probably picked up the
"build-it-yourself" version. Installing this way is also straightforward.

You should also read the file README_600.html; that contains much that
applies to v6.01 as well. However, where there is a conflict, the advice
here should be followed.

There are specific notes on the following;

   * LINUX (Intel and PPC versions)
   * SGI
   * SGI Irix 6.4 and 6.5 only
   * Digital Unix 4.0 and a Powerstorm 4D60T graphics card
   * Existing users of REFIX with MOSFLM
   * CCP4 Libraries
     -----------------------------------------------------------------------

     The program has been built successfully on the following machines and
     operating systems; however there are a number of caveats of which you
     should be aware (but see below for these).

     The Makefile in the top directory has checks for the environment
     variables PWD and HOSTTYPE; the different builds are all included in
     files in sub-directories according to the host type. You shouldn't need
     to touch the Makefiles at all, I hope (problems to the usual
     address...).

       Build Platform                      O/S
     Alpha 275MHz, 1Gb                Digital UNIX
     SGI 200MHz R4010/4400, 64Mb      Irix 5.3
     SGI 175MHz R10000/R10010, 192Mb  Irix 6.2
     SGI 175MHz R10000/R10010, 256Mb  Irix 6.5
     PC 233MHz Pentium, 128Mb         Red Hat Linux 5.1, 5.2, 5.3, 6.0
     iMac 233MHz PPC, 96Mb            linuxPPC 1999

     The build will involve a lot of paging if your machine has limited RAM,
     as will running the program. The executable is ~3.0 - 3.6Mb, and
     integrating a single 8Mb image uses up to around 16Mb, so I'd guess
     that 32Mb RAM is about the minimum you'd want to use. MOSFLM will not
     run on a PC with less than 20Mb of RAM.

     -----------------------------------------------------------------------
        o LINUX only:

            1. The XDL_VIEW libraries from the CCP4 distribution are
               slightly broken (as were those in Morten Kjelgaard's CCP4
               RPMs on 7th July 1999), so these should be re-made first from
               the source files included here in the tar file XDL_VIEW.tar;
               it assumes that you have already set up the CCP4 environment
               variables according to the normal $CCP4/include/ccp4.setup
               route. Install the file libxdl_view.a in your normal
               $CCP4_LIB/ (CCP4 library directory), i.e. the same place as
               libccp4.a

            2. I've assumed that the X11 libraries are in /usr/X11R6/lib. If
               yours are in a different place, you'll have to modify the
               file mosflm/Makefile.i386-linux to suit.

            3. Users running RedHat 6.0 and some newer SUSE distributions
               have encountered problems with the display; MOSFLM crashes
               when the display opens. In most cases (perhaps all) this can
               be cured by setting the colour depth of your machine to no
               more than 16 bpp. Also, you'll probably want to set the
               screen resolution to at least 1280 x 1024 so that the display
               fits on the screen. This is due to either the X server or the
               XDL_VIEW libraries being broken; take your pick...

        o SGI only:

            1. Optimization in mosflm/Makefile.iris4d -Olimit 11400 might
               increase performance, but compilation takes forever. The
               line's there if you want to uncomment it, but my guess is
               that you'll lose more in the compilation than you'll ever
               gain in performance.

        o SGI Irix 6.4 and Irix 6.5 only:

            1. Set the environment variable HOSTTYPE to iris4d6.4 or
               iris4d6.5.

               e.g. under tcsh or csh, you would use the command

                             % setenv HOSTTYPE iris4d6.4

               Under bash or ksh, you would type

                             %bash HOSTTYPE=iris4d6.4
                             %bash export HOSTTYPE

          There are a few warnings generated during compilation, but these
          do not appear serious.

        o Digital Unix 4.0 and a Powerstorm 4D60T graphics card:

          For some reason connected with colour mapping, the xdl_view
          routines do not work with this particular type of graphics card.

          When an image is to be displayed the following error message
          occurs:

          X Error of failed request:  BadMatch (invalid parameter attributes)
            Major opcode of failed request:  1 (X_CreateWindow)
            Serial number of failed request:  53
            Current serial number in output stream:  56

          FIX

          To get round this problem, replace the file "xdl_view.c" with the
          new version called "xdl_view_dec.c" which is in this directory,
          and remake the xdl_view library.

          The existing source code will be in a directory something like:

              /public/ccp4/x-windows/xdl_view/src

          This simply has some code commented out compared to the standard
          version, but this can lead to a degradation of the performance on
          some machines and so is only recommended if you are using this
          type of graphics card.

        o Existing users of REFIX with MOSFLM

          Existing users of the REFIX autoindexing routines with MOSFLM
          should be aware that the script included in the mosflm
          subdirectory for adding REFIX to the file mosflm_all_ip_inc.for
          has changed; the old routine will appear to work but REFIX
          indexing will cause the program to crash! Make sure you use the
          new script.

        o CCP4 Libraries

          It is necessary that your CCP4 libraries (i.e. the two files
          libccp4.a and libxdl_view.a) are in a directory with the
          environment variable $CCP4_LIB; previous releases of MOSFLM have
          assumed that the variable is $CLIB, which is contrary to current
          CCP4 practice. However, if $CCP4_LIB has not been defined, the
          build procedure will assign it the current value of $CLIB.
     -----------------------------------------------------------------------

     INSTALLATION

     The simplest way to install for most users will be to copy the
     appropriate pre-built binary from
     ftp.mrc-lmb.cam.ac.uk/pub/mosflm/pre-built, and put it in your exection
     path. These executables include both DPS and REFIX indexing.
          ------------------------------------------------------------------
        o MOSFLM 6.01 will not build with versions of the CCP4 library
          before 3.5. If you have an earlier version, you should seriously
          consider updating!
          ------------------------------------------------------------------
        o If you have the old-style autoindexing routines (REFIX), you need
          to do this before building the program. There are several routines
          at the end of the file mosflm/mosflm_all_ip_inc.for which need to
          be removed and the REFIX files added (while in the mosflm
          subdirectory) with the script is included in the file
          add_refix.com.

        o If you haven't defined CCP4_LIB in your normal login setup, you
          might want to edit the line in the top-directory Makefile

                  #define CCP4_LIB ${CLIB}

          to suit your local conditions.

        o Some sites have not defined the PWD environment variable, which is
          used in the build procedure. You can either define this to be the
          top directory of the distribution before you start the build, or
          you can edit the top-level Makefile and change the line

                  DPS        = ${PWD}

          to suit.
        o In the distribution's top-level directory, type

                  make

          and it should build and install ipmosflm in its bin directory.

          The makes in the mosflm and the index subdirectories should build
          the two components; I haven't tested rebuilding from the other
          subdirectories; my suggestion is not to do this, as a complete
          rebuild, even on a PC, takes only a few minutes.
     -----------------------------------------------------------------------

     If you are a new user of MOSFLM and would like the option of using
     REFIX with the build-it-yourself version, you should e-mail Andrew
     Leslie and ask for it.
     -----------------------------------------------------------------------
     Harry Powell, MRC-LMB, MRC Centre, Hills Road, Cambridge, U.K. CB2 2QH
     harry@mrc-lmb.cam.ac.uk
     Last modified: Fri Jul 9 16:17:37 MET DST 1999
