[158] | 1 | \secA{Obtaining and installing \duchamp} |
---|
| 2 | \label{app-install} |
---|
| 3 | |
---|
[208] | 4 | \secB{Installing} |
---|
[158] | 5 | The \duchamp\ web page can be found at the following location:\\ |
---|
| 6 | \href{http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp}% |
---|
| 7 | {http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp}\\ |
---|
| 8 | Here you can find a gzipped tar archive of the source code that can be |
---|
| 9 | downloaded and extracted, as well as this User's Guide in postscript |
---|
| 10 | and hyperlinked PDF formats. |
---|
| 11 | |
---|
| 12 | To build \duchamp, you will need three main external libraries: |
---|
[168] | 13 | \textsc{pgplot}, \textsc{cfitsio} (this needs to be version 2.5 or |
---|
| 14 | greater -- version 3+ is better) and \textsc{wcslib}. If these are not |
---|
| 15 | present on your system, you can download them from the following |
---|
| 16 | locations: |
---|
[158] | 17 | \begin{itemize} |
---|
| 18 | \item \textsc{pgplot}: |
---|
| 19 | \href{http://www.astro.caltech.edu/~tjp/pgplot/}% |
---|
| 20 | {http://www.astro.caltech.edu/~tjp/pgplot/} |
---|
| 21 | \item \textsc{cfitsio}: |
---|
| 22 | \href{http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html}% |
---|
| 23 | {http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html} |
---|
| 24 | \item \textsc{wcslib}: |
---|
| 25 | \href{http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html}% |
---|
| 26 | {http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html} |
---|
| 27 | \end{itemize} |
---|
| 28 | |
---|
| 29 | \duchamp\ can be built on Unix/Linux systems by typing (assuming that |
---|
| 30 | the prompt your terminal provides is a \texttt{> } -- don't type this |
---|
| 31 | character!): |
---|
| 32 | \begin{quote} |
---|
| 33 | \texttt{% |
---|
| 34 | > ./configure\\ |
---|
| 35 | > make\\ |
---|
| 36 | > make clean (optional -- to remove the object files)} |
---|
| 37 | \end{quote} |
---|
| 38 | |
---|
| 39 | Run in this manner, \texttt{configure} should find all the necessary |
---|
| 40 | libraries, but if some libraries have been installed in non-standard |
---|
| 41 | locations, it may fail. In this case, you can specify additional |
---|
| 42 | directories to look in by giving extra command-line arguments. There |
---|
| 43 | are separate options for library files (eg. libcpgplot.a) and header |
---|
| 44 | files (eg. cpgplot.h). |
---|
| 45 | |
---|
| 46 | For example, suppose \textsc{wcslib} had been locally installed in |
---|
| 47 | \texttt{/home/mduchamp/wcslib}. There will then be two libraries |
---|
| 48 | created that are likely to be in the following subdirectories: |
---|
| 49 | \texttt{C/} and \texttt{pgsbox/}. Each subdirectory needs to be |
---|
| 50 | searched for library and header files, so one could build Duchamp by |
---|
| 51 | typing: |
---|
| 52 | \begin{quote} |
---|
| 53 | \texttt{% |
---|
| 54 | > ./configure $\backslash$ \\ |
---|
| 55 | LIBDIRS="/home/mduchamp/wcslib/C /home/mduchamp/wcslib/pgsbox" |
---|
| 56 | $\backslash$\\ |
---|
| 57 | INCDIRS="/home/mduchamp/wcslib/C /home/mduchamp/wcslib/pgsbox"} |
---|
| 58 | \end{quote} |
---|
| 59 | And then just run make in the usual fashion: |
---|
| 60 | \begin{quote} |
---|
| 61 | \texttt{> make} |
---|
| 62 | \end{quote} |
---|
| 63 | |
---|
| 64 | This will produce the executable \texttt{Duchamp}. You can verify that |
---|
| 65 | it is running correctly by running the verification shell script: |
---|
| 66 | \begin{quote} |
---|
| 67 | \texttt{> VerifyDuchamp.sh} |
---|
| 68 | \end{quote} |
---|
| 69 | This will use a dummy FITS image in the \texttt{verification/} |
---|
| 70 | directory -- this image has some Gaussian random noise, with five |
---|
| 71 | Gaussian sources present, plus a dummy WCS. The script runs |
---|
| 72 | Duchamp on this image with three different sets of inputs, and |
---|
| 73 | compares to known results, looking for differences and reporting |
---|
| 74 | any. There should be none reported if everything is working correctly. |
---|
| 75 | |
---|
[208] | 76 | \secB{Running \duchamp} |
---|
[158] | 77 | You can then run \duchamp\ on your own data. This can be done in one |
---|
| 78 | of two ways. The first is: |
---|
| 79 | \begin{quote} |
---|
| 80 | \texttt{> Duchamp -f [FITS file]} |
---|
| 81 | \end{quote} |
---|
| 82 | where \texttt{[FITS file]} is the file you wish to search. This method |
---|
| 83 | simply uses the default values of all parameters. |
---|
| 84 | |
---|
| 85 | The second method allows some determination of the parameter values by |
---|
| 86 | the user. Type: |
---|
| 87 | \begin{quote} |
---|
| 88 | \texttt{> Duchamp -p [parameter file]} |
---|
| 89 | \end{quote} |
---|
| 90 | where \texttt{[parameterFile]} is a file with the input parameters, |
---|
| 91 | including the name of the cube you want to search. There are two |
---|
| 92 | example input files included with the distribution. The smaller one, |
---|
| 93 | \texttt{InputExample}, shows the typical parameters one might want to |
---|
| 94 | set. The large one, \texttt{InputComplete}, lists all possible |
---|
| 95 | parameters that can be entered, and a brief description of them. To |
---|
| 96 | get going quickly, just replace the "your-file-here" in |
---|
| 97 | \texttt{InputExample} with your image name, and type |
---|
| 98 | \begin{quote} |
---|
| 99 | \texttt{> Duchamp -p InputExample} |
---|
| 100 | \end{quote} |
---|
| 101 | |
---|
| 102 | The following appendices provide details on the individual parameters, |
---|
| 103 | and show examples of the output files that \duchamp\ produces. |
---|
[208] | 104 | |
---|
| 105 | \secB{Feedback} |
---|
| 106 | It may happen that you discover bugs or problems with \duchamp, or you |
---|
| 107 | have suggestions for improvements or additional features to be |
---|
| 108 | included in future releases. You can submit a ``ticket'' (a trackable |
---|
| 109 | bug report) at the \duchamp\ Trac wiki at the following location:\\ |
---|
| 110 | \href{http://sourcecode.atnf.csiro.au/cgi-bin/trac\_duchamp.cgi/simpleticket}% |
---|
| 111 | {http://sourcecode.atnf.csiro.au/cgi-bin/trac\_duchamp.cgi/simpleticket} |
---|
| 112 | (there is a link to this page from the Duchamp website). |
---|
| 113 | |
---|
| 114 | There is also an email exploder, duchamp-user\textbf{[at]}atnf.csiro.au, |
---|
| 115 | that users can subscribe to keep up to date with changes, updates, and |
---|
| 116 | other news about \duchamp. To subscribe, send an email (from the |
---|
| 117 | account you wish to subscribe to the list) to |
---|
| 118 | duchamp-user-request\textbf{[at]}atnf.csiro.au with the single word |
---|
| 119 | ``subscribe'' in the body of the message. To be removed from this |
---|
| 120 | list, send a message with ``unsubscribe'' in its body to the same |
---|
| 121 | address. |
---|
| 122 | |
---|