| 1 | .\" Hey, EMACS: -*- nroff -*- |
|---|
| 2 | .\" (C) Copyright 2019 CSIRO <asap@atnf.csiro.au>, |
|---|
| 3 | .\" |
|---|
| 4 | .\" First parameter, NAME, should be all caps |
|---|
| 5 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
|---|
| 6 | .\" other parameters are allowed: see man(7), man(1) |
|---|
| 7 | .TH ASAP 1 "2019-03-05" |
|---|
| 8 | .\" Please adjust this date whenever revising the manpage. |
|---|
| 9 | .\" |
|---|
| 10 | .\" Some roff macros, for reference: |
|---|
| 11 | .\" .nh disable hyphenation |
|---|
| 12 | .\" .hy enable hyphenation |
|---|
| 13 | .\" .ad l left justify |
|---|
| 14 | .\" .ad b justify to both left and right margins |
|---|
| 15 | .\" .nf disable filling |
|---|
| 16 | .\" .fi enable filling |
|---|
| 17 | .\" .br insert line break |
|---|
| 18 | .\" .sp <n> insert n+1 empty lines |
|---|
| 19 | .\" for manpage-specific macros, see man(7) |
|---|
| 20 | .SH NAME |
|---|
| 21 | ASAP \- process single dish spectral data |
|---|
| 22 | .SH SYNOPSIS |
|---|
| 23 | .B asap |
|---|
| 24 | .SH DESCRIPTION |
|---|
| 25 | This manual page briefly documents the |
|---|
| 26 | .B asap |
|---|
| 27 | command. The program has internal help as well. |
|---|
| 28 | .PP |
|---|
| 29 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and |
|---|
| 30 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
|---|
| 31 | .\" respectively. |
|---|
| 32 | \fBasap\fP is an interactive ipython shell that lets you process |
|---|
| 33 | spectroscopic data from astronomical telescopes and make |
|---|
| 34 | publication-quality plots. |
|---|
| 35 | .PP |
|---|
| 36 | The input files can be RPFITS, SDFITS or CASA Measurement Sets. |
|---|
| 37 | Output can be saved as SDFITS or Measurement Set. |
|---|
| 38 | .PP |
|---|
| 39 | Running the program will create a ~/.asap directory which stores |
|---|
| 40 | some package state. From time to time you may have to clean this out, |
|---|
| 41 | after installing a new version of the package. |
|---|
| 42 | .SH ENVIRONMENT |
|---|
| 43 | You may wish to set or unset the following environment variables, to change |
|---|
| 44 | the program's behaviour. |
|---|
| 45 | .TP |
|---|
| 46 | .B ASAPDATA |
|---|
| 47 | ASAP needs access to astronomical data tables that need to be updated regularly. |
|---|
| 48 | These are needed to allow calculations of radial velocity, rest frequency of |
|---|
| 49 | various transitions, etc. The casacore packages that ASAP is built on top of |
|---|
| 50 | expect the data to be unpacked into this directory: |
|---|
| 51 | .RS |
|---|
| 52 | |
|---|
| 53 | /var/lib/casacore/data |
|---|
| 54 | |
|---|
| 55 | To this location you should set ASAPDATA so that the path |
|---|
| 56 | .NH |
|---|
| 57 | $ASAPDATA/ephemerides |
|---|
| 58 | .HY |
|---|
| 59 | exists. |
|---|
| 60 | .PP |
|---|
| 61 | The data files are published by the U.S. National Radio Astronomy Observatory |
|---|
| 62 | (NRAO), as part of the Common Astronomical Software Applications (CASA) data |
|---|
| 63 | processing package, but can be downloaded separately. |
|---|
| 64 | .PP |
|---|
| 65 | These data files can also be downloaded from |
|---|
| 66 | .TP |
|---|
| 67 | .NH |
|---|
| 68 | ftp://ftp.atnf.csiro.au/pub/software/asap/data/asap_data/tar.bz2 |
|---|
| 69 | .HY |
|---|
| 70 | .RE |
|---|
| 71 | .TP |
|---|
| 72 | .B CASAPATH |
|---|
| 73 | The casacore routines ASAP is built on check for this environment variable |
|---|
| 74 | which is supposed to point to the CASA installation being used. |
|---|
| 75 | If CASAPATH is set in your environment, and it points to a |
|---|
| 76 | different data area than ASAPDATA, you may get unexpected behaviour. |
|---|
| 77 | If in doubt, unset it. |
|---|
| 78 | .SH CAVEATS |
|---|
| 79 | \fBasap\fP is written in python2, which is scheduled to hit end of life |
|---|
| 80 | in the year 2020. There are no plans to migrate the code to python3. |
|---|
| 81 | .SH SEE ALSO |
|---|
| 82 | .BR asap_update_data (1) |
|---|
