1 | |
---|
2 | R E A D M E |
---|
3 | |
---|
4 | ---------------------------------------------------------------------- |
---|
5 | Pour compiler-linker SUR MAC : |
---|
6 | |
---|
7 | > make FLAVOR=Macos |
---|
8 | |
---|
9 | Guy Le Meur |
---|
10 | ------------------------------------------------------------------------ |
---|
11 | &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& |
---|
12 | |
---|
13 | |
---|
14 | Product Name: TRANSPORT |
---|
15 | Product Version: Various |
---|
16 | Date (mm/dd/yyyy): 08/11/1999 |
---|
17 | |
---|
18 | ------------------------------------------------------------------------ |
---|
19 | |
---|
20 | ORIGIN |
---|
21 | ====== |
---|
22 | |
---|
23 | Authors |
---|
24 | |
---|
25 | D.C. Carey |
---|
26 | Fermi National Accelerator Laboratory - Mail Station 221 |
---|
27 | P.O.Box 500 |
---|
28 | Batavia, IL 60510-0500 |
---|
29 | Internet: TRANSPORT_SUPPORT@fnal.gov |
---|
30 | |
---|
31 | and |
---|
32 | K.L. Brown and Frank Rothacker |
---|
33 | Stanford Linear Accelerator Center |
---|
34 | Stanford, California 94309 |
---|
35 | |
---|
36 | Makefile mods by |
---|
37 | |
---|
38 | Chuck DeBaun |
---|
39 | Fermi National Accelerator Laboratory - MS 114 |
---|
40 | P.O. Box 500 |
---|
41 | Batavia, IL 60510-0500 |
---|
42 | Internet: TRANSPORT_SUPPORT@fnal.gov |
---|
43 | |
---|
44 | Fermilab Standard Government Sponsorship Notice |
---|
45 | |
---|
46 | This work was performed at Fermi National Accelerator Laboratory, |
---|
47 | which is operated by Universities Research Association, Inc., under |
---|
48 | contract DE-AC02-76CHO3000 with the U.S. Department of Energy. |
---|
49 | |
---|
50 | Acknowledgements |
---|
51 | |
---|
52 | We acknowledge the contribution of the following to this software: |
---|
53 | |
---|
54 | Richard Helm (SLAC) |
---|
55 | Christoph Iselin (CERN) |
---|
56 | Charles Moore (formerly of SLAC) |
---|
57 | Hal Butler (formerly of SLAC) |
---|
58 | Sam Howry (formerly of SLAC) |
---|
59 | Barbara Kear (formerly of SLAC) |
---|
60 | Stan Kowalski (MIT) |
---|
61 | |
---|
62 | Ruth Pordes (Fermilab) |
---|
63 | Catherine James (Fermilab) |
---|
64 | Jim Holt (Fermilab) |
---|
65 | Norm Gelfand (Fermilab) |
---|
66 | Leonid Sagalovsky (formerly of Fermilab) |
---|
67 | |
---|
68 | |
---|
69 | ----------------------------------------------------------------------- |
---|
70 | |
---|
71 | TERMS AND CONDITIONS |
---|
72 | ==================== |
---|
73 | |
---|
74 | This software has been made freely available with a request for |
---|
75 | collaborative input subject to standard Fermitools Terms and Conditions |
---|
76 | given in full below. |
---|
77 | |
---|
78 | ----------------------------------------------------------------------- |
---|
79 | |
---|
80 | PRODUCT DESCRIPTION |
---|
81 | =================== |
---|
82 | |
---|
83 | TRANSPORT is a computer program used to design charged particle beam |
---|
84 | transport systems. Beam line components which can be represented are |
---|
85 | drifts, bending magnets, quadrupoles, sextupoles, octupoles, solenoids, |
---|
86 | travelling wave accelerating cavities, steering magnets, and plasma |
---|
87 | lenses. The effect of the beam line on a charged particle trajectory is |
---|
88 | represented by first-, second-, and third-order matrices. Beam phase |
---|
89 | space dimensions and floor coordinates may also be calculated. The beam |
---|
90 | phase space can be specified as a matrix of variances and covariances or |
---|
91 | in accelerator parameters. Its center can deviate from the reference |
---|
92 | trajectory along which the magnetic components are placed. |
---|
93 | |
---|
94 | TRANSPORT will do fitting, allowing the simultaneous variation of up to |
---|
95 | 20 selected parameters to satisfy imposed constraints. Misalignments |
---|
96 | and errors may be simulated and their effect evaluated. In conjunction |
---|
97 | with a plotting program such as TOPDRAWER, plots can be made of the beam |
---|
98 | ellipse, any matrix element against accumulated length, and the floor |
---|
99 | layout of the beam line, including three-dimensional representations of |
---|
100 | the magnets. |
---|
101 | |
---|
102 | Input can be in either the MAD compatable notation of Christoph Iselin |
---|
103 | or in a strictly numerical format. The parameters can be in any units |
---|
104 | desired. Physical parameters and constrained quantities can be related |
---|
105 | by algebraic expressions. |
---|
106 | |
---|
107 | Documentation |
---|
108 | ------------- |
---|
109 | |
---|
110 | Transport Manual online |
---|
111 | ----------------------- |
---|
112 | The Transport manual is now available online as a postscript file in |
---|
113 | http://fnalpubs.fnal.gov/archive/1998/pub/Pub-98-310.html |
---|
114 | |
---|
115 | |
---|
116 | The input deck format is described in report SLAC-R-530 which is also |
---|
117 | Fermilab-Pub-98/310. |
---|
118 | |
---|
119 | Required Hardware and Software |
---|
120 | ------------------------------ |
---|
121 | |
---|
122 | Use on various platforms |
---|
123 | ------------------------ |
---|
124 | Currently, at FNAL, TRANSPORT is being developed on a UNIX platform, and |
---|
125 | certified using a set of test files and files representing beamlines. |
---|
126 | The Accelerator Division has used TRANSPORT on a VAX platform as well as |
---|
127 | SUN workstations. |
---|
128 | |
---|
129 | To compile and link on a VAX, simply FOR and LINK the list of .for files |
---|
130 | transfered from the selected version sub-directory. |
---|
131 | |
---|
132 | TRANSPORT has been built on an SGI as a test. For version v1_0, there |
---|
133 | were several compiler and linker warnings. A single test input deck was |
---|
134 | run through this executable, and the results matched the results |
---|
135 | obtained on a VAX for the same input, to within a reasonable level of |
---|
136 | precision. That is, the results differed only in the 4th digit to the |
---|
137 | right of the decimal. The user is warned to make careful selection of |
---|
138 | the UNITS he tells TRANSPORT to work in, to be certain that differences |
---|
139 | in floating-point operations on various platforms do not affect the |
---|
140 | results. |
---|
141 | |
---|
142 | The Makefile used in this SGI test was (-g -w to suppress warnings) |
---|
143 | FFLAGS = -g -w |
---|
144 | |
---|
145 | OBJECTS = transport.o ranport.o trm.o trin.o trsec.o trcall.o |
---|
146 | |
---|
147 | transport : $(OBJECTS) |
---|
148 | $(F77) $(FLAGS) $(OBJECTS) -o $@ |
---|
149 | |
---|
150 | After v1.5, a single Makefile is used to build all flavors. |
---|
151 | One can simply cd to the top directory of transport and issue |
---|
152 | |
---|
153 | make FLAVOR=<the operating system name (AIX, IRIX+6, IRIX46, etc) |
---|
154 | or |
---|
155 | make # the default FLAVOR is as supplied by |
---|
156 | # ups flavor -2. |
---|
157 | |
---|
158 | |
---|
159 | Product Installation |
---|
160 | -------------------- |
---|
161 | |
---|
162 | Each version of TRANSPORT in this public area is placed in its own sub- |
---|
163 | directory (v1_3, v1_4, v1_5, etc). The subdirectory will contain all |
---|
164 | the source code needed to build the full program. This README file |
---|
165 | contains a list of the version sub-directories, their dates of creation, |
---|
166 | and what was changed in the source code. |
---|
167 | |
---|
168 | TRANSPORT has traditionally been maintained in 5 pieces. The code is all |
---|
169 | in FORTRAN. The names of the five pieces and their functions are: |
---|
170 | |
---|
171 | TRCALL Main calling routine |
---|
172 | TRANSPORT Main steering routine and block data |
---|
173 | TRM Main body of code |
---|
174 | TRIN Code to handle translation of the input deck |
---|
175 | TRSEC Code to handle higher order terms in magnets |
---|
176 | RANPORT A random number generator used for simulation of |
---|
177 | errors |
---|
178 | |
---|
179 | |
---|
180 | Running the Software |
---|
181 | -------------------- |
---|
182 | VERSION LIST and COMMENTS |
---|
183 | ------------------------- |
---|
184 | |
---|
185 | v1_5 |
---|
186 | ---- |
---|
187 | Initial public version, certified in 4/95. A predecessor of this version |
---|
188 | was used for the FNAL Main Injector design, and for that version some |
---|
189 | variables were changed from single to double precision. |
---|
190 | |
---|
191 | This version uses standard input and output for its IO. On a UNIX |
---|
192 | platform, one executes the program by redirecting the std io |
---|
193 | transport < in.dat > in.out |
---|
194 | where in.dat is supplied by the user, following the input deck format as |
---|
195 | outlined in the Transport manual. |
---|
196 | |
---|
197 | On a VAX, one can assign filenames to standard input and output |
---|
198 | ASSIGN/USER in.dat FOR005 |
---|
199 | ASSIGN/USER in.out FOR006 |
---|
200 | |
---|
201 | Following instructions in the manual, one can request binary output from |
---|
202 | TRANSPORT for use in plotting and other applications. These special |
---|
203 | output files will be named as standard fortran units, fort.11 on Unix, |
---|
204 | and for011.dat on a Vax. |
---|
205 | |
---|
206 | |
---|
207 | ------------------------------------------------------------------------ |
---|
208 | |
---|
209 | SUPPORT |
---|
210 | ======= |
---|
211 | |
---|
212 | Help with the installation or use of TRANSPORT is available by sending |
---|
213 | mail to |
---|
214 | |
---|
215 | TRANSPORT_support@fnal.gov |
---|
216 | |
---|
217 | which is auto-forwarded to the group in charge of TRANSPORT support at |
---|
218 | Fermilab. |
---|
219 | |
---|
220 | This software is furnished by Fermilab on an "as is" basis as a service |
---|
221 | to the wider community with the goal of stimulating collaborative use |
---|
222 | and further development. |
---|
223 | |
---|
224 | Provision of the software implies no commitment of support by Fermilab. |
---|
225 | |
---|
226 | The Fermilab Computing Division is open to discussing other levels of |
---|
227 | support for use of the software with responsible and committed users and |
---|
228 | collaborators. |
---|
229 | |
---|
230 | Use of the software in experiments at Fermilab will be assured of a |
---|
231 | level of support as agreed to through the standard Memorandum Of |
---|
232 | Understanding process. |
---|
233 | |
---|
234 | Users may send mail to the mail address given above, with the |
---|
235 | expectation that it will be read and noted. |
---|
236 | |
---|
237 | |
---|
238 | ------------------------------------------------------------------------ |
---|
239 | |
---|
240 | TERMS AND CONDITIONS IN FULL |
---|
241 | ============================ |
---|
242 | |
---|
243 | ------------------------------------------------------------------------ |
---|
244 | Fermitools Software Legal Information (Modified BSD licence)- 12/01/2001 |
---|
245 | ------------------------------------------------------------------------ |
---|
246 | |
---|
247 | |
---|
248 | COPYRIGHT STATUS: |
---|
249 | Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and |
---|
250 | software are sponsored by the U.S. Department of Energy under Contract No. |
---|
251 | DE-AC02-76CH03000. Therefore, the U.S. Government retains a world-wide |
---|
252 | non-exclusive, royalty-free license to publish or reproduce these documents |
---|
253 | and software for U.S. Government purposes. All documents and software |
---|
254 | available from this server are protected under the U.S. and Foreign |
---|
255 | Copyright Laws, and FNAL reserves all rights. |
---|
256 | |
---|
257 | |
---|
258 | Distribution of the software available from this server is free of |
---|
259 | charge subject to the user following the terms of the Fermitools |
---|
260 | Software Legal Information. |
---|
261 | |
---|
262 | Redistribution and/or modification of the software shall be accompanied |
---|
263 | by the Fermitools Software Legal Information (including the copyright |
---|
264 | notice). |
---|
265 | |
---|
266 | The user is asked to feed back problems, benefits, and/or suggestions |
---|
267 | about the software to the Fermilab Software Providers. |
---|
268 | |
---|
269 | |
---|
270 | Neither the name of Fermilab, the URA, nor the names of the contributors |
---|
271 | may be used to endorse or promote products derived from this software |
---|
272 | without specific prior written permission. |
---|
273 | |
---|
274 | |
---|
275 | |
---|
276 | DISCLAIMER OF LIABILITY (BSD): |
---|
277 | |
---|
278 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
---|
279 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
---|
280 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
---|
281 | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FERMILAB, |
---|
282 | OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS BE LIABLE |
---|
283 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
284 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
---|
285 | OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
---|
286 | BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
---|
287 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
---|
288 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
---|
289 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
290 | |
---|
291 | |
---|
292 | Liabilities of the Government: |
---|
293 | |
---|
294 | This software is provided by URA, independent from its Prime Contract |
---|
295 | with the U.S. Department of Energy. URA is acting independently from |
---|
296 | the Government and in its own private capacity and is not acting on |
---|
297 | behalf of the U.S. Government, nor as its contractor nor its agent. |
---|
298 | Correspondingly, it is understood and agreed that the U.S. Government |
---|
299 | has no connection to this software and in no manner whatsoever shall |
---|
300 | be liable for nor assume any responsibility or obligation for any claim, |
---|
301 | cost, or damages arising out of or resulting from the use of the software |
---|
302 | available from this server. |
---|
303 | |
---|
304 | |
---|
305 | Export Control: |
---|
306 | |
---|
307 | All documents and software available from this server are subject to U.S. |
---|
308 | export control laws. Anyone downloading information from this server is |
---|
309 | obligated to secure any necessary Government licenses before exporting |
---|
310 | documents or software obtained from this server. |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | |
---|
315 | |
---|