Installing PTFIDE, dependencies, and executing on PTF archive data

PTFIDE: Palomar Transient Factory Image Differencing & Extraction engine

The software is described in Masci et al. 2016


Contents of package (ptfide.tar.gz)

  - bin/ : directory containing ptfide.pl executable
  - perllib/ : directory containing perl module libraries
  - testdata/ : directory containing test input data
  - rundiff.csh : script containing test execution of ptfide.pl using data in testdata/
  - config/ : directory contain configration and parameter files
  - lib/ : directory containing "libtwoplane" library required by "xy2xytrans" module 
  - src/ : source code for "xy2xytrans" module; depends on "libtwoplane" library in lib/
  - outproducts/ : directory where products will be written; configurable in rundiff.csh

Installation Notes

* Download and unpack the gzipped tar file: ptfide.tar.gz
  - gunzip ptfide.tar.gz
  - tar -xvf ptfide.tar
  - rm ptfide.tar
  Files and directories will be unpacked under directory ./ptfide/

* Installation and execution has only been performed and verified on these
  operating systems, under a 64-bit architecture:
  - Linux (Red Hat Enterprise, versions >= 6.3)
  - Mac OSX (versions >= 10.9)

* Perl version >= 5.16 is recommended (pre-installed with most Unix-like
  operating systems)

* Install the latest version of the GNU Scientific Library (GSL) from:
  https://www.gnu.org/software/gsl/

* Install the latest cfitsio library from:
  http://heasarc.gsfc.nasa.gov/fitsio/fitsio.html 

* Install the latest wcstools library from:
  http://tdc-www.harvard.edu/software/wcstools/ 
  
* Build the "libtwoplane" library that resides under ./lib/
  Ensure the INCLUDES line in the Makefile has the full paths to the
  wcstools/libwcs and cfitsio/ libraries installed above.

* Build the "xy2xytrans" module that resides under ./src/
  Ensure the INCLUDES and LFLAGS lines in the Makefile have the full paths to
  the wcstools/libwcs and cfitsio/ libraries installed above.

* Install the "swarp" module from:
  http://www.astromatic.net/software/swarp 
  
* Install the "SExtractor" module from:
  http://www.astromatic.net/software/sextractor 

* Obtain and install the DAOPhot and AllStar Fortran modules: "doaphot" and "allstar".
  We say obtain because we initially requested these from Peter Stetson with
  a promise that we would not redistribute the code. We suggest you contact
  Peter Stetson, email: stetson@dao.nrc.ca
  More information on installation can be obtained from:
  http://www.astrobetter.com/wiki/DAOphot 
  http://www.star.bris.ac.uk/~mbt/daophot/ 

* Install the latest Perl Data Language library:
  https://sourceforge.net/projects/pdl/ 

* Install the Astro-WCS-LibWCS perl library: 
  http://search.cpan.org/~pratzlaff/Astro-WCS-LibWCS/

* Ensure that PDL and other Perl modules are visible in your environment.
  This can be done using the command "Perl -V". If not, you can add their
  paths to the PERL5LIB environment variable.

* Copy the three Perl modules that reside under ./perllib/ to a global Perl
  library installation path, i.e., returned by the command "Perl -V".

Input Data and Execution

* PTFIDE requires four types of input data files:
  - science (single epoch) image in FITS format
  - accompanying mask image for this science image in FITS format
  - overlapping reference image in FITS format
  - corresponding reference image catalog from SExtractor, converted to ASCII

  These are available from the public archive; accessible using either the GUI:
  http://irsa.ipac.caltech.edu/applications/ptf/ 
  or, command-line API by following the instructions at:
  http://www.ptf.caltech.edu/page/ibe

* Once all software is installed and all executables and library paths are
  visible from your environment, you can run a test using the cshell script
  "rundiff.csh". This uses input test data residing under ./testdata/
  
* Also, executing ptfide.pl with no command-line arguments (assuming that the
  ./bin/ directory is in your path) generates a synopsis of all inputs.

Licensing

PTFIDE is distributed under the GPL (GNU General Public License), version 3,
which means you can do what you want with it (and with the source code), and
can use/distribute without having to pay for it. Use in or with commercial
software is forbidden without written permission from the author. See the file
"COPYING" in the software package.


F. Masci, Caltech/IPAC last modified: 9/22/2016 fmasci@caltech.edu