INSTALL

   1 CTSim Installation
   2 ==================
   3
   4 Additional Libraries Recommended
   5 --------------------------------
   6
   7 zlib (ftp://ftp.uu.net/pub/archiving/zip/zlib)
   8   Tested with version 1.13
   9   This library is required for libpng (see below)
  10
  11 libpng (ftp://ftp.uu.net/graphics/png/src)
  12   Version 1.0.3 or greater is required. Version 0.89 definitely will
  13   not work.
  14
  15 fftw (http://www.fftw.org)
  16   Fastest Fourier Transform in the West. Currently, this library is the
  17   only FFT routines used by CTSim.
  18
  19 wxWindows (http://www.wxwindows.org)
  20   Used by CTSim (src/*) graphic front-end. Platform independent for
  21   GTK, Motif, and Windows32 API's. Requires version 2.4.0 or later.
  22
  23 ctn (http://www.erl.wustl.edu/DICOM/ctn.html)
  24   Used by CTSim for DICOM file import and export
  25
  26 lam (http://www.mpi.nd.edu/lam/)
  27   There is support is MPI clustering. I use this code at home for my
  28   beowulf cluster.
  29
  30 dmalloc (http://www.dmalloc.com)
  31   This adds debugging to memory allocation routines
  32
  33 perl (http://www.perl.org)
  34 apache (http://www.apache.org)
  35   There is support for web-driven CT Simulation. To use this, the
  36   --with-cgibin-dir=..., --with-cgibin-url=..., --with-webdata-dir=...,
  37   --with-webdata-url=..., and --with-html-dir=...  must be set.
  38
  39 readline (http://www.gnu.org)
  40   Used for provide command-line editing in ctsimtext shell
  41
  42
  43 CTSim Specific Configuration Help
  44 ---------------------------------
  45
  46   --enable-verbose-warnings
  47                           Enable verbose compiler warnings.
  48   --enable-debug          Turn on debugging
  49   --with-lam[=PATH]       Set path of LAM MPI
  50   --with-cgibin-dir=PATH  Set path of CGI binaries directory
  51   --with-cgibin-url=PATH  Set URL path of CGI binaries
  52   --with-webdata-dir=PATH Set path of webdata
  53   --with-webdata-url=PATH Set URL path of webdata
  54   --with-html-dir=PATH    Set directory of html files
  55   --with-x                use the X Window System for interactive graphics
  56
  57
  58 PLATFORM SPECIFIC NOTES
  59 =======================
  60
  61 Platforms Tested
  62 ----------------
  63
  64 Recent development is with GNU/Linux. I have tested compilation on
  65 FreeBSD v4.0, BSD/OS v3.0, and Solaris v8 (gcc 32-bit), and IA64 (gcc)
  66 , and Microsoft Windows 2000 (Visual C++ 6.0, cygwin, and mingw32).
  67
  68 Visual C++ Installation
  69 -----------------------
  70 Run make.bat from the root directory (Note, make.bat is out of date
  71 and is currently broken)
  72
  73 CYGWIN v1.1.0
  74 -------------
  75 The file /usr/i686-pc-wygwin/include/cygwin/in.h has a bug. The line
  76       struct in_addr6 sin6_addr;
  77 should be deleted.
  78
  79 getopt_long appears broken, configure.in checks for cygwin to use
  80 bundled version of getopt_long.
  81
  82
  83 Basic Installation
  84 ==================
  85
  86    These are generic installation instructions.
  87
  88    The `configure' shell script attempts to guess correct values for
  89 various system-dependent variables used during compilation.  It uses
  90 those values to create a `Makefile' in each directory of the package.
  91 It may also create one or more `.h' files containing system-dependent
  92 definitions.  Finally, it creates a shell script `config.status' that
  93 you can run in the future to recreate the current configuration, a file
  94 `config.cache' that saves the results of its tests to speed up
  95 reconfiguring, and a file `config.log' containing compiler output
  96 (useful mainly for debugging `configure').
  97
  98    If you need to do unusual things to compile the package, please try
  99 to figure out how `configure' could check whether to do them, and mail
 100 diffs or instructions to the address given in the `README' so they can
 101 be considered for the next release.  If at some point `config.cache'
 102 contains results you don't want to keep, you may remove or edit it.
 103
 104    The file `configure.in' is used to create `configure' by a program
 105 called `autoconf'.  You only need `configure.in' if you want to change
 106 it or regenerate `configure' using a newer version of `autoconf'.
 107
 108 The simplest way to compile this package is:
 109
 110   1. `cd' to the directory containing the package's source code and type
 111      `./configure' to configure the package for your system.  If you're
 112      using `csh' on an old version of System V, you might need to type
 113      `sh ./configure' instead to prevent `csh' from trying to execute
 114      `configure' itself.
 115
 116      Running `configure' takes awhile.  While running, it prints some
 117      messages telling which features it is checking for.
 118
 119   2. Type `make' to compile the package.
 120
 121   3. Optionally, type `make check' to run any self-tests that come with
 122      the package.
 123
 124   4. Type `make install' to install the programs and any data files and
 125      documentation.
 126
 127   5. You can remove the program binaries and object files from the
 128      source code directory by typing `make clean'.  To also remove the
 129      files that `configure' created (so you can compile the package for
 130      a different kind of computer), type `make distclean'.  There is
 131      also a `make maintainer-clean' target, but that is intended mainly
 132      for the package's developers.  If you use it, you may have to get
 133      all sorts of other programs in order to regenerate files that came
 134      with the distribution.
 135
 136 Compilers and Options
 137 =====================
 138
 139    Some systems require unusual options for compilation or linking that
 140 the `configure' script does not know about.  You can give `configure'
 141 initial values for variables by setting them in the environment.  Using
 142 a Bourne-compatible shell, you can do that on the command line like
 143 this:
 144      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 145
 146 Or on systems that have the `env' program, you can do it like this:
 147      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 148
 149 Compiling For Multiple Architectures
 150 ====================================
 151
 152    You can compile the package for more than one kind of computer at the
 153 same time, by placing the object files for each architecture in their
 154 own directory.  To do this, you must use a version of `make' that
 155 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 156 directory where you want the object files and executables to go and run
 157 the `configure' script.  `configure' automatically checks for the
 158 source code in the directory that `configure' is in and in `..'.
 159
 160    If you have to use a `make' that does not supports the `VPATH'
 161 variable, you have to compile the package for one architecture at a time
 162 in the source code directory.  After you have installed the package for
 163 one architecture, use `make distclean' before reconfiguring for another
 164 architecture.
 165
 166 Installation Names
 167 ==================
 168
 169    By default, `make install' will install the package's files in
 170 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 171 installation prefix other than `/usr/local' by giving `configure' the
 172 option `--prefix=PATH'.
 173
 174    You can specify separate installation prefixes for
 175 architecture-specific files and architecture-independent files.  If you
 176 give `configure' the option `--exec-prefix=PATH', the package will use
 177 PATH as the prefix for installing programs and libraries.
 178 Documentation and other data files will still use the regular prefix.
 179
 180    In addition, if you use an unusual directory layout you can give
 181 options like `--bindir=PATH' to specify different values for particular
 182 kinds of files.  Run `configure --help' for a list of the directories
 183 you can set and what kinds of files go in them.
 184
 185    If the package supports it, you can cause programs to be installed
 186 with an extra prefix or suffix on their names by giving `configure' the
 187 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 188
 189 Optional Features
 190 =================
 191
 192    Some packages pay attention to `--enable-FEATURE' options to
 193 `configure', where FEATURE indicates an optional part of the package.
 194 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 195 is something like `gnu-as' or `x' (for the X Window System).  The
 196 `README' should mention any `--enable-' and `--with-' options that the
 197 package recognizes.
 198
 199    For packages that use the X Window System, `configure' can usually
 200 find the X include and library files automatically, but if it doesn't,
 201 you can use the `configure' options `--x-includes=DIR' and
 202 `--x-libraries=DIR' to specify their locations.
 203
 204 Specifying the System Type
 205 ==========================
 206
 207    There may be some features `configure' can not figure out
 208 automatically, but needs to determine by the type of host the package
 209 will run on.  Usually `configure' can figure that out, but if it prints
 210 a message saying it can not guess the host type, give it the
 211 `--host=TYPE' option.  TYPE can either be a short name for the system
 212 type, such as `sun4', or a canonical name with three fields:
 213      CPU-COMPANY-SYSTEM
 214
 215 See the file `config.sub' for the possible values of each field.  If
 216 `config.sub' isn't included in this package, then this package doesn't
 217 need to know the host type.
 218
 219    If you are building compiler tools for cross-compiling, you can also
 220 use the `--target=TYPE' option to select the type of system they will
 221 produce code for and the `--build=TYPE' option to select the type of
 222 system on which you are compiling the package.
 223
 224 Sharing Defaults
 225 ================
 226
 227    If you want to set default values for `configure' scripts to share,
 228 you can create a site shell script called `config.site' that gives
 229 default values for variables like `CC', `cache_file', and `prefix'.
 230 `configure' looks for `PREFIX/share/config.site' if it exists, then
 231 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 232 `CONFIG_SITE' environment variable to the location of the site script.
 233 A warning: not all `configure' scripts look for a site script.
 234
 235 Operation Controls
 236 ==================
 237
 238    `configure' recognizes the following options to control how it
 239 operates.
 240
 241 `--cache-file=FILE'
 242      Use and save the results of the tests in FILE instead of
 243      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 244      debugging `configure'.
 245
 246 `--help'
 247      Print a summary of the options to `configure', and exit.
 248
 249 `--quiet'
 250 `--silent'
 251 `-q'
 252      Do not print messages saying which checks are being made.  To
 253      suppress all normal output, redirect it to `/dev/null' (any error
 254      messages will still be shown).
 255
 256 `--srcdir=DIR'
 257      Look for the package's source code in directory DIR.  Usually
 258      `configure' can determine that directory automatically.
 259
 260 `--version'
 261      Print the version of Autoconf used to generate the `configure'
 262      script, and exit.
 263
 264 `configure' also accepts some other, not widely useful, options.