-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
README_MAC.txt
312 lines (213 loc) · 11.4 KB
/
README_MAC.txt
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
Instructions for Importing the CSPICE Toolkit
===========================================================================
This document describes the procedure to import the CSPICE package on
INTEL MAC computers using MAC OS-X operating system and CC 64BIT
compiler. Familiarization with the CSPICE import procedure minimally
requires you read the sections "System Requirements" and "Importing the
CSPICE Package" prior to importing the CSPICE package.
We also strongly recommend that you not try to port this package to any
other environment without first consulting NAIF. By saying "porting" we
mean trying to build this package on a different computer hardware or
operating system type, or using a different compiler brand or a
different version of the compiler used to build this package, or
changing any compile options, such as optimization level, that are used
in the script(s) building the libraries included in this package.
Detailed information about the system on which this package was compiled
and tested is provided in the section "Recompiling the Toolkit" below.
In addition to this document there are two text files provided with this
package that may be of interest:
dscriptn.txt contains a description of the directory structure
and contents of the CSPICE package.
whats.new describes new features available in this version
of the CSPICE package.
System Requirements
--------------------------------------------------------
Before you begin importing the CSPICE package you should make sure that
you have approximately 150 Megabytes of free disk space. After the
Toolkit has been imported you can delete the file cspice.tar to free up
approximately half of the space used during the installation.
Applications linked against the SPICE library require more than the
default stack size. When using csh or tcsh shell, execute the command:
limit stacksize 60megabytes
or include it in a startup/config file such as a .cshrc file placed in
your home directory.
When using the bash shell, execute the command:
ulimit -s 61440
or include it in a startup/config file such as a .bashrc file placed in
your home directory.
Failure to adjust the memory allocated to the stack as described above
may result in segmentation faults when running the larger SPICE
programs.
Time for Importing.
The amount of time required to perform the import varies, but importing
typically takes a few minutes.
If you already have a CSPICE Package
You should backup and move (or remove) any previous editions of the
CSPICE Package from the directory where you plan to import this toolkit.
Otherwise this toolkit may be merged with the previous edition leading
to unpredictable results.
Importing the CSPICE Package
--------------------------------------------------------
You should move the following files to the directory where you want to
import the CSPICE Package.
cspice.tar.Z
importCSpice.csh
(Note: If you are copying the ".tar.Z" file via ftp you should copy it
in "binary" mode. Use "ascii" mode to copy the ".csh" file.)
Now type the following command.
/bin/csh -f importCSpice.csh
The script importCSpice.csh will uncompress and untar the toolkit and,
on platforms where NAIF anticipates that it is necessary, compile and
link all source code products.
If you experience problems with the import process, first refer to the
section at the end of this document entitled "Importing Problems". If
you can't resolve the import problem there, contact NAIF for assistance.
Additional Instructions
--------------------------------------------------------
For CSPICE users additional instructions regarding linking their
applications to the CSPICE library are provided in the CSPICE Required
Reading document -- ``doc/cspice.req'' (plain text format) and
``doc/html/req/cspice.html'' (HTML format) included in the package.
For Icy users additional instructions regarding registering the ICY DLM
in in IDL are provided in the ``Preparing the Environment'' section of
the ICY Required Reading document -- ``doc/icy.req'' (plain text format)
and ``doc/html/req/icy.html'' (HTML format) included in the package.
For Mice users additional instructions regarding using MICE in MATLAB
are provided in the ``Preparing the Environment'' section of the MICE
Required Reading document -- ``doc/mice.req'' (plain text format) and
``doc/html/req/mice.html'' (HTML format) included in the package.
Toolkit Documentation
--------------------------------------------------------
The Toolkit contains two styles of documentation: a plain text version
and a hyperlinked html version. NAIF recommends you use the html version
because of the convenience of the hyperlinking. To do that load the top
level index of the html documentation -- cspice/doc/html/index.html --
into a web browser.
Recompiling the Toolkit
--------------------------------------------------------
All libraries and executable programs in this package have been
pre-compiled and built for your convenience. Usually it is not necessary
to recompile them after you have imported the Toolkit -- you can link to
the libraries and run the executables ``as is''. In some cases though,
for example if you are using an earlier version of the same compiler
and/or operating system, it may be necessary to re-build the Toolkit. To
recompile all libraries and programs provided in this package, change to
the top level directory and run the ``makeall.csh'' script as follows:
/bin/csh -f makeall.csh
To recompile all Java classes (if any) provided in this package, change
to the ``src/JNISpice'' subdirectory and run the ``mkjnijava.csh''
script as follows:
/bin/csh -f mkjnijava.csh
If you experience problems performing thus(se) operation(s), contact
NAIF for further assistance.
This package has been pre-compiled on an Intel Mac workstation running
OS X 10.11.6, Darwin Kernel Version 15.6.0, using Apple C 8.0.0
(clang-800.0.42.1) compiler in 64-bit mode. The version of IDL installed
on this workstation was 8.3. The version of MATLAB installed on this
workstation was R2015a. The version of Java installed on this
workstation was 1.8.0_91.
Disclaimer
--------------------------------------------------------
THIS SOFTWARE AND ANY RELATED MATERIALS WERE CREATED BY THE CALIFORNIA
INSTITUTE OF TECHNOLOGY (CALTECH) UNDER A U.S. GOVERNMENT CONTRACT WITH
THE NATIONAL AERONAUTICS AND SPACE ADMINISTRATION (NASA). THE SOFTWARE
IS TECHNOLOGY AND SOFTWARE PUBLICLY AVAILABLE UNDER U.S. EXPORT LAWS AND
IS PROVIDED "AS-IS" TO THE RECIPIENT WITHOUT WARRANTY OF ANY KIND,
INCLUDING ANY WARRANTIES OF PERFORMANCE OR MERCHANTABILITY OR FITNESS
FOR A PARTICULAR USE OR PURPOSE (AS SET FORTH IN UNITED STATES UCC
SECTIONS 2312-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE SOFTWARE AND
RELATED MATERIALS, HOWEVER USED.
IN NO EVENT SHALL CALTECH, ITS JET PROPULSION LABORATORY, OR NASA BE
LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING, BUT NOT LIMITED TO,
INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND, INCLUDING ECONOMIC
DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS, REGARDLESS OF WHETHER
CALTECH, JPL, OR NASA BE ADVISED, HAVE REASON TO KNOW, OR, IN FACT,
SHALL KNOW OF THE POSSIBILITY.
RECIPIENT BEARS ALL RISK RELATING TO QUALITY AND PERFORMANCE OF THE
SOFTWARE AND ANY RELATED MATERIALS, AND AGREES TO INDEMNIFY CALTECH AND
NASA FOR ALL THIRD-PARTY CLAIMS RESULTING FROM THE ACTIONS OF RECIPIENT
IN THE USE OF THE SOFTWARE.
How to Contact NAIF
--------------------------------------------------------
If you have problems or suggestions you can contact NAIF via U.S. Mail,
electronic mail or phone as specified below.
U.S. Mail address:
Charles Acton
Jet Propulsion Laboratory
Navigation Ancillary Information Facility
4800 Oak Grove Drive
Mail Stop 301-125L
Pasadena, CA 91109
Electronic mail address:
Charles.H.Acton@jpl.nasa.gov
Nathaniel.J.Bachman@jpl.nasa.gov
Boris.V.Semenov@jpl.nasa.gov
Edward.D.Wright@jpl.nasa.gov
Phone number:
(818) 354-3869 (Chuck Acton)
(818) 354-7454 (Nat Bachman)
(818) 354-8136 (Boris Semenov)
(818) 354-0371 (Ed Wright)
Importing Problems
--------------------------------------------------------
Although the import script does not make a lot of assumptions about your
computing environment, it must make a few. Importing problems usually
occur because one of these assumptions is not met by the system where
the CSPICE package is being imported.
Shell Prompt
In several examples below, we will talk about interacting with the UNIX
shell. We shall assume that the shell prompts you for input by
displaying the string:
myprompt>
What your system displays will almost certainly be different.
UNIX SHELL
It is assumed that you have the UNIX C-shell installed on your machine
and that it is the normal shell you use when working on your system. It
is easy to determine if this is in fact the case. At the shell prompt
type:
myprompt> echo $shell
If you are using the C-shell, you should see the following message on
your screen.
/bin/csh
If your process responds with some other message, then either you are
not using the C-shell, or its not in the expected location. To see if
you have the C-shell available on your system type the following
command.
myprompt> ls -1 /bin/csh
You should get the following response from your process.
/bin/csh*
If you don't get this, your system doesn't satisfy the import script
assumptions. You can't import the CSPICE package using these
instructions.
uncompress and tar
The CSPICE package is delivered via a compressed "tar" file. You must
have the "uncompress" and "tar" program present on your system to import
the toolkit. You can find out if you have these programs by typing:
mypropmt> which uncompress
myprompt> which tar
Your system should respond with messages similar to the following
/usr/bin/uncompress
/usr/bin/tar
If it doesn't you won't be able to extract the toolkit from the "tar"
file.
C compiler
It is assumed that you have a working Apple C compiler and that your
environment is set up so that you can simply type "cc" to invoke the
compiler. Moreover, it is assumed that "cc" is not an alias. You can
determine whether or not "cc" is an alias for some other command by
typing:
myprompt> alias cc
If cc is an not an alias, the shell responds by re-issuing the shell
prompt. In this case you've passed the last hurdle and you should be
ready to import the CSPICE package.
If "cc" is an alias, how "cc" is aliased will be displayed. In this case
you need to perform the following two commands.
myprompt> unalias cc
myprompt> which cc
The second command should yield a fully qualified path for your C
compiler. If it doesn't you need to find out which directory contains
the C compiler and add this directory to your path.
Java compiler
It is assumed that you have a working Java compiler and that your
environment is set up so that you can simply type "javac" to invoke the
compiler.