# Reproduction Package for the paper "TUVOpipe: a pipeline to search for UV transients with Swift-UVOT" #

This is a basic reproduction package (RP) for the paper "TUVOpipe: a pipeline to search for UV transients with Swift-UVOT".
Authors: David Modiano, Rudy Wijnands, Aastha S. Parikh, Jari van Opijnen, Sill Verberne, Marieke van Etten
Arxiv: 10.48550/arXiv.2202.10143
DOI: https://doi.org/10.5281/zenodo.5946940/
Accepted for publication in Astronomy and Astrophysics (date of acceptance: 09/02/2022)

### Raw data ###
* No raw data is included in RP since all data are public and archived online
* All UVOT data available at NASA/GCFC Archive: https://swift.gsfc.nasa.gov/archive/
* Raw UVOT images used to create many of the example figures are provided (see Figures and tables section)

### Software ###
* OS used for all analysis: Mac OS X Mojave 10.14.6
* Programming languages used: Python 3.8.8, including NumPy v1.19.2, Matplotlib v3.4.2, AstroPy 4.2
* HEAsoft version 6.28 (https://heasarc.gsfc.nasa.gov/docs/software.html)
* CALDB version 20201215 (https://heasarc.gsfc.nasa.gov/docs/heasarc/caldb/install.html)
* Hotpants (https://github.com/acbecker/hotpants)
* Astrometry.net (http://nova.astrometry.net/)
* Scikit-image register\_translation https://scikit-image.org/docs/dev/api/skimage.feature.html
* Pwkit.pdm (https://pwkit.readthedocs.io/en/latest/science/pwkit-pdm/)
* SAOImageDS9 (http://ds9.si.edu/site/Home.html)
* SExtractor (https://sextractor.readthedocs.io/en/latest/index.html)
* Transient UV Objects pipeline (TUVOpipe). Proprietary; contact ORCID ID: 0000-0002-3516-2152, email address: r.a.d.wijnands@uva.nl

### Figures and tables ###
* All figures were created using publicly archived data and the software above; methods are described in detail within the paper.
* All figures (except those figures that are standard products of the TUVOpipe pipeline, e.g. PIII lightcurves) are provided within their relevant directory in figures.zip, and can be reproduced using the scripts, and, where relevant, the raw (e.g. UVOT sky images) or intermediate (e.g. difference images shown in Section 3, ds9 region files) data provided.

### Intermediate data products ###
* Some figures, such as those in the statistics directory, were created using intermediate products gathered from over a year's worth of running the pipeline, i.e. source detection output files and image headers for all processed data. These files can be produced using public UVOT data (see Raw data section) and HEASoft (see Software section), as described in the paper. If all these files are created, the text data files necessary to produce the statistics figures can be created using the gather\_data.py script. However, we have also provided all pre-generated text files that we used to create the figures in the paper, in the figures/statistics/data_files/ directory. The scripts used to produce the figures from the text files are also available, in the figures/statistics/python/ directory.

### End-to-end analysis scripts ###
* The TUVO pipeline is not included in this RP
* All scripts, lightcurve files, and where available, intermediate data products, used to create figures (except those figures that are standard products of the TUVOpipe pipeline, e.g. PIII lightcurves) are provided within their relevant directory in figures.zip
* All UVOT data used is public and available at NASA/GCFC Archive: https://swift.gsfc.nasa.gov/archive/
