Changeset 3139 for trunk

Timestamp:

03/06/19 09:29:38 (6 years ago)

Author:

VincentMcIntyre

Message:

Merge notes from README.Debian into the manpage.

File:

• trunk/debian/asap.1 (modified) (1 diff)

trunk/debian/asap.1

@@ -34 +34 @@
 publication-quality plots.
 .PP
-The input files can be RPFITS, SDFITS or CASA Measurement Sets,
-output can be saved as SDFITS or Measurement Set.
+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 the following environment variables, to change
+You may wish to set or unset the following environment variables, to change
 the program's behaviour.
 .TP
 .B ASAPDATA
-Path to astronomical ephemeris data files. These are needed to allow
-calculations of radial velocity, rest frequency of various transitions, etc.
+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
-They will usually be available in your installation of CASA.
-If your casa installation is at /nfs/casa, the ephemeris data should be
-in /nfs/casa/data; set ASAPDATA to that path.
+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)