README.txt

   1
   2
   3 README file for CADS sky_model software
   4 -------------------------------------------
   5
   6
   7 0. FEATURES
   8 -----------
   9
  10 Sky model is a tool to predict the appearance of the sky at any wavelength.
  11 It comprises three parts:
  12
  13    i. Zodiacal light background (using Leinert's model)
  14   ii. Diffuse galactic light (from Galex data)
  15  iii. Stars (hipparcos catalog).
  16
  17 Provision is made for different filters.
  18 Output will be in fits format
  19 http://en.wikipedia.org/wiki/FITS
  20
  21
  22 1. BUILD/INSTALL
  23 ----------------
  24
  25 Pre-requisites:
  26
  27  a) CFITSIO
  28     CFITSIO is a library and headers to read and write FITS files.
  29     If you do not have cfitsio installed, get it from:
  30
  31     http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html
  32
  33  b) LIBNOVA
  34     libnova library and headers.
  35     Once you have cfitsio and libnova installed,
  36     you may proceed with compiling sky_model.
  37
  38     Most linux distributions have cfitsio and libnova in their deb/yum/rpm
  39     repositories.
  40
  41     Follow these 4 steps to compile and install the code:
  42
  43 c)  cads_stellar_data
  44     Stellar models data, available in the CADS download area, alongside
  45     this package. stellar_data consists of:
  46     1. Castelli data from
  47        www.stsci.edu/hst/observatory/cdbs/castelli_kurucz_atlas.html
  48     2. Cross-section file from Draine
  49        ftp.astro.princeton.edu/draine/dust/mix/kext_albedo_WD_MW_3.1_60_D03.all
  50     3. Hipparcos data from CDS
  51        http://cdsarc.u-strasbg.fr/viz-bin/Cat?I/239
  52
  53
  54   1. `cd' to the directory containing the package's source code and type
  55      `./configure' to configure the package for your system.
  56
  57      If cfitsio library and header files are not in the standard path,
  58      then you may need to pass on the following argument to configure:
  59
  60         --with-cfitsio=path/to/cfitsio
  61
  62          Script will search fitsio header files in:
  63              1. path/to/cfitsio
  64              2. path/to/cfitsio/include
  65              3. path/to/cfitsio/include/cfitsio
  66
  67         and library (libcfitsio.so or libcfitsio.a) in
  68              1. path/to/cfitsio
  69              2. path/to/cfitsio/lib
  70              3. path/to/cfitsio/lib64
  71
  72
  73      Similarly, for libnova (incase configure failed to detect it)
  74
  75               --with-libnova=/path/to/libnova
  76
  77      Running `configure' takes a few seconds. While running, it prints some
  78      messages telling which features it is checking for.
  79
  80   2. Type `make' to compile the package.
  81
  82   3. Type `make install' to install the programs and any data files and
  83      documentation. By default, the binary is copied to /usr/local/bin. You may
  84      change this destination by passing on the following argument to configure:
  85
  86              --prefix=/your/chosen/destination
  87
  88      Which would result in the binary in /your/chosen/destination/bin
  89      You may need to ensure that in $PATH to run the program.
  90
  91   4. You can remove the program binaries and object files from the source code
  92      directory by typing `make clean'.
  93
  94 You may read more about configure script and others in the accompanying file
  95 named `INSTALL.txt'.
  96
  97
  98 2.USAGE
  99 -------
 100 This software is governed by an input parameter file called
 101
 102 diffuse_initparams.txt.
 103
 104 When you invoke the program, sky_model will generate a default parameter file
 105 if the file is not present in the working directory. This file is well
 106 documented internally and it should help you in choosing the input values.
 107
 108
 109 3. DOCUMENTATION
 110 ----------------
 111 If you have downloaded the source package, a detailed user manual
 112 (skymodel_manual.pdf) can be found in the doc subdirectory after you've gone
 113 through configure and make (section 1, see above).
 114
 115 If you installed a binary package, you will find the documentation alongside
 116 this file.
 117
 118
 119 4. LICENSE: GPL [See the file COPYING.txt for details]
 120 -----------
 121
 122
 123 5. DISCLAIMER
 124 -------------
 125 You may encounter bugs in this software. If you do, please report them. Your bug
 126 reports are valuable contributions, since they allow us to notice and fix
 127 problems on machines/platforms we don't have, and/or remained un-noticed.
 128
 129
 130 6. REPORTING BUGS
 131 -----------------
 132 You can register with the cads bug reporting tool:
 133 http://cads.iiap.res.in/bugzilla/
 134 and file a bug report.
 135
 136 If you are too lazy, drop in an email to: cads_AT_iiap.res.in
 137
 138 Either way, please include as many details as possible.
 139
 140
 141 -----------------------------------------------------------
 142 Reks, 31 Oct 2012 <reks_at_iiap.res.in>
 143       Last modified: 08 Nov 2012