README
1Astro::PAL -- interface to Starlink PAL C library
2==========
3
4This module provides an interface layer to the Starlink PAL positional
5astronomy library.
6
7An example program, stime, is provided. This simply reports the
8current time (modified Julian day and local sidereal time for the JCMT).
9
10Requirements:
11-------------
12
13A C compiler is required but the SOFA and PAL source code are included
14with the distribution and will be built automatically.
15
16Installation:
17-------------
18
19 % perl Build.PL
20 % ./Build
21 % ./Build test
22 % ./Build install
23
24The tests only test part of the build. Some functions remain untested.
25
26See Astro::Coords for a general object-oriented wrapper around Astro::PAL.
27
28Documentation:
29--------------
30
31The module provides documentation on how to use the perl interface
32to PAL. It does not contain information on how to use
33PAL itself.
34
35The basic PAL documentation can be found at
36
37 http://www.starlink.ac.uk/star/docs/sun267.htx/sun267.html
38
39For more information the SLA documentation provides much more
40detail:
41
42 http://www.starlink.ac.uk/star/docs/sun67.htx/sun67.html
43
44A description paper for PAL was published in the ADASS XXII
45conference proceedings:
46
47 http://adsabs.harvard.edu/abs/2013ASPC..475..307J
48
49Please consider citing this if you use PAL or this module in your
50research.
51
52Copyright
53---------
54
55Copyright (C) 2014 Tim Jenness
56Copyright (C) 2012 Tim Jenness and the Science and Technology Facilities
57Council. All rights reserved.
58
59This program is free software; you can redistribute it and/or modify it under
60the terms of the GNU General Public License as published by the Free Software
61Foundation; either version 3 of the License, or (at your option) any later
62version.
63
64This program is distributed in the hope that it will be useful,but WITHOUT ANY
65WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
66PARTICULAR PURPOSE. See the GNU General Public License for more details.
67
68You should have received a copy of the GNU General Public License along with
69this program; if not, write to the Free Software Foundation, Inc., 59 Temple
70Place,Suite 330, Boston, MA 02111-1307, USA
71
72The array handling code was written by Karl Glazebrook.
73