Debian Codegraph @

README

raw
1 gdpc - a program for visualising molecular dynamic simulations
2 Copyright (C) 1999 Jonas Frantz
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17
18 My email : [email protected]
19
20
21 GDPC Documentation
22 ------------------
23
24 Contents
25 1. Background
26 2. Usage
27 3. Input file formats
28 4. Source files and compiling
29 5. Reporting bugs, suggesting features and known bugs
30 6. Disclaimer
31 7. About the author
32
33
34 1. Background
35
36 gdpc was written as a replacement for dpc, a visualising tool for molecular
37 dynamics. dpc was written in the beginning of the nineties by Kai Nordlund
38 and had various problems with event handling. Kai asked me to take a look at
39 it, and fix it if I could. After writing the original sourcecode, Kai had
40 added many different features, leaving the code as a total mess. I had no
41 chance of making out what was wrong with it, so I decided to try to write it
42 from scratch using GTK+.
43
44 After some weeks of coding I had a usable version of it, which I asked some
45 of my co-workers to try out. They gave me suggestions for new features and
46 reported bugs, after some more weeks of coding I implemented the graphical
47 setupwindow so new users could learn to use it more easily.
48 After major code cleanup in version 1.20, I decided that gdpc was stable and
49 bugfree enough that it could be released to the public.
50
51
52 2. Usage
53
54 gdpc is mainly and most easily used from the graphical initialization
55 window but for faster usage I recommend the command prompt. Using gdpc:s
56 setupwindow is almost selfexplanatory, if you cant figure out what an option
57 does test it. From the command prompt the only necessary options to run gdpc
58 are the column representations and the input file.
59 The column representations describe from what column gdpc tries to read
60 certain data, the first column respresents x, the second y, the third z and
61 the fourth t. If the input file s in xyz format the t column will be skipt
62 and the time will be read from the input datas headers.
63
64 The usage of the program is pretty easy to learn and by doing some testing
65 with it you should learn to master it.
66 To demonstrate gdpc I have included som example input files liquid.out and
67 md.movie, the first being in general file format and the other in xyz file
68 format.
69
70 They can best be tested with the commands:
71 gdpc cube 30 m 2 d 20 erase 1 2 3 4 liquid.test
72 gdpc m 2 d 10 erase xyz 2 3 4 5 md.test
73 gdpc m 2 d 10 erase usetypes xyz 2 3 4 5 manytypes.test
74
75
76 3. Input file formats
77
78 The general file format consists of at least four coulmns of data, x,y,z and t.
79 gdpc will read data to each frame as long as the t column data stays the same,
80 after that it will plot the frame and start reading the next frames data.
81
82 The xyz file format consists of several frames with their own headers.
83 The header consists of two lines, the first consists of only one number the
84 number of atoms. The second line is a comment line and it is from this line
85 that gdpc searches for the time, actually it searches for the string "fs" and
86 when found it, takes the number before this string.
87 Then follows as many lines of atom data as was declared on the first row of
88 the header. After reading the data it expects another header directly after the
89 atomdata has ended.
90
91
92 4. Source files and compiling
93
94 main.c The programs main code can be found in this file. The confi-
95 guration of the window and calling other important functions
96 is handled here.
97 drawatoms.c This file contains functions relevant to the drawing of the
98 atoms to the pixmap and the rotating of the coordinates.
99 readinput.c This file contains the functions which handles reading the
100 data from the inputfile.
101 rotate.c This files contain functions that handle the buttons of the
102 rotations.
103 sort.c This file contains a function for sorting the coordinates.
104 colors.c In this file the settings of the colorschemes are made.
105 setup.c This file contains the functions for the graphical initialization
106 and setup window and everything related to it.
107 parameters.h This file contains default parameters for most options, the
108 version number and some basic structures.
109
110 To compile gdpc you have to have gtk+ 1.2 and Imlib installed on your system.
111 You can get gtk+ from http://www.gtk.org and you'll find Imlib on
112 http://www.labs.redhat.com/imlib. gdpc has to this moment been compiled on
113 Redhat 6.0 both i386 and alpha architectures, but I can't see why it
114 wouldn't be compilable in another environment as long as you have gtk+ and
115 Imlib properly installed.
116
117
118
119 5. Repoting bugs, suggesting features and known bugs
120
121 Bugs can be reported to [email protected] or to [email protected].
122 Please include the input files you were running, the exact parameters used
123 when the bug occured and a reproducable description of what you're doing when
124 the bug occures.
125
126 New features can be reported to [email protected], dont expect them to
127 get implemented at the moment of the arrival of the mail, because I got other
128 things to do as well.
129
130 No known bugs at this moment (V 1.28)
131
132
133 6. Disclaimer
134
135 I can not be held responsible if this program fucks up your computer. gdpc comes
136 with no warranty.
137
138
139 7. About the author
140
141 My name is Jonas Frantz, when I'm not working as a research associate at the
142 Helsinki University accelerator lab I'm studying physics. I'm beginning my third
143 year of studies this fall and I expect to finish them in about 1-2 years.
144
145 My summerjob at the acceleratorlab contains of simulating SiGe interface recoils,
146 if you don't know anything about materialphysics, I can tell you that it
147 practically about giving a kinetic energy to one atom in the SiGe interface and
148 to watch what happends (mostly atomic movement over the interface(mixing)).
149
150 Update Summer 2000 : This summer I'm simulation bond breaking in Si, primarily
151 electronic sputtering of Si surfaces and recristallisation of amorphous areas in
152 a-Si.
153
154 gdpc is a very useful tool in visualising what happends in the simulation and
155 creating demonstrative pictures from them and I have had lots of help from it.