PRESTO is a large suite of pulsar search and analysis software developed primarily by Scott Ransom mostly from scratch, and released under the GPL (v2). It was primarily designed to efficiently search for binary millisecond pulsars from long observations of globular clusters (although it has since been used in several surveys with short integrations and to process a lot of X-ray data as well). It is written primarily in ANSI C, with many of the recent routines in Python. According to Steve Eikenberry, PRESTO stands for: PulsaR Exploration and Search TOolkit!

PRESTO has discovered well over 1500 pulsars, including ~500 recycled and/or binary pulsars!

• Turned on OpenMP linking for rfifind! Oops.

• rfifind now gets speedup using multiple CPUs via OpenMP (Thanks to Erum Vohra!)
• Speed and parallelization improvements to accelsearch (Thanks to Erum Vohra!)
• Bug fix in reading of EPS2DOT in readpar()
• Bug fix to accelsearch when searching datasets longer than 2^32 points that caused segfaults
• Bug fix to prepdata, prepsubband, and mpiprepsubband when barycentering files longer than 2^31 points that caused segfaults
• Bug fix in prepfold where wrong fdotdot falues were reported if folding with fdotdot
• Turned off OpenMP in the dedispersion routines until I figure out how to handle that better (it works in prepfold, though!)

For information on older versions, please see the CHANGELOG.md.

PRESTO is written with portability, ease-of-use, and memory efficiency in mind, it can currently handle raw data from the following pulsar machines or formats:

• PSRFITS search-format data (as from GUPPI at the GBT, PUPPI and the Mock Spectrometers at Arecibo, and much new and archived data from Parkes)
• 1-, 2-, 4-, 8-, and 32-bit (float) filterbank format from SIGPROC
• A time series composed of single precision (i.e. 4-byte) floating point data (with a text ".inf" file describing it)
• Photon arrival times (or events) in ASCII or double-precision binary formats

Notice that the following formats which used to be supported are not:

• Wideband Arecibo Pulsar Processor (WAPP) at Arecibo
• The Parkes and Jodrell Bank 1-bit filterbank formats
• SPIGOT at the GBT
• Berkeley-Caltech Pulsar Machine (BCPM) at the GBT

If you need to process them, you can either checkout the "classic" branch of PRESTO (see below), which is not being actively developed. Or you can use DSPSR to convert those formats into SIGPROC filterbank or (even better) PSRFITS search format. You can grab DSPSR here. If you really need to get one of these machines working in modern PRESTO, let me know and we can probably make it happen.

The software is composed of numerous routines designed to handle three main areas of pulsar analysis:

1. Data Preparation: Interference detection (rfifind) and removal (zapbirds and pfdzap.py), de-dispersion (prepdata, prepsubband, and mpiprepsubband), barycentering (via TEMPO).
2. Searching: Fourier-domain acceleration and jerk (accelsearch), single-pulse (single_pulse_search.py), and phase-modulation or sideband searches (search_bin).
3. Folding: Candidate optimization (prepfold and fourier_fold.py) and Time-of-Arrival (TOA) generation (get_TOAs.py).
4. Misc: Data exploration (readfile, exploredat, explorefft), de-dispersion planning (DDplan.py), date conversion (mjd2cal, cal2mjd), tons of python pulsar/astro libraries, average pulse creation and flux density estimation (sum_profiles.py), and more...
5. Post Single Pulse Searching Tools: Grouping algorithm (rrattrap.py), Production and of single pulse diagnostic plots (make_spd.py, plot_spd.py, and waterfaller.py).

Many additional utilities are provided for various tasks that are often required when working with pulsar data such as time conversions, Fourier transforms, time series and FFT exploration, byte-swapping, etc.

References: The Fourier-Domain acceleration search technique that PRESTO uses in the routine accelsearch is described in Ransom, Eikenberry, and Middleditch (2002), the "jerk" search capability is described in Andersen & Ransom (2018), and the phase-modulation search technique used by search_bin is described in Ransom, Cordes, and Eikenberry (2003). Some other basic information about PRESTO can be found in my thesis.

Support/Docs: I may eventually get around to finishing the documentation for PRESTO (but probably not), but until then you should know that each routine returns its basic usage when you call it with no arguments. I am also willing to provide limited support via email (see below). And make sure to check out the FAQ.md!

Tutorial: There is a tutorial in the "docs" directory which walks you through all the main steps of finding pulsars using PRESTO.

The PRESTO source code is released under the GPL and can be browsed or gotten from here in many different ways (including zipped or tar'd or via git). If you are too lazy to read how to get it but have git on your system do:

git clone https://github.com/scottransom/presto.git

To update it on a regular basis do

cd $PRESTO
git pull

and then re-build things in $PRESTO.

For more detailed installation instructions, see INSTALL.md.

If you want the "classic" branch, do the following:

git clone https://github.com/scottransom/presto.git
cd presto
git checkout -b classic origin/classic

then build as per the (old) INSTALL file.

If you plan to tweak the code, I highly suggest that you use git and clone the directory (or fork it using an account on github). And if you want to contribute your changes back, please give me a "pull request"!

Code contributions and/or patches to fix bugs are most welcome!

If you use PRESTO at all, please cite it via the ASCL, which you can do using the BibTeX entry from ADS. I also request that you add a link to the PRESTO github repo. Some people are still citing my thesis, which is nice, but probably not required anymore!

In addition, if you use the specific capabilities for searching that have been published, please cite the relevant papers:

• For Fourier-domain acceleration searches: Ransom, Eikenberry, and Middleditch (2002)
• For jerk searches: Andersen & Ransom (2018)
• For sideband / phase modulation searches: Ransom, Cordes, and Eikenberry (2003)

Please let me know if you find pulsars or RRATs or FRBs with PRESTO!

Thanks!

Big thanks go to Steve Eikenberry for his help developing the algorithms, Dunc Lorimer and David Kaplan for help with (retired) code to process BCPM, SCAMP, and Spigot data, among other things, Jason Hessels and Patrick Lazarus for many contributions to the Python routines, and (alphabetical): Bridget Andersen, Anne Archibald, Cees Bassa, Matteo Bachetti, Slavko Bogdanov, Fernando Camilo, Shami Chatterjee, Kathryn Crowter, Paul Demorest, Paulo Freire, Nate Garver-Daniels, Chen Karako, Mike Keith, Maggie Livingstone, Ryan Lynch, Erik Madsen, Bradley Meyers, Gijs Molenaar, Timothy Olszanski, Chitrang Patel, Paul Ray, Alessandro Ridolfi, Paul Scholz, Maciej Serylak, Ingrid Stairs, Kevin Stovall, Nick Swainston, Joeri van Leeuwen, and Erum Vohra for many comments, suggestions and patches!

Scott Ransom sransom@nrao.edu