[303] | 1 | % ----------------------------------------------------------------------- |
---|
| 2 | % app-install.tex: Section about how to download, install and run |
---|
| 3 | % Duchamp. |
---|
| 4 | % ----------------------------------------------------------------------- |
---|
| 5 | % Copyright (C) 2006, Matthew Whiting, ATNF |
---|
| 6 | % |
---|
| 7 | % This program is free software; you can redistribute it and/or modify it |
---|
| 8 | % under the terms of the GNU General Public License as published by the |
---|
| 9 | % Free Software Foundation; either version 2 of the License, or (at your |
---|
| 10 | % option) any later version. |
---|
| 11 | % |
---|
| 12 | % Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
| 13 | % ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
| 14 | % FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
| 15 | % for more details. |
---|
| 16 | % |
---|
| 17 | % You should have received a copy of the GNU General Public License |
---|
| 18 | % along with Duchamp; if not, write to the Free Software Foundation, |
---|
| 19 | % Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
| 20 | % |
---|
| 21 | % Correspondence concerning Duchamp may be directed to: |
---|
| 22 | % Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
| 23 | % Postal address: Dr. Matthew Whiting |
---|
| 24 | % Australia Telescope National Facility, CSIRO |
---|
| 25 | % PO Box 76 |
---|
| 26 | % Epping NSW 1710 |
---|
| 27 | % AUSTRALIA |
---|
| 28 | % ----------------------------------------------------------------------- |
---|
[158] | 29 | \secA{Obtaining and installing \duchamp} |
---|
| 30 | \label{app-install} |
---|
| 31 | |
---|
[208] | 32 | \secB{Installing} |
---|
[258] | 33 | The \duchamp web page can be found at the following location:\\ |
---|
[158] | 34 | \href{http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp}% |
---|
| 35 | {http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp}\\ |
---|
| 36 | Here you can find a gzipped tar archive of the source code that can be |
---|
| 37 | downloaded and extracted, as well as this User's Guide in postscript |
---|
| 38 | and hyperlinked PDF formats. |
---|
| 39 | |
---|
| 40 | To build \duchamp, you will need three main external libraries: |
---|
[168] | 41 | \textsc{pgplot}, \textsc{cfitsio} (this needs to be version 2.5 or |
---|
| 42 | greater -- version 3+ is better) and \textsc{wcslib}. If these are not |
---|
| 43 | present on your system, you can download them from the following |
---|
| 44 | locations: |
---|
[158] | 45 | \begin{itemize} |
---|
| 46 | \item \textsc{pgplot}: |
---|
| 47 | \href{http://www.astro.caltech.edu/~tjp/pgplot/}% |
---|
[231] | 48 | {\footnotesize http://www.astro.caltech.edu/~tjp/pgplot/} |
---|
[158] | 49 | \item \textsc{cfitsio}: |
---|
| 50 | \href{http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html}% |
---|
[231] | 51 | {\footnotesize http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html} |
---|
[158] | 52 | \item \textsc{wcslib}: |
---|
| 53 | \href{http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html}% |
---|
[231] | 54 | {\footnotesize http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html} |
---|
[158] | 55 | \end{itemize} |
---|
| 56 | |
---|
[338] | 57 | \secC{Basic installation} |
---|
| 58 | |
---|
[258] | 59 | \duchamp can be built on Unix/Linux systems by typing (assuming that |
---|
[158] | 60 | the prompt your terminal provides is a \texttt{> } -- don't type this |
---|
| 61 | character!): |
---|
| 62 | \begin{quote} |
---|
[231] | 63 | {\footnotesize |
---|
[158] | 64 | \texttt{% |
---|
| 65 | > ./configure\\ |
---|
| 66 | > make\\ |
---|
[389] | 67 | > make lib (optional -- to create a library for development |
---|
| 68 | purposes)\\ |
---|
[338] | 69 | > make clean (optional -- to remove the object files)\\ |
---|
| 70 | > make install } |
---|
[231] | 71 | } |
---|
[158] | 72 | \end{quote} |
---|
| 73 | |
---|
[338] | 74 | This default setup will search in standard locations for the necessary |
---|
[1021] | 75 | libraries, and install the executable (\texttt{Duchamp-\version}) |
---|
| 76 | in \texttt{/usr/local/bin}, along with a \texttt{Duchamp} symbolic |
---|
[968] | 77 | link (a copy will also be in the current directory). The library (if |
---|
| 78 | you've made it) will be installed in \texttt{/usr/local/lib}, and the |
---|
| 79 | full set of header files will be installed in |
---|
| 80 | \texttt{/usr/local/include/duchamp} and subdirectories thereof. If |
---|
| 81 | you want these to go somewhere else, \eg if you don't have |
---|
| 82 | write-access to that directory, or you need to tweak the libraries, |
---|
| 83 | see the next section. Otherwise, jump to the testing section. |
---|
[158] | 84 | |
---|
[338] | 85 | \secC{Tweaking the installation process} |
---|
| 86 | |
---|
[364] | 87 | The \texttt{configure} script allows the user to tailor the |
---|
| 88 | installation according to the particular requirements of their |
---|
| 89 | system. |
---|
| 90 | |
---|
[968] | 91 | To install \duchamp in a directory other than \texttt{/usr/local/bin}, |
---|
[344] | 92 | use the \texttt{--prefix} option with configure, specifying the |
---|
| 93 | directory above the \texttt{bin/} directory \eg |
---|
[158] | 94 | \begin{quote} |
---|
[231] | 95 | {\footnotesize |
---|
[158] | 96 | \texttt{% |
---|
[344] | 97 | > ./configure --prefix=/home/mduchamp} |
---|
[231] | 98 | } |
---|
[158] | 99 | \end{quote} |
---|
[389] | 100 | and then run \texttt{make}, (\texttt{make lib} if you like), and |
---|
| 101 | \texttt{make install} as stated above. This will put the binary in the |
---|
| 102 | directory \texttt{/home/mduchamp/bin}. The library, if made, will be |
---|
[1021] | 103 | put in \texttt{/home/mduchamp/lib} and the header files will be put in |
---|
[389] | 104 | \texttt{/home/mduchamp/include/duchamp} and subdirectories. |
---|
[338] | 105 | |
---|
| 106 | If the above-mentioned libraries have been installed in non-standard |
---|
| 107 | locations, or you have more than one version installed on your system, |
---|
[1021] | 108 | you can specify specific locations by using the \texttt{configure} flags |
---|
[338] | 109 | \texttt{--with-cfitsio=<dir>}, \texttt{--with-wcslib=<dir>} or |
---|
[1021] | 110 | \texttt{--with-pgplot=<dir>}. For example: |
---|
[158] | 111 | \begin{quote} |
---|
[231] | 112 | {\footnotesize |
---|
[338] | 113 | \texttt{% |
---|
| 114 | > ./configure --with-wcslib=/home/mduchamp/wcslib-4.2} |
---|
[231] | 115 | } |
---|
[158] | 116 | \end{quote} |
---|
| 117 | |
---|
[338] | 118 | Duchamp can be compiled without \textsc{pgplot} if it is not installed |
---|
| 119 | on your system -- the searching and text-based output remains the |
---|
| 120 | same, but you will not have any graphical output. To manually specify |
---|
[1021] | 121 | this option, you can either give \texttt{--without-pgplot} or |
---|
| 122 | \texttt{--with-pgplot=no} as arguments to \texttt{configure}: |
---|
[338] | 123 | \begin{quote} |
---|
| 124 | {\footnotesize |
---|
| 125 | \texttt{% |
---|
| 126 | > ./configure --without-pgplot} |
---|
| 127 | } |
---|
| 128 | \end{quote} |
---|
[320] | 129 | |
---|
[338] | 130 | (Note that CFITSIO and WCSLIB are essential, however, so flags such as |
---|
| 131 | \texttt{--without-wcslib} or \texttt{--without-cfitsio} will not |
---|
| 132 | work.). Even if you do not give the \texttt{--without-pgplot} option, |
---|
| 133 | and the \textsc{pgplot} library is not found, Duchamp will still |
---|
| 134 | compile (albeit without graphical capabilities). |
---|
| 135 | |
---|
[364] | 136 | An additional option that is useful is the ability to specify which |
---|
| 137 | compiler to use. This is very important for the Fortran compiler (used |
---|
| 138 | for linking due to the use of \textsc{pgplot}), particularly on Mac OS |
---|
| 139 | X, where \texttt{gfortran} is often used instead of \texttt{gcc}. To |
---|
| 140 | specify a particular Fortran compiler, use the \texttt{F77} flag: |
---|
| 141 | \begin{quote} |
---|
| 142 | {\footnotesize |
---|
| 143 | \texttt{% |
---|
| 144 | > ./configure F77=gfortran} |
---|
| 145 | } |
---|
| 146 | \end{quote} |
---|
| 147 | |
---|
| 148 | Of course, all desired flags should be combined in one |
---|
| 149 | \texttt{configure} call. For a full list of the options with |
---|
| 150 | \texttt{configure}, run: |
---|
| 151 | \begin{quote} |
---|
| 152 | {\footnotesize |
---|
| 153 | \texttt{% |
---|
| 154 | > ./configure --help} |
---|
| 155 | } |
---|
| 156 | \end{quote} |
---|
| 157 | Once \texttt{configure} has run correctly, simply run \texttt{make} |
---|
| 158 | and \texttt{make install} to build \duchamp and put it in the correct |
---|
[373] | 159 | place (either \texttt{/usr/local/bin} or the location given by the |
---|
| 160 | \texttt{--prefix} option discussed above). |
---|
[364] | 161 | |
---|
[338] | 162 | \secC{Making sure it all works} |
---|
| 163 | |
---|
[364] | 164 | Running make will create the executable \texttt{Duchamp-{\version}}. You can |
---|
[321] | 165 | verify that it is running correctly by running the verification shell |
---|
| 166 | script: |
---|
[158] | 167 | \begin{quote} |
---|
[231] | 168 | {\footnotesize |
---|
[382] | 169 | \texttt{> ./VerifyDuchamp.sh} |
---|
[231] | 170 | } |
---|
[158] | 171 | \end{quote} |
---|
| 172 | This will use a dummy FITS image in the \texttt{verification/} |
---|
| 173 | directory -- this image has some Gaussian random noise, with five |
---|
| 174 | Gaussian sources present, plus a dummy WCS. The script runs |
---|
[279] | 175 | Duchamp on this image with four different sets of inputs, and |
---|
[158] | 176 | compares to known results, looking for differences and reporting |
---|
[382] | 177 | any. There should be none reported if everything is working |
---|
| 178 | correctly. You can then install \duchamp on your system via: |
---|
| 179 | \begin{quote} |
---|
| 180 | {\footnotesize |
---|
| 181 | \texttt{> make install} |
---|
| 182 | } |
---|
| 183 | \end{quote} |
---|
[158] | 184 | |
---|
[208] | 185 | \secB{Running \duchamp} |
---|
[258] | 186 | You can then run \duchamp on your own data. This can be done in one |
---|
[158] | 187 | of two ways. The first is: |
---|
| 188 | \begin{quote} |
---|
[231] | 189 | {\footnotesize |
---|
[158] | 190 | \texttt{> Duchamp -f [FITS file]} |
---|
[231] | 191 | } |
---|
[158] | 192 | \end{quote} |
---|
| 193 | where \texttt{[FITS file]} is the file you wish to search. This method |
---|
| 194 | simply uses the default values of all parameters. |
---|
| 195 | |
---|
| 196 | The second method allows some determination of the parameter values by |
---|
| 197 | the user. Type: |
---|
| 198 | \begin{quote} |
---|
[231] | 199 | {\footnotesize |
---|
[158] | 200 | \texttt{> Duchamp -p [parameter file]} |
---|
[231] | 201 | } |
---|
[158] | 202 | \end{quote} |
---|
| 203 | where \texttt{[parameterFile]} is a file with the input parameters, |
---|
| 204 | including the name of the cube you want to search. There are two |
---|
| 205 | example input files included with the distribution. The smaller one, |
---|
| 206 | \texttt{InputExample}, shows the typical parameters one might want to |
---|
| 207 | set. The large one, \texttt{InputComplete}, lists all possible |
---|
| 208 | parameters that can be entered, and a brief description of them. To |
---|
[231] | 209 | get going quickly, just replace the \texttt{"your-file-here"} in the |
---|
| 210 | \texttt{InputExample} file with your image name, and type |
---|
[158] | 211 | \begin{quote} |
---|
[231] | 212 | {\footnotesize |
---|
[158] | 213 | \texttt{> Duchamp -p InputExample} |
---|
[231] | 214 | } |
---|
[158] | 215 | \end{quote} |
---|
| 216 | |
---|
[294] | 217 | To disable the use of X-window plotting (in displaying the map of |
---|
[298] | 218 | detections), one can either set the parameter \texttt{flagXOutput = |
---|
| 219 | false} or use the \texttt{-x} command-line option: |
---|
[294] | 220 | \begin{quote} |
---|
| 221 | {\footnotesize |
---|
| 222 | \texttt{> Duchamp -x -p [parameter file]} |
---|
| 223 | }, or\\ |
---|
| 224 | {\footnotesize |
---|
| 225 | \texttt{> Duchamp -x -f [FITS file]} |
---|
| 226 | } |
---|
| 227 | \end{quote} |
---|
| 228 | |
---|
[158] | 229 | The following appendices provide details on the individual parameters, |
---|
[258] | 230 | and show examples of the output files that \duchamp produces. |
---|
[208] | 231 | |
---|
| 232 | \secB{Feedback} |
---|
| 233 | It may happen that you discover bugs or problems with \duchamp, or you |
---|
| 234 | have suggestions for improvements or additional features to be |
---|
| 235 | included in future releases. You can submit a ``ticket'' (a trackable |
---|
[258] | 236 | bug report) at the \duchamp Trac wiki at the following location:\\ |
---|
[447] | 237 | \href{http://svn.atnf.csiro.au/trac/duchamp/newticket}% |
---|
| 238 | {http://svn.atnf.csiro.au/trac/duchamp/newticket} |
---|
[231] | 239 | \\(there is a link to this page from the Duchamp website). |
---|
[208] | 240 | |
---|
| 241 | There is also an email exploder, duchamp-user\textbf{[at]}atnf.csiro.au, |
---|
| 242 | that users can subscribe to keep up to date with changes, updates, and |
---|
| 243 | other news about \duchamp. To subscribe, send an email (from the |
---|
| 244 | account you wish to subscribe to the list) to |
---|
| 245 | duchamp-user-request\textbf{[at]}atnf.csiro.au with the single word |
---|
| 246 | ``subscribe'' in the body of the message. To be removed from this |
---|
| 247 | list, send a message with ``unsubscribe'' in its body to the same |
---|
| 248 | address. |
---|
| 249 | |
---|
[264] | 250 | \secB{Beta Versions} |
---|
| 251 | |
---|
| 252 | On the \duchamp website there may be a beta version listed in the |
---|
| 253 | downloads section. As \duchamp is still under development, there will |
---|
| 254 | be times when there has been new functionality added to the code, but |
---|
| 255 | the time has not yet come to release a new minor (or indeed major) |
---|
| 256 | version. |
---|
| 257 | |
---|
| 258 | Sometimes I will post the updated version of the code on the website |
---|
| 259 | as a ``beta'' version, particularly if I'm interested in people |
---|
| 260 | testing it. It will not have been tested as rigorously as the proper |
---|
| 261 | releases, but it will certainly work in the basic cases that I use to |
---|
| 262 | test it during development. So feel free to give it a try -- the |
---|
| 263 | \texttt{CHANGES} file will usually detail what is different to the last |
---|
| 264 | numbered release. |
---|
[968] | 265 | |
---|
| 266 | %%% Local Variables: |
---|
| 267 | %%% mode: latex |
---|
| 268 | %%% TeX-master: "Guide" |
---|
| 269 | %%% End: |
---|