-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathFrame3DD User Manual.html
3066 lines (2686 loc) · 151 KB
/
Frame3DD User Manual.html
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!-- saved from url=(0078)http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html -->
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Frame3DD User Manual</title>
<meta name="Description" content=" Free software for static and dynamic structural analysis of 3D moment-resisting frames with elastic and geometric stiffness. Written in ANSI C.
Source code includes: frame analysis, LDL' decomposition, LU decomposition, sub-space iteration, Stodola iteration, Sturm eigenvalue checking,
Static Condensation, Dynamic Paz Condensation, Paz Condensation.
Modal Condensation, Matlab interface.
Matlab interface.
Graphical output and mode shape animation via Gnuplot.">
<meta name="Keywords" content="Frame3DD, Structural Dynamics, Structural Analysis, Frame Analysis, 3D Frames, 3D Trusses, Structural Analysis Software, Geometric Stiffness, Geometric Stiffness Matrix, Modal Analysis, Modal Analysis Software, Structural Dynamics, Structural Dynamics Software, LDL Decomposition, LDL Decomposition, LU Decomposition, Subspace Iteration, Gnuplot, Matlab, Octave, Henri Gavin, Duke">
<style>
h1 {font: bold x-large sans-serif}
h2 {font: bold x-large sans-serif}
h3 {font: bold large sans-serif}
h4 {font: bold small sans-serif}
li, td, p {font: normal small sans-serif}
div.eq {font-style:italic; width:100%; text-align:center; margin-top: 6pt; margin-bottom: 6pt}
div.note {width: 60em; border: solid 2pt gray; background-color: #FFFFEE; padding:10px; margin-top: 6pt; margin-bottom: 6pt; font: normal small sans-serif }
pre {background-color: #FFF4C4}
iframe {background-color: #000000; margin-top: 5px; margin-bottom: 5px, border:0}
</style>
</head><body>
<img src="./Frame3DD User Manual_files/psoe.jpg" height="100" align="left" border="0">
<font face="Arial, Helvetica, sans-serif" size="4">
<nobr><b>User manual and reference for <a href="http://frame3dd.sourceforge.net/">Frame3DD: A Structural Frame Analysis Program</a></b>
</nobr><br></font>
<a href="http://cee.duke.edu/">
Department of Civil and Environmental Engineering</a><br>
<a href="http://pratt.duke.edu/">
Edmund T. Pratt School of Engineering</a><br>
<a href="http://www.duke.edu/">
Duke University</a> - Box 90287,
<a href="http://www.durham-nc.com/"> Durham</a>,
<a href="http://www.visitnc.com/"> NC</a> 27708-0287<br>
<i>
<font face="Verdana, Arial, Helvetica, sans-serif" size="2">
Henri P. Gavin, Ph.D., P.E., </font></i>
<hr>
<h1>Frame3DD version 0.20140514+ </h1>
<!-- iframe src="version.html" width="250" height="30" style="border:solid 1pt grey"></iframe -->
<!-- <h4>DESCRIPTION </h4> -->
<p><b>Frame3DD</b> is a program for the static and dynamic structural analysis of two- and three-dimensional frames and trusses with elastic and geometric stiffness.
</p>
<!-- 3D frames , 3D frames , 3D frames , 3D frames , 3D frames , 3D frames -->
<p><b>Frame3DD</b> is preferably executed from the
<a href="http://en.wikipedia.org/wiki/Windows_command_line">command prompt</a> (Windows)
or <a href="http://en.wikipedia.org/wiki/Unix_shell">shell</a> (Linux), <a href="http://www.macdevcenter.com/pub/a/mac/2001/12/14/terminal_one.html">terminal</a> (OS X),
or <a href="http://en.wikipedia.org/wiki/Apple_X11">xterm</a> (Linux or OS X) as follows, with filenames changed as required:
</p><pre>frame3dd inputfile.3dd outputfile.txt
</pre>
<p></p>
<!-- 3D frames , 3D frames , 3D frames , 3D frames , 3D frames , 3D frames -->
<p><b>Frame3DD</b> reads a plain-text <b>Input Data file</b>, containing node coordinates, frame element geometry, material moduli, fixed nodes, prescribed displacements, load information, and optionally, mass information if a modal analysis is to be carried out.
<!-- (The Input Data file is not a Matlab file. Values are not input using Matlab matrix notation with square brackets.)-->
</p>
<!-- 3D frames , 3D frames , 3D frames , 3D frames , 3D frames , 3D frames -->
<p><b>Frame3DD</b> appends results to a plain-text <b>Output Data file</b>.
Results from the most recent analysis
are appended to the <b>end</b> of the Output Data file.
Each section of the Output Data gives the date and time of the analysis,
recapitulates the input information, gives node displacements in global coordinates, frame element end-forces in local coordinates, reactions in global coordinates, and natural frequencies and mode shapes in global coordinates.
</p>
<p><b>Frame3DD</b> writes a
<a href="http://www.gnuplot.info/">gnuplot</a>
script file used for viewing deformed frames and dynamic mode shapes.
If the Output Data is written to a file called <b>MyResultsA.out</b>,
the gnuplot script is written to a file called <b>MyResultsA.plt</b>.
Graphical output may be viewed by starting gnuplot and typing:
<b> load 'MyResultsA.plt'</b>.
</p>
<p><b>Frame3DD</b> can consider multiple static load cases in a single analysis.
Separate output data files list the internal axial force, shear forces, torsion, and bending moments along each frame element for each static load case.
</p>
<p><b>Frame3DD</b> may optionally interface with Matlab and with spreadsheet programs.
</p>
<p><b>Frame3DD</b> is <b>free open-source software</b>; you may redistribute it and/or modify it under
the terms of the GNU General Public License (GPL) as published by the
<a href="http://www.fsf.org/">Free Software Foundation</a>.
The software is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/LICENSE.txt">LICENSE.txt</a> for details.
<b>Frame3DD</b> is developed using the free-and-open
<a href="http://www.vim.org/"><b>vim</b></a> text editor and the
<a href="http://gcc.gnu.org/"><b>gcc</b></a> compiler.
</p>
<p><b>Frame3DD</b> had a free <a href="http://www.sketchup.com/"><b>Sketchup</b></a> interface available
<a href="http://sketchucation.com/forums/viewtopic.php?t=46405">here</a>.
</p><p>If you find <b>Frame3DD</b> to be useful please consider
a donation to the vim charity,
<a href="http://iccf-holland.org/">iccf-holland</a>, which provides education
and health-care to needy children in Uganda.
</p>
<!--
Free software for static and dynamic structural analysis of 2D
and 3D frames and trusses with elastic and geometric stiffness.
Computes the static deflections, reactions, internal element
forces, natural frequencies, mode shapes and modal participation
factors of two- and three- dimensional elastic structures using
direct stiffness and mass assembly. Written in C. Source code
includes: frame analysis, LDL' decomposition, LU decomposition,
Newton-Raphson iteration, sub-space iteration, Stodola iteration,
Sturm eigenvalue check, and Static Condensation, Dynamic Guyan Reduction,
Dynamic Condensation, Modal Condensation.
Graphical output and mode shape animation
via <a href="http://www.gnuplot.info/">gnuplot</a> version 4.6.
<hr>
<h4>SYNOPSIS </h4>
frame3dd <Input Data file> <Output Data file>
<hr>
-->
<h2>Contents</h2>
<ol>
<li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#starting">Getting started</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#iodata">Input Data and Output Data</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#installrun">How to install and run Frame3DD</a>
<ol>
<li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#runlinux">Linux</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#runosx">Mac OS X</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#runwindows">Windows</a>
</li></ol>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#Matlab">Matlab Interface</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#CSV">Spreadsheet Interface</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#FrameEd">FrameEd</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#structuralmodeling">Structural Modeling</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#numerical">Numerical Details</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#InputData">Input Data Format</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#Variables">Variable Definitions</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#commandline">Command-line options</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#sourcecode">Source code</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#exitcodes">Exit code index</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#enhancements">Enhancements projected for future versions</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#acknowledgments">Acknowledgments</a>
</li><li><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#references">References</a>
</li></ol>
<a name="starting"><h2>1. Getting started</h2>
</a><ol><a name="starting">
<li>Read the User Manual and Reference (this file).
</li></a><li><a name="starting">
<!-- a href="https://sourceforge.net/projects/frame3dd/files/"-->
<!-- a href="https://sourceforge.net/projects/frame3dd/files/latest/download?source=files" -->
</a><a href="http://sourceforge.net/project/platformdownload.php?group_id=221386" --="">
Download</a>
Frame3DD and save the Frame3DD folder to your Desktop (more details below).
</li><li>Optionally, obtain a copy of gnuplot for your operating system (more details below).
</li><li>Open a terminal window, go to the Frame3DD directory, and run the program on one of the examples using a command like ...
<pre>cd ~/Desktop/Frame3DD
frame3dd examples/exE.3dd examples/exE.out
</pre>
</li><li>Open the Output Data file using a <a href="http://en.wikipedia.org/wiki/Vim_(text_editor)">good text editor</a> and view the Output Data.
</li><li>Plot the structural configuration, the deformed structural shape, and mode-shapes, by starting <a href="http://www.gnuplot.info/">gnuplot</a>, and typing
<pre> gnuplot> cd 'Desktop/Frame3DD/examples'
gnuplot> load 'exE.plt'
</pre>
Observe a series of plots by hitting the Return (or Enter) key between plots.
<br>
If a dynamic analysis was performed, you will enjoy an animation of selected mode shapes.<br>
Continue to hit the Return (or Enter) key until the last plot is displayed.
</li></ol>
<a name="iodata"><h2>2. Input Data and Output Data</h2>
</a><p><a name="iodata">
The <b>Input Data file</b> is a plain text file and must adhere to the format
</a><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#InputData">described below</a>.
Several examples are given at <a href="http://frame3dd.sourceforge.net/">http://frame3dd.sourceforge.net/</a>. When writing your own Input Data files, note the following points:</p>
<ul>
<li>Comments may be placed anywhere in the file and are helpful in organizing the Input Data.
<br>
A comment begins with one of the following three characters <b># % ?</b> and continues to the end of the line.
</li><li>All commas and semi-colons in the Input Data are ignored.
</li><li>Floating point numbers must be entered as 1.234 1234 or 1.234e3.
</li><li>Arithmetic expressions such as 1.234*10^3 or 6*sin(pi/2) are <b>not</b> allowed
in the Input Data (unless the <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#Matlab">Matlab interface</a> is used).
</li></ul>
<p>
To write your own Input Data file, it may be helpful to start with an example that resembles the system you would like to analyze. Carefully compare the graphical output of the example, the Input Data file, the Output Data file,
and the <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#InputData"><b>Input Data format</b></a>, with the <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#Variables"><b>variable definitions</b></a> at the end of this page.
</p>
<p>
You may edit Input Data files using a good text editor
(<a href="http://www.vim.org/others.php">vim/evim/gvim</a>,
<a href="http://www.gnome.org/projects/gedit/">gedit</a>,
<a href="http://www.jedit.org/index.php">jEdit</a>,
<a href="http://www.nano-editor.org/">nano</a>,
<!-- <a href="http://www.barebones.com/products/textwrangler/">TextWrangler (OS X)</a>, -->
<!--
<a href="http://emacsformacosx.com/">Emacs for OS X</a>,
<a href="http://code.google.com/p/macvim/">vim/evim/gvim for OS X</a>.
<a href="http://www.apple.com/support/mac101/work/23/">TextEdit (OS X)</a>,
-->
<a href="http://notepad-plus.sourceforge.net/uk/site.htm">NotePad++ (Windows)</a>,
<!--
<a href="ftp://ftp.vim.org/pub/vim/pc/gvim72.exe">vim/evim/gvim (Windows)</a>,
<a href="http://www.pcshareware.com/anotepad.htm">Notepad (Windows)</a>
-->
etc.),
using the Matlab interface, or using spreadsheet programs
(<a href="http://docs.google.com/">GoogleDocs</a>,
<a href="http://www.libreoffice.org/">LibreOffice</a>,
<a href="http://projects.gnome.org/gnumeric/">Gnumeric</a>, or Excel).
</p>
<p>
Details regarding the Matlab interface to Frame3DD are <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#Matlab">here</a>.<br>
Details regarding the spreadsheet interface to Frame3DD are <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/doc/Frame3DD-manual.html#CSV">here</a>.<br>
</p>
<p>
It might take a few tries to get your Input Data just right.
Frame3DD checks the Input Data for errors and, where possible,
displays descriptive diagnostic messages when errors are found.
</p>
<!-- <div class=note>
<b>Note:</b>
-->
<p>
<b>Frame3DD</b> generates several <b>additional output files</b> used in plotting deformed frames.
By default, these output files are sent to a temporary file folder.
On OS X, Linux, and Unix, the location of this folder defaults to the <b>/tmp</b> directory.
On Windows, the location of this folder defaults to <b>C:\WINDOWS\Temp</b>.
<!--
or the user's <b>Local Settings\Temp</b> (XP) or <b>AppData\Local\Temp</b> (Vista).
-->
If you would like your output files to be sent to another location, you can set the <a href="http://en.wikipedia.org/wiki/Environment_variable">environment variable</a> <b>Frame3DD</b> with the path to your
desired temporary output directory (instructions below).
The additional output files will then appear in the folder you have specified.
</p>
<!-- </div> -->
<a name="installrun"><h2>3. How to install and run Frame3DD</h2>
<p>
Compiled executable programs are updated with some regularity.
Frame3DD installation packages are available for download for Linux,
for OS X, and for Windows operating systems as a .ZIP archive.
This installation .ZIP archive include:
</p><ul>
<li> A copy of the GPL license (LICENSE.txt)
</li><li> Executable programs (frame3dd) for Linux, OS X, and Windows
</li><li> This manual, (doc/user-manual.html)
</li><li> Some general information (README.txt)
</li><li> Some Windows-specific issues (README-win32.txt)
</li><li> The Matlab interface code (matlab/)
</li><li> A summary of recent updates to the program (ChangeLog.txt)
</li><li> A set of example Input Data files (examples/)
</li><li> The complete source code (src/)
</li></ul>
<p></p>
<p>
A separate Windows installer includes a Microstran viewer module for Frame3DD.
</p>
<p>
The date stamp at the beginning of the manual corresponds to the release date of the code.
</p>
</a><a name="runlinux"><h3>3.1 Linux</h3>
<p>
You may install Frame3DD from the .ZIP archive
or you may compile Frame3DD from the source code.
The following instructions install Frame3DD to the <b>Desktop</b> but other directories may be substituted, if so desired.
</p>
<h4>3.1.1 Installing Frame3DD from the .ZIP archive for Linux</h4>
</a><ol><a name="runlinux">
</a><li><a name="runlinux">
<!-- a href="https://sourceforge.net/projects/frame3dd/files/"-->
<!-- a href="https://sourceforge.net/projects/frame3dd/files/latest/download?source=files" -->
</a><a href="http://sourceforge.net/project/platformdownload.php?group_id=221386">
Download</a>
the Frame3DD .ZIP archive (Frame3DD_VERSION.zip) and save it in your <b>Desktop</b>.<br>
If the .ZIP archive was not automatically unzipped,
double-click the icon to extract it to your <b>Desktop</b>.
</li><li>
<b><i>Recommended</i></b><br>
Put the <b>Frame3DD</b> directory in your path and set the <b>FRAME3DD_OUTDIR</b> location.<br>
To do this, double-click the <b>Home</b> icon on the Desktop, and select <b>View > Show Hidden Files</b><br><br>
<ul>
<li>If you have a file called <b>~/.profile</b> in your home directory,
open it with a double-click.
Copy-and-paste the following ten lines into the beginning of <b>~/.profile</b>
<pre># for Frame3DD ... http://frame3dd.sourceforge.net/
# add Frame3DD executable directory to the path
export PATH=$PATH:$HOME/Desktop/Frame3DD/linux/
# create a Frame3DD output directory
if [ ! -d /tmp/frame3dd_temp_$USER ]; then
mkdir /tmp/frame3dd_temp_$USER
echo "creating /tmp/frame3dd_temp_$USER for Frame3DD"
fi
# specify the Frame3DD output directory
export FRAME3DD_OUTDIR=/tmp/frame3dd_temp_$USER
</pre>
... save, and exit the editor.
</li><li>If you have a file named <b>~/.login</b> in your home directory,
open it with a double-click.
Copy-and-paste the following ten lines into the beginning of <b>~/.login</b>
<pre># for Frame3DD ... http://frame3dd.sourceforge.net/
# add Frame3DD executable directory to the path
set path = ( $path $home/Desktop/Frame3DD/linux )
# create a Frame3DD output directory
if ( ! -d /tmp/frame3dd_temp_$user ) then
mkdir /tmp/frame3dd_temp_$user
echo "creating /tmp/frame3dd_temp_$user for Frame3DD"
endif
# specify the Frame3DD output directory
setenv FRAME3DD_OUTDIR /tmp/frame3dd_temp_$user
</pre>
... save, and exit the editor. <br>.
</li><li> Open a Terminal window. (Right-click on an open part of the Desktop and select <b>Open Terminal</b>), and type:
<pre>source ~/.profile # if you edited ~/.profile
source ~/.login # if you edited ~/.login
</pre>
</li></ul>
</li></ol>
<h4>3.1.2 Running Frame3DD in Linux</h4>
<ol>
<li> Open a Terminal window. (Right-click on an open part of the Desktop and select <b>Open Terminal</b>.) <br>
Change to the directory containing the Frame3DD example files and run an example, as follows.
<pre>cd ~/Desktop/Frame3DD
frame3dd examples/exE.3dd examples/exE.out
</pre>
Some run-time information will be displayed on the Terminal and
the results of your Frame3DD analysis will have been appended to the end of the <b>examples/exE.out</b> Output Data file.
Data files used primarily for plotting are stored in the <b>/tmp/frame3dd_temp_$USER</b> directory.
</li><li> You may view Output Data files and edit Input Data files using a good text editor
(<a href="http://www.vim.org/others.php">vim/evim/gvim</a>,
<a href="http://www.gnome.org/projects/gedit/">gedit</a>,
<a href="http://www.nano-editor.org/">nano</a>),
or a spreadsheet program
(<a href="http://docs.google.com/">GoogleDocs</a>,
<a href="http://www.libreoffice.org/">LibreOffice</a>,
<a href="http://projects.gnome.org/gnumeric/">Gnumeric</a>). For example,
to read or edit the Input Data file. Double-click the <b>Home</b> icon on the Desktop, navigate to the directory of your data files, right click
on the Data File and select the editor of your choice.
The text editors
<a href="http://www.vim.org/others.php">vim/evim/gvim</a>,
<a href="http://www.gnome.org/projects/gedit/">gedit</a>, and
<a href="http://www.nano-editor.org/">nano</a>,
should already be installed;
there should be no need to install another editor.
Three tutorials for vim/evim/gvim are <a href="http://www.jerrywang.net/vi/">here</a>,
<a href="http://thomer.com/vi/vi.html">here</a>, and
<a href="http://www.duke.edu/~hpgavin/vi.html">here</a>.
</li><li>Proceed by running your own <b>Frame3DD</b> analyses using a command like ...
<pre>frame3dd examples/MyFrame.3dd examples/MyResultsA.out
</pre>
(within a Terminal window).
<!-- <li> You may wish to delete all the files in the temporary file directory (c:\temp) after you have finished your analyses. -->
</li></ol>
<h4>3.1.3 Plotting Results with <a href="http://www.gnuplot.info/">gnuplot</a> in Linux </h4>
<ol>
<li> Gnuplot is commonly pre-installed on Linux systems.
If it is not, you may install it only if you have root privileges using a command like ... <tt> sudo apt-get install gnuplot </tt> ... or by using the package manager GUI installed on your system.
</li><li>Change directories to your Frame3DD directory and Start gnuplot in the Terminal with the command:
<pre>cd ~/Desktop/Frame3DD/examples
gnuplot
</pre>
</li><li>Change directories to Display the plots of your structure using gnuplot with a command like ...
<pre> gnuplot> load 'MyResultsA.plt'
</pre>
where <b>MyResultsA.out</b> is the name of of the Output Data file
specified when running Frame3DD.
</li><li>Hit the 'Return' key in the Terminal window to see the sequence of plots
and animations until the <b>gnuplot></b> prompt returns.
Or hit <b>CTRL-C</b> to stop the plots at the current plot.
</li><li> In examining plots of 3D structures with gnuplot, it is convenient to use a scroll-mouse to zoom, pan, and shift the image.
<pre> zoom : hold Alt + scroll ... or ... hold the scroll button and drag left-right
pan : hold Left mouse button + drag the mouse ... or ... arrow key (up, down, left, right) ... or ... shift + arrow key
shift X : hold shift + scroll
shift Y : scroll
shift Z : hold shift + hold the scroll wheel + drag up-down
autoscale : the 'a' key
toggle border : the 'b' key
toggle grid : the 'g' key
toggle mouse functions on/off : the 'm' key
undo shift : the 'u' key
</pre>
</li><li> To save the current plot as a PostScript file in the Frame3DD/examples directory, use the <b>saveplot</b> script included in the Frame3DD/examples directory.
<pre> gnuplot> load 'saveplot'
gnuplot> !cp my-plot.ps PlotFileA.ps
</pre>
</li><li>After finishing with your plots, you can exit gnuplot by typing ...
<pre> gnuplot> quit
</pre>
</li></ol>
<h4>3.1.4 Compiling Frame3DD from source for Unix or Linux</h4>
<p>
<!--
For Linux and Unix we currently only provide source-code tarball; you must
build the software yourself.
-->
The following instructions work on Ubuntu 8.10 - 14.04
and should work with minor changes on any other recent Linux or Unix system.
There are two options for compiling under Linux:
</p>
<ol>
<li> Compiling using <b>make:</b>
<ol>
<li> Open a Terminal window,
(Right-click on an open part of the Desktop and select <b>Open Terminal</b>.)
and compile the code
<pre>cd ~/Desktop/Frame3DD/src/
make
mv frame3dd ../linux/
</pre>
</li></ol>
</li><li> Compiling using SCONS:
<ol>
<li>Ensure you have Python, SCons and GCC installed on your system.
On Debian-based systems it should suffice to
<pre>sudo apt-get install build-essential scons
</pre>
</li><li>If you would like to build the Microstran viewer, ensure that the package
<tt>libsoqt-dev4</tt> is installed on your system.
<pre>sudo apt-get install libsoqt-dev4
</pre>
<!--
<a href="http://sourceforge.net/project/platformdownload.php?group_id=221386">Download</a>
Download</a> the Frame3DD source-code tarball (frame3dd-VERSION.tar.bz2)
and save it in your home directory.
-->
</li><li>Open a Terminal, unpack the source code, enter the source directory,
and build the code, as follows:
<pre>tar jxvf frame3dd-VERSION.tar.bz2
cd frame3dd-VERSION
scons
</pre>
</li><li>
If you have root privileges, install <b>build/frame3dd</b> to <b>/usr/local/bin/</b> ...
<pre>sudo scons install
</pre>
or you may install frame3dd in another system directory if your choosing,
such as, ...
<pre>sudo scons install INSTALL_PREFIX=/usr/local/bin/
</pre>
</li><li>If you do not have root privileges, you can run Frame3dd directly from the build tree:
<pre>export LD_LIBRARY_PATH=~/frame3dd-VERSION/build
export PATH=$PATH:~/frame3dd-VERSION/build
</pre>
</li></ol>
</li></ol>
<a name="runosx"><h3>3.2 Mac OS X</h3>
<!--
<div class="note"><b>Note:</b> The following binary downloads have not been updated
for some time and may give you problems. You may have more success trying to build
from source following the instructions for Linux or Unix.</div>
-->
<p>
For OS X running on an Intel processor, you may install Frame3DD from the .ZIP archive
or you may compile from the source code.
The following instructions install Frame3DD to the <b>Desktop</b> but other directories may be substituted, if so desired.
</p>
<h4> 3.2.1 Installing Frame3DD from the .ZIP archive for OS X</h4>
</a><ol><a name="runosx">
</a><li><a name="runosx">
<!-- a href="https://sourceforge.net/projects/frame3dd/files/" -->
<!-- a href="https://sourceforge.net/projects/frame3dd/files/latest/download?source=files" -->
</a><a href="http://sourceforge.net/project/platformdownload.php?group_id=221386">
Download</a>
the Frame3DD .ZIP archive (Frame3DD_VERSION.zip) and save it in your <b>Desktop</b>.<br>
If the .ZIP archive was not automatically unzipped,
simply drag the <b>Frame3DD</b> folder icon to your <b>Desktop</b>.
</li><li><b><i>Optional</i></b><br>
Download the <b>Sketchup</b> interface for <b>Frame3DD</b>, available
<a href="http://sketchucation.com/forums/viewtopic.php?t=46405">here</a>.
</li><li><b><i>Recommended</i></b><br>
Put the <b>Frame3DD</b> directory in your path and set the <b>FRAME3DD_OUTDIR</b> location.<br>
<ul>
<li> Open your <b>~/.profile</b> file ...
open a Terminal window (<b>Applications > Utilities > X11</b> or <b>Applications > Utilities > Terminal</b>)
and type:
<pre>touch ~/.profile
open -a TextEdit ~/.profile
</pre>
</li><li> Copy-and-paste the following ten lines into the beginning of your <b>~/.profile</b> file ...
<pre># for Frame3DD ... http://frame3dd.sourceforge.net/
# add Frame3DD executable directory to the path
export PATH=$PATH:$HOME/Desktop/Frame3DD/osx/
# create a Frame3DD output directory
if [ ! -d /tmp/frame3dd_temp_$USER ]; then
mkdir /tmp/frame3dd_temp_$USER
echo "creating /tmp/frame3dd_temp_$USER for Frame3DD"
fi
# specify the Frame3DD output directory
export FRAME3DD_OUTDIR=/tmp/frame3dd_temp_$USER
</pre>
</li><li> Save and Quit <b>TextEdit</b>, and, in the Terminal, type:
<pre>source ~/.profile
</pre>
</li></ul>
</li></ol>
<h4> 3.2.2 Running Frame3DD in OS X</h4>
<ol>
<li> Open a Terminal window (<b>Applications > Utilities > X11</b> or <b>Applications > Utilities > Terminal</b>)
change to the directory of example files and run an example.
<pre>cd ~/Desktop/Frame3DD
frame3dd examples/exE.3dd examples/exE.out
</pre>
Some run-time information will be displayed on the Terminal and
the results of your Frame3DD analysis will have been appended to the end of the
<b>examples/exE.out</b> Output Data file. Data files used primarily for plotting are stored in the <b>/tmp/frame3dd_temp_$USER</b> directory.
</li><li> You may view Output Data files and edit Input Data files using a good text editor
(<a href="http://code.google.com/p/macvim/">vim/evim/gvim</a>,
<a href="http://www.gnome.org/projects/gedit/">gedit</a>,
<a href="http://www.jedit.org/index.php">jEdit</a>),
or a spreadsheet program
(<a href="http://docs.google.com/">GoogleDocs</a>,
<a href="http://www.libreoffice.org/">LibreOffice</a>).<br>
Three tutorials for vim/evim/gvim are <a href="http://www.jerrywang.net/vi/">here</a>,
<a href="http://thomer.com/vi/vi.html">here</a>, and
<a href="http://www.duke.edu/~hpgavin/vi.html">here</a>.
If you use Apple's TextEdit,
make sure you are in Plain Text mode ... [SHIFT] [APPLE] [T] ... or ... <b>Format > Make Plain Text </b> ... <br>
</li><li>
Proceed by running your own <b>Frame3DD</b> analyses using a command like ...
<pre>frame3dd examples/MyFrame.3dd examples/MyResultsA.out
</pre>
(within a Terminal window).
</li></ol>
<h4>3.2.3 Plotting Results with <a href="http://www.gnuplot.info/">gnuplot</a> in OS X</h4>
<!--
<p>
For a version of gnuplot for OS X-Intel, or for a version with mouse-scrolling and panning features,
install <a href="http://www.apple.com/macosx/features/x11/">X11</a> and <a href="http://developer.apple.com/tools/">Apple Development Tools</a>, and then <a href="http://maba.wordpress.com/2006/08/02/scientific-plotting-on-mac-os-x-using-gnuplot-and-plot/">compile gnuplot from sources</a>.
</p>
-->
<p>
<b>Installing <a href="http://www.gnuplot.info/">gnuplot</a> for OS X</b>
</p>
<p>
From you Mac's Administrator account, first install Xcode, then install MacPorts, and finally install gnuplot.
</p><ol>
<li>Install <a href="https://developer.apple.com/xcode/">Xcode</a>,
<!-- join ADC to create an account, log in, and then click on <b>Downloads > Developer Tools</b>, and browse for the version of Xcode for your version of OS X.<br>
For OS X <b>10.4</b> Tiger, install Xcode <b>2.5</b> Developer Tools<br>
For OS X <b>10.5</b> Leopard, install Xcode <b>3.1.4</b> Developer Tools<br>
For OS X <b>10.6</b> Snow Leopard, install Xcode <b>3.2.1</b> Developer Tools<br> -->
Make sure the "Unix Development" option is selected if installing Xcode 3.1.4 or 3.2.1.
</li><li> To install MacPorts
for your version of OS X (10.4 Tiger, 10.5 Leopard, or 10.6 Snow Leopard),
follow <a href="http://www.macports.org/install.php#pkg">
these instructions</a>.
</li><li> To install gnuplot, open a terminal window and type:
<pre>sudo port install gnuplot
</pre>
If this is your first MacPorts package installation, it will take several minutes to complete.
</li></ol>
<p></p>
<!--
<li> Test that gnuplot works.
Open a Terminal window (Applications > Utilities > Terminal) and
<pre>
gnuplot
gnuplot> plot sin(x)
gnuplot> quit
</pre>
-->
<p>
<b>Running <a href="http://www.gnuplot.info/">gnuplot</a> in OS X</b>
</p>
<p>
</p><ol>
<li> Visualize your <b>Frame3DD</b> analysis output.
Open a Terminal window (Applications > Utiltities X11, or Applications > Utilities > Terminal) and ...
<pre>cd ~/Desktop/Frame3DD/examples
gnuplot
gnuplot> load 'MyResultsA.plt'
</pre>
where <b>MyResultsA.out</b> is the name of of the Output Data file specified
when running frame3dd.
</li><li>Hit the 'Return' key in the Terminal window to see the sequence of plots
and animations until the <b>gnuplot></b> prompt returns.
</li><li> In examining plots of 3D structures with gnuplot, it is convenient to use a scroll-mouse to zoom, pan, and shift the image.
<pre> zoom : hold command + scroll ... or ... hold the scroll button and drag left-right
pan : hold Left mouse button + drag the mouse ... or ... arrow key (up, down, left, right) ... or ... shift + arrow key
shift X : hold shift + scroll
shift Y : scroll
shift Z : hold shift + hold the scroll wheel + drag up-down
autoscale : the 'a' key
toggle border : the 'b' key
toggle grid : the 'g' key
toggle mouse functions on/off : the 'm' key
undo shift : the 'u' key
</pre>
</li><li> To save the current plot as a PDF file in the Frame3DD/examples directory, use the <b>saveplot_osx</b> script included in the Frame3DD/examples directory.
<pre> gnuplot> load 'saveplot_osx'
gnuplot> !cp my-plot.pdf PlotFileA.pdf
</pre>
</li><li>After finishing with your plots, you can exit gnuplot by typing ...
<pre> gnuplot> quit
</pre>
</li></ol>
<p></p>
<h4> 3.2.4 Compiling Frame3DD from source for OS X</h4>
<ol>
<li>Install <a href="https://developer.apple.com/xcode/">Xcode</a>.
</li><li> Compile and install the code, as follows:
<pre> cd ~/Desktop/Frame3DD/src/
make
mv frame3dd ../osx/
</pre>
</li></ol>
<a name="runwindows"><h3>3.3 Windows</h3>
<p>
For Microsoft Windows,
you may install Frame3DD from the .ZIP archive
<!-- (recommended), you may use a binary installer (which is currently out of date), -->
or you may compile from the source code.
The following instructions install Frame3DD to the <b>Desktop</b> but other directories may be substituted, if so desired.
</p>
<h4> 3.3.1 Installing Frame3DD from the .ZIP archive for Windows</h4>
</a><ol><a name="runwindows">
</a><li><a name="runwindows"> </a><a href="http://sourceforge.net/project/platformdownload.php?group_id=221386">
Download</a> the Frame3DD .ZIP archive (Frame3DD_VERSION_win32.zip) and save it to your <b>Desktop</b>.<br>
If the .ZIP archive was not automatically unzipped,
simply drag <b>Frame3DD</b> folder icon to your <b>Desktop</b>.
</li><li><b><i>Optional</i></b><br>
Download the <b>Sketchup</b> interface for <b>Frame3DD</b>, now available <a href="http://sketchucation.com/forums/viewtopic.php?t=46405">here</a>.
</li><li> <b><i>Recommended</i></b><br>
Put the <b>Frame3DD</b> directory in your path and set the
<b>PATH</b> and <b>FRAME3DD_OUTDIR</b> environment variables.<br>
To do this,
<b> right-click My Computer > Properties > Advanced > Environment Variables</b><br>
Set a new user variable name <b>PATH</b>
with variable value <b>%HOMEPATH%\Desktop\Frame3DD\windows</b><br>
Set a new user variable name <b>FRAME3DD_OUTDIR</b>
with variable value <b>%HOMEPATH%\Desktop\Frame3DD\temp</b><br>
(The <b>Desktop\Frame3DD\temp</b> folder should already exist.)<br>
Detailed information on how to set environment variables in Windows is <a href="http://vlaurie.com/computers2/Articles/environment.htm">here</a>, if you need it.
</li><li> <b><i>Recommended</i></b><br>
Install
<a href="https://github.com/adoxa/ansicon/downloads/">
ansicon</a>, a Windows console program that can display text in color.<br>
Download and extract the
<a href="https://github.com/adoxa/ansicon/downloads/">
ansicon .ZIP file</a> and copy the <b>x86</b> folder
into the <b>Desktop\Frame3DD\</b> folder. <br>
Make a shortcut from <b>Desktop\Frame3DD\x86\ansicon</b> to the <b>Desktop</b>.
</li></ol>
<h4> 3.3.2 Running Frame3DD in Windows</h4>
<ol>
<li> Go to the <b>Desktop > Frame3DD</b> folder,
double-click on the <b>frame3dd</b> application icon and
enter the Input Data file name and Output Data file name when prompted, as follows:
<pre>Please enter the input data file name: examples/exE.3dd
Please enter the output data file name: examples/exE.out
</pre>
Alternatively, you may open a
"<a href="http://www.bleepingcomputer.com/tutorials/tutorial76.html#intro">command prompt window</a>"
<!-- <a href="http://en.wikipedia.org/wiki/Windows_command_line">Command Prompt</a> window -->
(<b>Start > All Programs > Accessories > Command Prompt</b>),
or an
<a href="https://github.com/adoxa/aansicon/downloads/">ansicon</a> window.<br>
Change to the directory of example files, and run an example, as follows:
<pre>chdir %HOMEPATH%\Desktop\Frame3DD
frame3dd examples/exE.3dd examples/exE.out
</pre>
The results of your Frame3DD analysis will have been appended to the end of the <b>examples/exE.out</b> Output Data file.
Data files used primarily for plotting are stored in the <b>Desktop\Frame3DD\temp</b> folder.
</li><li> You may view Output Data files and edit Input Data files
using a good text editor
(<a href="http://www.vim.org/others.php">vim/evim/gvim</a>,
<a href="http://www.gnome.org/projects/gedit/">gedit</a>,
<a href="http://www.jedit.org/index.php">jEdit</a>,
<a href="http://notepad-plus.sourceforge.net/uk/site.htm">NotePad++</a>),
<a href="http://en.wikipedia.org/wiki/Notepad_(Windows)">NotePad</a>,
or a spreadsheet program
(<a href="http://docs.google.com/">GoogleDocs</a>,
<a href="http://www.libreoffice.org/">LibreOffice</a>).
Three tutorials for vim/evim/gvim are <a href="http://www.jerrywang.net/vi/">here</a>,
<a href="http://thomer.com/vi/vi.html">here</a>, and
<a href="http://www.duke.edu/~hpgavin/vi.html">here</a>.
</li><li>Proceed by running your own <b>Frame3DD</b> analyses using a command like ...
<pre>frame3dd examples/MyFrame.3dd examples/MyResultsA.out
</pre>
... within a Command Prompt or
<a href="https://github.com/adoxa/ansicon/downloads/">ansicon</a> window.
<!-- <li> You may wish to delete all the files in the temporary file directory (c:\temp) after you have finished your analyses. -->
</li></ol>
<h4>3.3.3 Plotting Results with <a href="http://www.gnuplot.info/">gnuplot</a> in Windows</h4>
<p>
<b>Installing <a href="http://www.gnuplot.info/">gnuplot</a> for Windows</b>
</p><ol>
<li>
<a href="http://sourceforge.net/projects/gnuplot/files/gnuplot/4.6.3/gp463-win32-setup.exe/download">
Download</a> the MS-Windows version of gnuplot 4.6.3
and extract it to your <b>Desktop</b>.
</li><li> Navigate to <b>Desktop > gnuplot > bin</b>,
right click on the <b>wgnuplot</b> application icon, and create a shortcut to your <b>Desktop</b>.
</li></ol>
<p></p>
<p>
<b>Running <a href="http://www.gnuplot.info/">gnuplot</a> in Windows</b>
</p><ol>
<li>Clicking on the <b>wgnuplot</b> icon on the Desktop starts gnuplot.
</li><li>To view the plot with gnuplot, first change directories to to location of your output files, by clicking on the <b>ChDir</b> button at the top of the gnuplot window and navigating to <b>Desktop > Frame3DD > examples</b>.
</li><li>Display the plots of your structure using gnuplot with a command like ...
<pre> gnuplot> load 'exE.plt'
</pre>
or
<pre> gnuplot> load 'MyResultsA.plt'
</pre>
where <b>exE.out</b> or <b>MyResultsA.out</b>
is the name of of the specified Output Data file.
</li><li>Click <b>OK</b> to see the next plot or <b>Cancel</b> to stop with the current plot.
</li><li> In examining plots of 3D structures with gnuplot, it is convenient to use a scroll-mouse to zoom, pan, and shift the image.
<pre> zoom : hold Alt + scroll ... or ... hold the scroll button and drag left-right
pan : hold Left mouse button + drag the mouse ... or ... arrow key (up, down, left, right) ... or ... shift + arrow key
shift X : hold shift + scroll
shift Y : scroll
shift Z : hold shift + hold the scroll wheel + drag up-down
autoscale : the 'a' key
toggle border : the 'b' key
toggle grid : the 'g' key
toggle mouse functions on/off : the 'm' key
undo shift : the 'u' key
</pre>
</li><li> To save the current plot as a PostScript file in the Frame3DD/examples folder, use the <b>saveplot_w32</b> script included in the Frame3DD/examples folder.
<pre> gnuplot> load 'saveplot_w32'
gnuplot> !copy my-plot.ps PlotFileA.ps
</pre>
</li><li>After finishing with your plots, you can exit gnuplot by typing ...
<pre> gnuplot> quit
</pre>
</li></ol>
<p></p>
<!--
<h4> 3.3.4 Installing Frame3DD from the binary installer </h4>
<ol>
<li><a href="https://sourceforge.net/projects/frame3dd/files/">
Download</a> and run the binary installer (frame3dd-VERSION.exe).
<li>Use the Start menu to access README information and this documentation.
<li> <b><i>Recommended</i></b><br>
Put the <b>Frame3DD</b> directory in your path and set the
<b>PATH</b> and <b>FRAME3DD_OUTDIR</b> environment variables.<br>
To do this,
<b> right-click My Computer > Properties > Advanced > Environment Variables</b><br>
Set a new user variable name <b>PATH</b>
with variable value <b>%PROGRAMFILES%\Frame3DD</b></br>
Set a new user variable name <b>FRAME3DD_OUTDIR</b>
with variable value <b>%HOMEPATH%\Desktop\Frame3DD\temp</b> .</br>
You will need to create this Temp folder: <b>Desktop\Frame3DD\temp</b> before running <b>Frame3DD</b>.<br>
Detailed information on how to set environment variables in Windows is <a href="http://vlaurie.com/computers2/Articles/environment.htm">here</a>, if you need it.
<li>Copy one or more of the example files (eg <b>exE.3dd</b>) from your <b>%PROGRAMFILES%\FRAME3DD\examples</b> folder into your <b>Desktop</b> folder
<li>
Open a
"<a href="http://www.bleepingcomputer.com/tutorials/tutorial76.html#intro">command prompt window</a>"
(Start > All Programs > Accessories > Command Prompt),
change to the directory of example files and run an example:
<pre>
chdir %HOMEPATH%\Desktop
frame3dd examples/exE.3dd examples/exE.out
</pre>
Some run-time information will be displayed on the Command Prompt window and
the results of your Frame3DD analysis will have been appended to the end of the <b>examples/exE.out</b> Output Data file.
Data files used primarily for plotting are stored in the <b>Desktop\Frame3DD\temp</b> folder.
<li> You may run <b>Frame3DD</b>, examine the analysis results, visualize the results using gnuplot, and edit Input Data files
as described above.
</ol>
-->
<h4> 3.3.4 Compiling Frame3DD from source for Windows </h4>
<ol>
<li> Install a GCC compatible compiler, such as the
<a href="http://www.delorie.com/djgpp/"> DJGPP gcc compiler</a>,
the <a href="http://www.cs.virginia.edu/~lcc-win32/"> LCC-win32 compiler</a>,
or the <a href="http://www.mingw.org/"> MinGW compiler</a>.
<!-- a href="https://sourceforge.net/projects/frame3dd/files/" -->
<!-- a href="https://sourceforge.net/projects/frame3dd/files/latest/download?source=files" -->
<a href="http://sourceforge.net/project/platformdownload.php?group_id=221386">
+Download</a>
the Frame3DD .ZIP archive (Frame3DD_VERSION.zip) and save it to your <b>Desktop</b>.<br>
If the .ZIP archive was not automatically unzipped,
double-click the icon to extract it to your <b>Desktop</b>.
and compile the code, as follows:
<pre>chdir Desktop\Frame3DD\src\
make
move frame3dd ..\windows\.
</pre>
</li></ol>
<a name="Matlab"><h2>4. Matlab Interface</h2>
</a><p><a name="Matlab">
<b>Frame3DD</b> may optionally be executed from within Matlab on any platform,
via the Matlab interface function </a><a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/matlab/frame_3dd.m">frame_3dd.m</a>
</p><pre>function [D,R,F,L,Ks] = frame_3dd(XYZ,JTS,RCT,EAIJ,P,U,D)
% [D,R,F,L,Ks] = frame_3dd (XYZ,JTS,RCT,EAIJ,P,U,D)
%
% Solve a a three-dimensional frame analysis problem
%
% INPUT DATA:
%
% XYZ : a 4xJ matrix containing the XYZ coordinate of each node
% row 1 = X-axis coordinate for each node
% row 2 = Y-axis coordinate for each node
% row 3 = Z-axis coordinate for each node
% row 4 = rigid radius for each node
%
% JTS : a 2xB matrix indicating which 2 nodes each frame element connects
% row 1 = the 'starting' node for each frame element
% row 2 = the 'ending' node for each frame element
%
% RCT : a 6xJ matrix indicated which nodes have reactions
% 0: the node has no reaction in that degree of freedom,
% 1: the node does have a reaction in that degree of freedom.
%
% EAIJ : a 10xB containing the section and modulus properties of each frame el.
% row 1 = Ax cross section area for each frame el.
% row 2 = Asy shear area y-directionfor each frame el.
% row 3 = Asz shear area z-directionfor each frame el.
% row 4 = Jxx torsional moment of inertia - x axis for each frame el.
% row 5 = Iyy bending moment of inertia - y axis for each frame el.
% row 6 = Izz bending moment of inertia - z axis for each frame el.
% row 7 = E elastic modulus for each frame el.
% row 8 = G shear modulus for each frame el.
% row 9 = p roll angle for each frame el.
% row 10 = d mass density for each frame el.
%
% P : a 6xJ matrix containing the components of the external
% forces and moments applied to each node.
% row 1 = External nodal force in X-direction for each node
% row 2 = External nodal force in Y-direction for each node
% row 3 = External nodal force in Z-direction for each node
% row 4 = External nodal moment about X-axis for each node
% row 5 = External nodal moment about Y-axis for each node
% row 6 = External nodal moment about Z-axis for each node
%
% U : a 3xB matrix containing the unif. dist. load on each frame element
% row 1 = uniform distributed load along the local element x axis
% row 2 = uniform distributed load in the local element y axis
% row 3 = uniform distributed load in the local element z axis
%
% D : a 6xJ matrix of prescribed displacements at the reaction DoF's
% row 1 = prescribed node displ. in the X-direction for each node
% row 2 = prescribed node displ. in the Y-direction for each node
% row 3 = prescribed node displ. in the Z-direction for each node
% row 4 = prescribed node rot'n about the X-axis for each node
% row 5 = prescribed node rot'n about the Y-axis for each node
% row 6 = prescribed node rot'n about the Z-axis for each node
%
% OUTPUT DATA:
%
% D : a 6xJ matrix of the deflections and rotations of each node
% R : a 6xJ matrix of the reaction forces and moments
% F : a 12xB matrix of the end forces of each frame element
% L : a 1xB vector of the length of each frame element
% Ks : a 6Jx6J matrix of the structural stiffness matrix
</pre>
<p></p>
<p>
The <b>Frame3DD</b> executable program
(<b>frame3dd</b> on Linux and OS X, <b>frame3dd.exe</b> on Windows)
and the matlab interface function, <b>frame_3dd.m</b>
must be saved to directories within your Matlab path.
<!--
You may either copy the <b>Frame3DD</b> executable program and <b>frame_3dd.m</b> to
directories in your Matlab path, or you may add the <b>Desktop/Frame3DD</b> and <b>Desktop/Frame3DD/matlab</b>
directories to your Matlab path.
-->
To display the or modify the matlab path, use the matlab command <b>path</b>.
</p>
<p>
In Linux and OS X you can add the Frame3DD directory to your matlab path with the matlab commands:<br>
</p><pre>path([ getenv('HOME') '/Desktop/Frame3DD' ],path)
path([ getenv('HOME') '/Desktop/Frame3DD/matlab' ],path)
</pre>
<p></p>
<p>
In Windows you can add the Frame3DD directory to your matlab path with the matlab commands:<br>
</p><pre>path([ getenv('USERPROFILE') '/Desktop/Frame3DD' ],path)
path([ getenv('USERPROFILE') '/Desktop/Frame3DD/matlab' ],path)
</pre>
<p></p>
<p>
The matlab interface function, <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/matlab/frame_3dd.m">frame_3dd.m</a>, executes the system command
(<b>frame3dd</b> on Linux and OS X, <b>frame3dd.exe</b> on Windows) to compute the solution.
</p><ol>
<li> The Matlab file for your problem first sets up the various matrices defining the problem for analysis and calls frame_3dd.m <br>
A <a href="http://svn.code.sourceforge.net/p/frame3dd/code/trunk/matlab/exA.m">Matlab version of Example A</a> illustrates
how to analyze problems using the Matlab interface to <b>Frame3DD</b>.<br>
Matlab versions of the other examples are forthcoming.
</li><li> frame_3dd.m writes a <b>Frame3DD</b> input data file called IOdata.FMM,
</li><li> frame_3dd.m calls a system command to run the executable program <b>frame3dd</b> in the input data file IOdata.FMM .
</li><li> The executable program <b>frame3dd</b> writes the Output Data to IOdata.OUT ,
and also writes IOdata_out.m, containing the Output Data.<br>
An m-file containing the Output Data is written whenever the frame3dd
executable is run on a file ending in ".FMM",
whether or not the analysis is initiated by frame_3dd.m.
</li><li> frame_3dd.m runs IOdata_out.m, containing the matrices D, R, F, L, and Ks,
</li><li> frame_3dd.m returns D, R, F, L, and Ks, to the Matlab workspace, or to your Matlab function.
</li></ol>
<p></p>
<p>
This m-function interface to <b>Frame3DD</b>
is currently capable of static analyses.
It does not (yet) implement the following features of <b>Frame3DD</b>:
</p><ul>
<li> Matlab functions for graphical display of the results
</li><li> gravity loading
</li><li> concentrated point forces applied at a point along a frame element
</li><li> trapezoidally-distributed loads
</li><li> temperature loads
</li><li> multiple load cases
</li><li> modal analysis
</li><li> matrix condensation
</li></ul>
<p></p>
<p>
Adding these features would require editing the matlab inteface function, frame_3dd.m.