[158] | 1 | \secA{Obtaining and installing \duchamp} |
---|
| 2 | \label{app-install} |
---|
| 3 | |
---|
[208] | 4 | \secB{Installing} |
---|
[258] | 5 | The \duchamp web page can be found at the following location:\\ |
---|
[158] | 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/}% |
---|
[231] | 20 | {\footnotesize http://www.astro.caltech.edu/~tjp/pgplot/} |
---|
[158] | 21 | \item \textsc{cfitsio}: |
---|
| 22 | \href{http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html}% |
---|
[231] | 23 | {\footnotesize http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html} |
---|
[158] | 24 | \item \textsc{wcslib}: |
---|
| 25 | \href{http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html}% |
---|
[231] | 26 | {\footnotesize http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html} |
---|
[158] | 27 | \end{itemize} |
---|
| 28 | |
---|
[258] | 29 | \duchamp can be built on Unix/Linux systems by typing (assuming that |
---|
[158] | 30 | the prompt your terminal provides is a \texttt{> } -- don't type this |
---|
| 31 | character!): |
---|
| 32 | \begin{quote} |
---|
[231] | 33 | {\footnotesize |
---|
[158] | 34 | \texttt{% |
---|
| 35 | > ./configure\\ |
---|
| 36 | > make\\ |
---|
| 37 | > make clean (optional -- to remove the object files)} |
---|
[231] | 38 | } |
---|
[158] | 39 | \end{quote} |
---|
| 40 | |
---|
| 41 | Run in this manner, \texttt{configure} should find all the necessary |
---|
| 42 | libraries, but if some libraries have been installed in non-standard |
---|
| 43 | locations, it may fail. In this case, you can specify additional |
---|
| 44 | directories to look in by giving extra command-line arguments. There |
---|
| 45 | are separate options for library files (eg. libcpgplot.a) and header |
---|
| 46 | files (eg. cpgplot.h). |
---|
| 47 | |
---|
[231] | 48 | For example, suppose \textsc{wcslib} had been locally installed in the |
---|
| 49 | directory \texttt{/home/mduchamp/wcslib}. There will then be two |
---|
| 50 | libraries created that are likely to be in the following |
---|
| 51 | subdirectories: \texttt{C/} and \texttt{pgsbox/}. Each subdirectory |
---|
| 52 | needs to be searched for library and header files, so one could build |
---|
| 53 | Duchamp by typing: |
---|
[158] | 54 | \begin{quote} |
---|
[231] | 55 | {\footnotesize |
---|
[158] | 56 | \texttt{% |
---|
| 57 | > ./configure $\backslash$ \\ |
---|
| 58 | LIBDIRS="/home/mduchamp/wcslib/C /home/mduchamp/wcslib/pgsbox" |
---|
| 59 | $\backslash$\\ |
---|
| 60 | INCDIRS="/home/mduchamp/wcslib/C /home/mduchamp/wcslib/pgsbox"} |
---|
[231] | 61 | } |
---|
[158] | 62 | \end{quote} |
---|
| 63 | And then just run make in the usual fashion: |
---|
| 64 | \begin{quote} |
---|
[231] | 65 | {\footnotesize |
---|
[158] | 66 | \texttt{> make} |
---|
[231] | 67 | } |
---|
[158] | 68 | \end{quote} |
---|
| 69 | |
---|
| 70 | This will produce the executable \texttt{Duchamp}. You can verify that |
---|
| 71 | it is running correctly by running the verification shell script: |
---|
| 72 | \begin{quote} |
---|
[231] | 73 | {\footnotesize |
---|
[158] | 74 | \texttt{> VerifyDuchamp.sh} |
---|
[231] | 75 | } |
---|
[158] | 76 | \end{quote} |
---|
| 77 | This will use a dummy FITS image in the \texttt{verification/} |
---|
| 78 | directory -- this image has some Gaussian random noise, with five |
---|
| 79 | Gaussian sources present, plus a dummy WCS. The script runs |
---|
| 80 | Duchamp on this image with three different sets of inputs, and |
---|
| 81 | compares to known results, looking for differences and reporting |
---|
| 82 | any. There should be none reported if everything is working correctly. |
---|
| 83 | |
---|
[208] | 84 | \secB{Running \duchamp} |
---|
[258] | 85 | You can then run \duchamp on your own data. This can be done in one |
---|
[158] | 86 | of two ways. The first is: |
---|
| 87 | \begin{quote} |
---|
[231] | 88 | {\footnotesize |
---|
[158] | 89 | \texttt{> Duchamp -f [FITS file]} |
---|
[231] | 90 | } |
---|
[158] | 91 | \end{quote} |
---|
| 92 | where \texttt{[FITS file]} is the file you wish to search. This method |
---|
| 93 | simply uses the default values of all parameters. |
---|
| 94 | |
---|
| 95 | The second method allows some determination of the parameter values by |
---|
| 96 | the user. Type: |
---|
| 97 | \begin{quote} |
---|
[231] | 98 | {\footnotesize |
---|
[158] | 99 | \texttt{> Duchamp -p [parameter file]} |
---|
[231] | 100 | } |
---|
[158] | 101 | \end{quote} |
---|
| 102 | where \texttt{[parameterFile]} is a file with the input parameters, |
---|
| 103 | including the name of the cube you want to search. There are two |
---|
| 104 | example input files included with the distribution. The smaller one, |
---|
| 105 | \texttt{InputExample}, shows the typical parameters one might want to |
---|
| 106 | set. The large one, \texttt{InputComplete}, lists all possible |
---|
| 107 | parameters that can be entered, and a brief description of them. To |
---|
[231] | 108 | get going quickly, just replace the \texttt{"your-file-here"} in the |
---|
| 109 | \texttt{InputExample} file with your image name, and type |
---|
[158] | 110 | \begin{quote} |
---|
[231] | 111 | {\footnotesize |
---|
[158] | 112 | \texttt{> Duchamp -p InputExample} |
---|
[231] | 113 | } |
---|
[158] | 114 | \end{quote} |
---|
| 115 | |
---|
| 116 | The following appendices provide details on the individual parameters, |
---|
[258] | 117 | and show examples of the output files that \duchamp produces. |
---|
[208] | 118 | |
---|
| 119 | \secB{Feedback} |
---|
| 120 | It may happen that you discover bugs or problems with \duchamp, or you |
---|
| 121 | have suggestions for improvements or additional features to be |
---|
| 122 | included in future releases. You can submit a ``ticket'' (a trackable |
---|
[258] | 123 | bug report) at the \duchamp Trac wiki at the following location:\\ |
---|
[231] | 124 | \href{http://sourcecode.atnf.csiro.au/cgi-bin/trac\_duchamp.cgi/newticket}% |
---|
| 125 | {\footnotesize |
---|
| 126 | http://sourcecode.atnf.csiro.au/cgi-bin/trac\_duchamp.cgi/newticket} |
---|
| 127 | \\(there is a link to this page from the Duchamp website). |
---|
[208] | 128 | |
---|
| 129 | There is also an email exploder, duchamp-user\textbf{[at]}atnf.csiro.au, |
---|
| 130 | that users can subscribe to keep up to date with changes, updates, and |
---|
| 131 | other news about \duchamp. To subscribe, send an email (from the |
---|
| 132 | account you wish to subscribe to the list) to |
---|
| 133 | duchamp-user-request\textbf{[at]}atnf.csiro.au with the single word |
---|
| 134 | ``subscribe'' in the body of the message. To be removed from this |
---|
| 135 | list, send a message with ``unsubscribe'' in its body to the same |
---|
| 136 | address. |
---|
| 137 | |
---|
[264] | 138 | \secB{Beta Versions} |
---|
| 139 | |
---|
| 140 | On the \duchamp website there may be a beta version listed in the |
---|
| 141 | downloads section. As \duchamp is still under development, there will |
---|
| 142 | be times when there has been new functionality added to the code, but |
---|
| 143 | the time has not yet come to release a new minor (or indeed major) |
---|
| 144 | version. |
---|
| 145 | |
---|
| 146 | Sometimes I will post the updated version of the code on the website |
---|
| 147 | as a ``beta'' version, particularly if I'm interested in people |
---|
| 148 | testing it. It will not have been tested as rigorously as the proper |
---|
| 149 | releases, but it will certainly work in the basic cases that I use to |
---|
| 150 | test it during development. So feel free to give it a try -- the |
---|
| 151 | \texttt{CHANGES} file will usually detail what is different to the last |
---|
| 152 | numbered release. |
---|