README.txt

   1
   2 README file for CADS/UVS Stellar Spectrum Calculator
   3 ----------------------------------------------------
   4
   5 1. BUILD/INSTALL
   6 ----------------
   7
   8   Follow these 4 steps:
   9
  10   1. `cd' to the directory containing the package's source code and type
  11      `./configure' to configure the package for your system.
  12
  13      Running `configure' takes a few seconds.  While running, it prints some
  14      messages telling which features it is checking for.
  15
  16   2. Type `make' to compile the package.
  17
  18   3. Type `make install' to install the programs and any data files and
  19      documentation. By default, the binary is copied to /usr/local/bin.
  20      You may change this destination by passing on the following
  21      argument to configure:
  22
  23              --prefix=/your/chosen/destination
  24
  25      Which would result in the binary in /your/chosen/destination/bin
  26      You may need to ensure that in $PATH to run the program.
  27
  28   4. You can remove the program binaries and object files from the
  29      source code directory by typing `make clean'.
  30
  31 You may read more about configure script and others in the accompanying
  32 file named `INSTALL'.
  33
  34
  35 2. USAGE
  36 --------
  37 All input parameters are read from an input parameter file named
  38 stellarspec_initparams.txt. The general usage pattern is:
  39
  40   uvs_stellar_spectrum [options]
  41
  42   Options are:
  43     -h help
  44
  45     -g Generates a well documented default parameter file
  46        Once you have the default parameter file, you can edit it as per your
  47        needs and run the program without any arguments to generate the stellar
  48        spectrum.
  49
  50     -p <parameter_file>
  51        Default parameter file is "stellarspec_initparams.txt". You can
  52        override this using -p flag. For eg., if several instances of this
  53        program are running in parallel from same directory, this flag can
  54        be used to avoid conflicts around same parameter file name.
  55
  56 NOTE: This program requires the kurucz model datafiles to simulate stellar
  57 spectrum. If you have installed it right, these files would be installed in
  58 <prefix>/share/cads/data/ and the default parameter file is aware of the
  59 location. These datafiles are also available in the subdirectory named
  60 "spectral_data" inside the source distribution as well.
  61
  62
  63 3. DOCUMENTATION
  64 ----------------
  65 Documentation and test cases are available at
  66 http://cads.iiap.res.in/software
  67
  68
  69 4. LICENSE
  70 ----------
  71 GPL [See the file COPYING.txt for details]
  72
  73
  74 5. DISCLAIMER
  75 -------------
  76 You may encounter bugs in this software. If you do, please
  77 report them. Your bug reports are valuable contributions,
  78 since they allow us to notice and fix problems on machines
  79 we don't have and/or remained un-noticed.
  80
  81
  82 6. REPORTING BUGS
  83 -----------------
  84 You can register with the cads bug reporting tool:
  85 http://cads.iiap.res.in/bugzilla/
  86 and file a bug report.
  87
  88 If you are too lazy, drop in an email to: cads_AT_iiap.res.in
  89
  90 Either way, please include as many details as possible.
  91
  92 -----------------------------------------------------------
  93 Reks, 01 July 2012. <reks_at_iiap.res.in>
  94