Recent Changes - Search:

edit SideBar


Chapter 5: Tempo2 command line arguments

5.1 The arguments

Tempo2 is run from the command line. Basic version information, help and a list of the available plug-in packages can be obtained by typing

 tempo2 -h

Tempo2 has a number of options that can be controlled from the command line. These are listed in Table 5.1 below:

Table 5.1: Tempo2 command line options

Parameter Meaning
-debug provides output useful for identifying problems with the software
-delete fname delete the observations listed in the file "fname" by their site-arrival-times or observation name
-clock x define the clock in conversion to TT as x
-epoch x set the epoch of the parameter file to be x (MJD)
-f x.par y.tim specifies the parameter (.par) and arrival time (.tim) files for use in subsequent processing.
-filter x filters the set of observations (see below)
-fit x turn on fitting for parameter 'x' (this command-line option can be repeated for multiple parameters)
-gr x use the 'x' graphical interface
-h display help information
-jbo tells tempo2 to expect input in the Jodrell Bank psrav.bat format
-list lists information about the residuals, time delays etc. that have been used or calculated by tempo2
-machine x define the processor being used
-name x define the pulsar name to be 'x' - ignoring what is in the parameter file
-newpar produces a new .par file from the fitted parameters
-nobs re-defines the maximum number of observation to be stored simultaneously in memory
-nofit switch off the fitting algorithms
-noWarnings switch off the displayed warnings
-npsr re-defines the maximum number of pulsars to be stored simultaneously in memory
-output name uses the "name" plugin instead of displaying the standard tempo2 output
-polyco runs tempo2 in predictive mode
-pre only calculates the pre-fit residuals
-residuals outputs the residuals to a file called "residuals.dat"
-set X a set the parameter X to the value 'a' (ignoring the value in the parameter file)
-tempo1 enables tempo1 compatibility mode (note: this gets overwritten by the EPHVER key word in the par file!)

5.2 The tempo1 emulation mode

In the tempo1 compatability mode the following parameters are automatically set (these can also be set manually in the parameter file)

  • NE_SW 9.961

The use of EPHVER 2 in the parameter file will also make tempo2 use the tempo1 emulation mode. Note: the majority of the ephemerides in the pulsar catalogue are in tempo1 format and so automatically include EPHVER 2 in the output ephemeris.

NOTE: the EPHVER keyword overwrites the -tempo1 command-line argument, as the par file does not get transformed. "-tempo1" only has an effect if the EPHVER keyword is absent from the par file.

5.3 Filtering

It is often useful to be able to filter the observation file before processing. For instance, an observer may use multiple back-end systems or observatories. These can be defined using "flags":

 ../archives/n2003-01-10-17:07:45.FTp 1340.749 52649.7257990374280   0.67 7  -i nCPSR2_20
 ../archives/w040206_150608.cFTp 3067.999 53041.6404217220093  34.43 7  -i WBC_10
 ../archives/w040206_160503.cFTp 3067.999 53041.6813940348552  42.73 7  -i WBC_10
 ../archives/w040207_133403.cFTp 1421.439 53042.5667819871316   6.92 7  -i WBC_20
 ../archives/w040207_134155.cFTp 1417.998 53042.5819726383262   4.59 7  -i WBC_20 

If all the WBC_10 and nCPSR2_20 observations should be ignored then use

 tempo2 -f mypar.par mytim.tim -filter "-i nCPSR2_20 WBC_10"

5.4 Aliases

Occassionally the user must repeatedly run the same tempo2 command which contains multiple arguments. This can be simplified with the use of aliases. Aliases are placed in a file called $TEMPO2/alias.dat as follows:

 -jodrell -f psrav.eph psrav.bat -jbo -del psrav.del
 -quick -newpar -gr plk

The user can then type

 tempo2 -jodrell -gr plk

instead of

 tempo2 -f psrav.eph psrav.bat -jbo -del psrav.del -gr plk

Edit - History - Print - Recent Changes - Search
Page last modified on December 02, 2010, at 07:34 PM