1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
." @(#)voclient.1 1.0 Feb-2013 MJF
.TH VOCLIENT 1 "May 2013" "VOClient Package"
.SH NAME
VOClient \- Virtual Observatory (VO) Libraries and Desktop Applications
.SH SYNOPSIS
\fBVOClient\fP is a collection of programming APIs and
command-line tools that provide a user-ready VO software distribution for
both scientists and developers. The initial release of the package is
intended primarily to distribute the completed CLI tools, additional tasks
are planned as new functionality is added to the libraries and as new
standards come on-line in the VO.
.PP
The VOClient package includes a number of command-line utilities
built from the underlying interfaces. These tasks can be scripted from any
number of environments or used in a standalone manner. Tasks distributed
in this release include:
.SH Command-Line Tools
.PP
.B Data Access Tools
.HP 16
.I voatlas
Query the SkyView Image service for an all-sky image
.HP 16
.I vocatalog
Query VO catalog services for data
.HP 16
.I vodata
Query and access VO data services
.HP 16
.I voimage
Query VO image services for data
.HP 16
.I voiminfo
Print/Get information about a FITS file's structure
.HP 16
.I vospectra
Query VO spectral services for data
.PP
.B Utility Tools
.HP 16
.I voregistry
VO Registry search client
.HP 16
.I vosesame
Call the Sesame name resolver service
.HP 16
.I vosamp
Command-line SAMP tool
.PP
.B VOTable Tools
.HP 16
.I votcnv
Convert from VOTable to another format
.HP 16
.I votget
Download URLs or access references in a VOTable
.HP 16
.I votinfo
Get information about a VOTable
.HP 16
.I votopic
Query data resources specified by topic keyword
.HP 16
.I votpos
Extract the main positional columns from a VOTable
.HP 16
.I votsort
Extract the main positional columns from a VOTable
.HP 16
.I votstat
Compute statistics for numeric columns of a VOTable.
.SH Programming Interfaces
.HP 9
.I libsamp
SAMP interface. This interface allows an application to send and receive
SAMP messages but does NOT (at this time) provide a local Hub implementation.
Applications can register their own functions to be used as callbacks in
response to a message, the API provides only the middle-ware needed to
handle the SAMP protocol.
.HP 9
.I libvoclient
Client-side VO interface. This interface uses the VOClient Daemon to access
a variety of VO web services (Registry, Sesame, DAL services, etc) which
then communicate to the API to pass information back to the application.
.HP 9
.I libvotable
VOTable parser interface. The interface provides both read (lax parsing)
and write (strict compliance) capabilities. Reference is VOTable v1.2.
.HP 9
.I libvoapps
VO Applications interface. High-level interface to application functionality.
Tasks are built on these routines to provide the cmdline user interface,
but are encapsulated in an API to provide this functionality to other
environments easily (as opposed to having that functionality
be re-implemented using the low-level interfaces).
.SS Dependency Libraries
.HP 16
.I libcurl
SAMP interface
.HP 16
.I libcfitsio
C FITSIO interface
.HP 16
.I libexpat
XML parser
.HP 16
.I libxmlrpc-c
XML-RPC interface
.SH INSTALLATION
.PP
.B Using Pre-Built Binaries
.PP
Pre-built binary distributions are available containg both source and
binaries for a specific platform. These distribution names are of the form
.nf
.RS
\fIvoclient-<version>-bin.<arch>.tar.gz\fP
.RE
.fi
.PP
where \fI<arch>\fP is one of
.RS
.HP 16
.I linux
32-bit Linux systems (Fedora, Ubuntu, Debian, etc).
.HP 16
.I linux64
64-bit Linux systems (Fedora, Ubuntu, Debian, etc).
.HP 16
.I macosx
32-bit OSX 10.6 and higher systems for Mac.
.HP 16
.I macintel
64-bit OSX 10.6 and higher systems for Mac.
.RE
.PP
The distribution file may be unpacked with the command
.nf
.RS
tar zxf /\fI<path>\fP/voclient-\fI<version>\fP-bin.\fI<arch>\fP.tar.gz
.RE
.fi
.PP
This will produce a '\fIvoclient\fP' subdirectory containing the unpacked
distribution. Within that directory you'll find the following important
directories needed to install the package on the system:
.HP 12
.I bin/
Task binaries
.HP 12
.I lib/
API library files
.HP 12
.I include/
Program header files
.PP
The contents of these directories should be copied to some system directory
available in the normal user paths. For example, to install in /usr/local
.nf
.RS
% cd /<path>/voclient
% sudo cp bin/* /usr/local/bin
% sudo cp lib/* /usr/local/lib
% sudo cp include/* /usr/local/include
.RE
.fi
.PP
When compiling new applications the appropriate '-I' and '-L' flags will
need to be set to find the libraries and include files needed. The binary
installation directory should be some directory in the normal $PATH
environment setting.
.B Building VOClient from Source
.PP
The source distribution of the release is containe in the file
.nf
.RS
\fIvoclient-src.tar.gz\fP
.RE
.fi
.PP
It may be unpacked with the command
.nf
.RS
\fItar zxf /<path>/voclient-src.tar.gz\fP
.RE
.fi
.PP
This will produce a 'voclient' subdirectory containing the unpacked
distribution. Utility scripts are used throughout the system to do the
platform configuration necessary, therefore the only command needed to
build the package is:
.nf
.RS
% cd /<path>/voclient
% make
.RE
.fi
.PP
As with the pre-built binary described above, the following important
directories are needed to install the package on the system:
.nf
.RS
bin/ Task binaries
lib/ API library files
include/ Program header files
.RE
.fi
.PP
In a successful build the libraries and binaries are installed in the
package 'bin' and 'lib' directories, header files needed for program
development are put in the 'include' directory. The contents of these
directories should be copied to some system directory available in the
normal user paths. For example, to install in /usr/local
.nf
.RS
% cd /<path>/voclient
% sudo cp bin/* /usr/local/bin
% sudo cp lib/* /usr/local/lib
% sudo cp include/* /usr/local/include
.RE
.fi
.PP
When compiling new applications the appropriate '-I' and '-L' flags will
need to be set to find the libraries and include files needed. The binary
installation directory should be some directory in the normal $PATH
environment setting.
.B Supported Platforms
.PP
This release currently supports the following platforms:
.nf
.RS
Mac OSX 32-bit and 64-bit Intel, OSX 10.6 and later
Linux 32-bit 32-bit Linux systems (Fedora, Redhat, Ubuntu, etc)
Linux 64-bit 64-bit Linux systems (Fedora, Redhat, Ubuntu, etc)
.RE
.fi
.PP
Additional platforms will be added as needed.
.SH BUGS
This is the first public release
.SH REVISION HISTORY
May 2013 - First public release
.SH AUTHOR
Michael Fitzpatrick (fitz@noao.edu), May 2013
.SH "SEE ALSO"
voatlas, vocatalog, vodata, voimage, votiminfo, voregistry, vosesame, vospectra, votcnv, votget, votinfo, votopic, votpos, votsort, votstat, vosamp
|
