README.txt

   1
   2
   3 README file for CADS/UVS Zodiacal light model software
   4 ------------------------------------------------------
   5
   6 0. Dependencies
   7 ----------------
   8
   9 UVS Zodiacal light model requires libnova to perform coordinate
  10 transformation and stuff like that. If you are using linux, then
  11 a binary package of libnova should be available in official OS
  12 repository since popular sofware like kstars desktop planetarium
  13 used libnova. You need to install libnova-devel package so that
  14 we have all the header files for compiling this one.
  15
  16
  17 1. BUILD/INSTALL
  18 ----------------
  19
  20 Compiling this code is not difficult task after all!
  21 On unix/linux machines, you can even get away with
  22 commands like:
  23
  24 cd src && cc *.c -o your_binary_file -lm -L/path/to/libnova -lnova
  25
  26 The standard route, however, is to read the file "INSTALL"
  27 :-) Once you are done with it, follow these 4 steps:
  28
  29
  30   i. `cd' to the directory containing the package's source code and type
  31      `./configure' to configure the package for your system.  If you're
  32      using `csh' on an old version of System V, you might need to type
  33      `sh ./configure' instead to prevent `csh' from trying to execute
  34      `configure' itself.
  35
  36      Running `configure' takes a few seconds.  While running, it prints
  37      some messages telling which features it is checking for. It will try
  38      to locate libnova distribution but if it fails, you can manually
  39      direct configure script to the location of your libnova by:
  40
  41      ./configure --with-libnova=path/to/libnova
  42
  43      Script will search libnova header files in:
  44          1. path/to/libnova
  45          2. path/to/libnova/include
  46          3. path/to/libnova/include/libnova
  47
  48      and library (libnova.so or libnova.a) in
  49          1. path/to/libnova
  50          2. path/to/libnova/lib
  51          3. path/to/libnova/lib64
  52
  53  ii. If configure ended successfully, Type `make' to compile the package.
  54
  55 iii. Type `make install' to install the programs and any data files and
  56      documentation. By default, the binary is copied to /usr/local/bin.
  57      You may change this destination by passing on the following
  58      argument to configure:
  59
  60              --prefix=/your/chosen/destination
  61
  62      Which would result in the binary in /your/chosen/destination/bin
  63      You may need to ensure that in $PATH to run the program.
  64
  65  iv. You can remove the program binaries and object files from the
  66      source code directory by typing `make clean'.
  67
  68 You may read more about configure script and others in the accompanying
  69 file named `INSTALL'.
  70
  71
  72 2.USAGE
  73 -------
  74
  75 Program requires two data files -
  76          1. leinert_dist.txt
  77          2. zodiacal_spec.txt
  78
  79 These two files are packed along in the src subdirectory.
  80 The program expects these two in the working directory. You
  81 may alter that by generating a parameter file and editing
  82 it.
  83
  84 If you run the program without any arguments, and there is
  85 no parameter file (UVS_zodiacal_initparams.txt) in the
  86 working directory, the program will generate a new parameter
  87 file. You may edit the values in parameter file.
  88
  89 By default, output will be written to zodiacal_output.txt.
  90
  91
  92 3. DOCUMENTATION
  93 ----------------
  94 Documentation : cads.iiap.res.in/tools/zodiacalCalc/Documentation
  95 Test reports  : Not yet :-)
  96
  97
  98 4. LICENSE: GPL [See the file COPYING.txt for details]
  99 -----------
 100
 101
 102 5. DISCLAIMER
 103 -------------
 104 You may encounter bugs in this software. If you do, please
 105 report them. Your bug reports are valuable contributions,
 106 since they allow us to notice and fix problems on
 107 machines/platforms we don't have, and/or remained un-noticed.
 108
 109
 110 6. REPORTING BUGS
 111 -----------------
 112 You can register with the cads bug reporting tool:
 113 http://cads.iiap.res.in/dropbux/
 114 and file a bug report.
 115
 116 If you are too lazy, drop in an email to: cads_AT_iiap.res.in
 117
 118 Either way, please include as many details as possible.
 119
 120 -----------------------------------------------------------
 121 Reks, 22 June 2012 <reks_at_iiap.res.in>
 122       Last modified: 23 June 2012