.\"                                      Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2019 CSIRO <asap@atnf.csiro.au>,
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH ASAP 1 "2019-03-05"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
ASAP \- process single dish spectral data
.SH SYNOPSIS
.B asap
.SH DESCRIPTION
This manual page briefly documents the
.B asap
command. The program has internal help as well.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBasap\fP is an interactive ipython shell that lets you process
spectroscopic data from astronomical telescopes and make
publication-quality plots.
.PP
The input files can be RPFITS, SDFITS or CASA Measurement Sets.
Output can be saved as SDFITS or Measurement Set.
.PP
Running the program will create a ~/.asap directory which stores
some package state. From time to time you may have to clean this out,
after installing a new version of the package.
.SH ENVIRONMENT
You may wish to set or unset the following environment variables, to change
the program's behaviour.
.TP
.B ASAPDATA
ASAP needs access to astronomical data tables that need to be updated regularly.
These are needed to allow calculations of radial velocity, rest frequency of
various transitions, etc. The casacore packages that ASAP is built on top of
expect the data to be unpacked into this directory:
.RS

/var/lib/casacore/data

To this location you should set ASAPDATA so that the path
.NH
$ASAPDATA/ephemerides
.HY
exists.
.PP
The data files are published by the U.S. National Radio Astronomy Observatory
(NRAO), as part of the Common Astronomical Software Applications (CASA) data
processing package, but can be downloaded separately.
.PP
These data files can also be downloaded from
.TP
.NH
ftp://ftp.atnf.csiro.au/pub/software/asap/data/asap_data/tar.bz2
.HY
.RE
.TP
.B CASAPATH
The casacore routines ASAP is built on check for this environment variable
which is supposed to point to the CASA installation being used.
If CASAPATH is set in your environment, and it points to a
different data area than ASAPDATA, you may get unexpected behaviour.
If in doubt, unset it.
.SH SEE ALSO
.BR asap_update_data (1)