~ubuntu-branches/ubuntu/oneiric/chemtool/oneiric-proposed

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Michael Banck
  • Date: 2004-05-19 21:47:27 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040519214727-31y54lrvns5df8gn
Tags: 1.6.3-2
* debian/menu (needs, section): Quote entries.
* debian/rules.old: Removed file.
* chemtool.1: Added section and removed to superfluous spaces.
* debian/control (Standards-Version): Bumped to 3.6.1.0.
* debian/chemtool.install: Renamed to...
* debian/install: This.
* debian/chemtool.xpm: New file, a 32x32 version of chemtool.xpm.
* debian/install: Install debian/chemtool.xpm into /usr/share/pixmaps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-------------------------------------------------------------------------------
2
2
 
3
 
                        Chemtool Version 1.5
 
3
                        Chemtool Version 1.6.1
4
4
 
5
5
-------------------------------------------------------------------------------
6
6
 
7
7
Chemtool is a program for drawing organic molecules easily and store them as
8
8
a X bitmap file. It runs under the X Window System using the GTK widget set.
9
 
An older version (1.1.8) that requires only the standard Athena Widget Set
10
 
(Xlib) is still available for situations where GTK cannot be installed for
11
 
some reason. In principle, all features added since 1.1.8 could be
12
 
back-ported to the Xlib-based version if necessary. 
13
 
 
14
 
 
15
 
 
16
 
----------------------> Usage:
17
 
 
18
 
This program is intended to be very simple to use. You should be able to
19
 
find out most things by yourself. :-)
 
9
 
 
10
Most operations in chemtool can be accomplished using the mouse - the 
 
11
first (usually the left) button is used to select or place things, the
 
12
middle button modifies properties (e.g. reverses the direction of a bond),
 
13
and the right button is used to delete objects. 
 
14
 
 
15
The program offers essentially unlimited undo/redo, two text fonts plus
 
16
symbols, seven colors, drawing at several zoom scales, and square and
 
17
hexagonal backdrop grids for easier alignment.
20
18
 
21
19
Drawing of bonds:
22
20
 
28
26
appropriate angular positions. Dragging the mouse while holding down the
29
27
button draws a line in the desired direction.
30
28
 
31
 
All bonds are initially drawn as single lines (or the linetype that is 
32
 
preselected from the menubar) that can be converted to other types later.
33
 
 
34
 
Pressing the middle mousebutton on a bond increments its type code (see below),
35
 
while pressing the third (usually the right) button deletes the bond next
 
29
The bond style chooser in the center of the button bar determines the type
 
30
of bond that is drawn - initially, this is a single bond. If you want to
 
31
change the type of a bond later, either click on it with the middle button
 
32
of your mouse to advance to the next type(s), or select the appropriate type
 
33
in the chooser and then switch to bondtype mode and pick all bonds that you
 
34
want to change over to the new type. Pressing the middle mousebutton on a 
 
35
bond when in 'Bondtype' mode reverses the direction of that bond.
 
36
 
 
37
 
 
38
The bond types available in chemtool are
 
39
- a single bond
 
40
- a double bond (with one line shorter than the other)
 
41
- a double bond (having the shorter line on the opposite side)
 
42
- a centered double bond
 
43
- a triple bond (with the flanking lines shorter than the center)
 
44
- a wedge-shaped bond
 
45
- a dashed wedge-shaped bond
 
46
- a wavy line
 
47
- a dashed wide line
 
48
- a half arrow 
 
49
- an arrow
 
50
- a wide bond
 
51
- a circle
 
52
- a dotted line
 
53
- a single bond that 'cuts out' a segment from any bond it crosses
 
54
- a triple bond (with equal line lengths)
 
55
- a quadruple bond
 
56
 
 
57
The additional bond type available in the pulldown menu,
 
58
- curved arrow 
 
59
is special insofar as no other bond type can be converted to or from
 
60
this type. (it is actually a shortcut for one of the curve-drawing functions
 
61
described below).
 
62
 
 
63
Pressing the third (usually the right) mouse button deletes the bond next
36
64
to the cursor position.
37
65
 
38
 
 
39
66
Semiautomatic drawing of rings:
40
67
 
41
68
Rings of 3 to 12 members can be drawn easily by holding down the Ctrl key
58
85
'Move' mode, where they can be dragged around to change the form of a curve 
59
86
after it is drawn. 
60
87
 
61
 
Setting bond style:
62
 
 
63
 
In bond style mode, clicking on any bond in the diagram cycles its representation
64
 
through the sequence
65
 
- double bond 
66
 
- double bond (shorter line on the other side)
67
 
- centered double bond
68
 
- triple bond
69
 
- wedge-shaped bond
70
 
- dashed wedge-shaped bond
71
 
- wavy line
72
 
- half arrow 
73
 
- arrow
74
 
- wide bond
75
 
- circle
76
 
- dotted line
77
 
- single bond that 'cuts out' a segment from any bond it crosses
78
 
 
79
 
The additional bond type available in the pulldown menu,
80
 
- curved arrow 
81
 
is only available for drawing. It is actually a shortcut for one of 
82
 
the curve drawing functions described above, with the second and third
83
 
control points automatically generated. As such, it can not be converted 
84
 
to or from any of the conventional bond types. 
 
88
For drawing curved arrows, there is also a predefined function in the bond
 
89
style chooser. This is actually a shortcut for one of the curve drawing 
 
90
functions described above, with the second and third control points 
 
91
automatically generated. As such, it can not be converted to or from any 
 
92
of the conventional bond types. 
85
93
(One can, however, convert it to any of the other curve types, e.g. to change
86
94
the type of arrowhead). The shape of the arrow will usually need to be 
87
95
adjusted by shifting the control point that appears alongside it in 'Move' 
88
96
mode.
89
97
 
90
 
Pressing the middle mousebutton on a bond when in 'Bondtype' mode reverses 
91
 
the direction of that bond.
92
 
 
93
98
Inserting text:
94
99
 
95
100
Text written into the text box can be positioned with the cursor and may 
96
 
appear left, middle or right-aligned in the drawing. 
 
101
appear left, middle or right-aligned in the drawing. The font size can
 
102
be selected from the chooser to the right of the text entry field, while
 
103
the 't/T' button next to the text-alignment buttons lets you switch between
 
104
two fonts - Helvetica for regular labels, and Times Roman for descriptions.
 
105
Like the line drawings, text can be in any of the colors available on the
 
106
color selector. If you want to change the color, font or alignment of a
 
107
label afterwards, just choose the appropriate combination of settings and
 
108
then select the desired label with the left mouse button. When the text
 
109
entry area is empty, this will just update the properties without changing
 
110
the text itself. When the text entry area is not empty, its contents will
 
111
also replace the text of the label. Copying the text of a label to the
 
112
entry area is done with the middle mouse button, while the right mouse
 
113
button deletes the selected label.
 
114
 
97
115
There are two special characters to be used for sub- and superscripting
98
116
the following character: 
99
117
 
101
119
                '_' to shift down       (e.g. CH_3) 
102
120
 
103
121
The control character '|' is used to itializise the following character,
104
 
as in |t-Bu.
 
122
as in |t-Bu, while the '#' character boldfaces it.
105
123
 
106
124
The special character '@' switches to symbol mode, which uses the standard
107
125
X11 symbol font. All alphabetic keys produce the corresponding greek 
140
158
Labeling shortcuts :
141
159
 
142
160
In all bond drawing modes, several keyboard shortcuts are available to
143
 
simplify adding atom symbols at the current drawing position (the endpoint
144
 
of the last line drawn, or the spot last clicked on).
145
 
The keys 'c','h','n','o','s','p' and 'r' insert the corresponding letter,
146
 
'l' (lowercase L) inserts 'Cl', while '1', '2', '3' insert CH,CH_2 and CH_3,
147
 
respectively. The asterisk key (*) inserts a filled circle. The keys of the
148
 
numeric keypad can be used to draw short 'electron pair' lines next to an
 
161
add atom symbols without having to leave drawing mode. The label is placed
 
162
at the current drawing position (the endpoint of the last line drawn, or 
 
163
the spot last clicked on).
 
164
The keys 'c','h','n','o','s','p' and 'r' insert the corresponding capital
 
165
letter, 'l' (lowercase L) inserts 'Cl', while '1', '2', '3' insert CH,CH_2 
 
166
and CH_3, respectively. The asterisk key (*) inserts a filled circle. 
 
167
 
 
168
Pressing the space bar once allows you to enter arbitrary labels, which will
 
169
be placed at the current position when you press the Return key.
 
170
 
 
171
The keys of the numeric keypad can be used to draw short 'electron pair' lines next to an
149
172
element symbol - if one imagines the element symbol to be sitting on the 
150
173
central '5' key, each key draws the appropriate electron pair for its 
151
174
position.
152
175
 
153
 
Centering:
154
 
 
155
 
If there is not enough space for your molecule you can
156
 
put it in the middle of the sheet with the center button.
157
 
 
158
 
Exporting to foreign formats:
159
 
 
160
 
You can export your molecules as an X bitmap, an encapsulated postscript file, 
161
 
an input file for Brian Smith' XFig program, as an MDL molfile, or in the 
162
 
PicTeX format. 
163
 
The PicTeX and Postscript output functions rely on the fig2dev program from the 
164
 
transfig package.
165
 
You can create the outputs in different sizes according to the current zoom
166
 
scale. The PicTeX and Postscript modes additionally allow scaling to an 
167
 
arbitrary percentage selectable on the export menu .
168
 
 
169
 
To include the PicTeX-file in your LaTeX document, you will need the pictex 
170
 
macro package. Depending on the versions you use, you might also have to load 
171
 
the 'color' package in the preamble of your LaTeX file.
172
 
If you experience 'TeX capacity exceeded' error messages, increase the 
173
 
extra_mem_bot parameter in your texmf.cnf file (usually located in 
174
 
/usr/share/texmf/web2c, /usr/local/texmf or /etc/texmf). 
175
 
Pictex is known for its unusual (by tex standards) memory requirements, and 
176
 
the standard settings often do not account for this (although you may find a 
177
 
comment a la 'change this if you use pictex' in the texmf.cnf file).
178
 
Something like extra_mem_bot=400000 should not hurt on any moderately modern 
179
 
system.
180
 
 
181
 
Selecting all or parts of a drawing for transformations:
 
176
For quick numbering of the atoms in a molecule, switch to one of the text
 
177
modes, hold down the Control key and pick each atom in succession with 
 
178
the left mouse button. Numbering starts at 1, and the sequence can be reset
 
179
at any time by clicking the right mouse button. If you need to use your own
 
180
numbering scheme, clicking the middle button (while still holding down the
 
181
Control key) makes it pick up whatever number is in the text entry field.
 
182
 
 
183
Moving, rotating, flipping or scaling objects
182
184
 
183
185
Using the 'Mark' button, you can easily select parts of the current drawing
184
 
by enclosing them with a 'rubberband' rectangle. The selected parts will appearhighlighted in blue and are immediately available for 
 
186
by enclosing them with a 'rubberband' rectangle. If you need to add atoms 
 
187
outside of the rectangular area to your selection, simply draw another
 
188
rubberband around them while holding down the Ctrl key.
 
189
The selected parts will appear highlighted in blue and are immediately 
 
190
available for 
185
191
 
186
192
- moving: simply drag the fragment to the desired position with the mouse
187
193
        while holding down the left mouse button. Pressing the Ctrl key
203
209
            (usually the right) mouse button after it is highlighted.
204
210
- optimizing: clicking on the 'bucket and broom' symbol invokes a function
205
211
             that removes overlapping (duplicate) bonds and labels from
206
 
             the drawing.
 
212
             the drawing and tries to straighten bonds that are almost
 
213
             horizontal or vertical.
207
214
- bracketing and framing: clicking on the bracket button invokes a pop-up
208
215
  menu offering a choice of brackets and various boxes. The chosen item
209
216
  is drawn in the size and position determined by the marker box that was
210
217
  drawn by the user.
 
218
 
 
219
Centering the drawing:
 
220
 
 
221
If there is not enough space for your molecule you can
 
222
put it in the middle of the sheet with the center button.
 
223
 
 
224
Exporting to foreign formats:
 
225
 
 
226
You can export your molecules as an X bitmap, an encapsulated postscript file, 
 
227
an input file for Brian Smith' XFig program, as an MDL molfile, or in the 
 
228
PicTeX format. 
 
229
The PicTeX and Postscript output functions rely on the fig2dev program from the 
 
230
transfig package.
 
231
You can create the outputs in different sizes according to the current zoom
 
232
scale. The PicTeX and Postscript modes additionally allow scaling to an 
 
233
arbitrary percentage selectable on the export menu .
 
234
 
 
235
To include the PicTeX-file in your LaTeX document, you will need the pictex 
 
236
macro package. Depending on the versions you use, you might also have to load 
 
237
the 'color' package in the preamble of your LaTeX file.
 
238
If you experience 'TeX capacity exceeded' error messages, increase the 
 
239
extra_mem_bot parameter in your texmf.cnf file (usually located in 
 
240
/usr/share/texmf/web2c, /usr/local/texmf or /etc/texmf). 
 
241
Pictex is known for its unusual (by tex standards) memory requirements, and 
 
242
the standard settings often do not account for this (although you may find a 
 
243
comment a la 'change this if you use pictex' in the texmf.cnf file).
 
244
Something like extra_mem_bot=400000 should not hurt on any moderately modern 
 
245
system.
 
246
 
211
247
 
212
248
Adding previously saved figures:
213
249
 
216
252
button. Marking a file in the dialog automatically displays its contents
217
253
in a small preview window.
218
254
The newly added molecule is automatically made active so that it can be 
219
 
repositioned as desired.
 
255
repositioned as desired. If you want to add it to a predefined position
 
256
on another molecule, you can mark that attachment site by left-clicking
 
257
on it instead of dragging the marker rectangle. A small green dot will
 
258
appear at what is now the reference position for the new part. If you save
 
259
molecules with such a marker set, it will in turn define their attachment
 
260
site when they are added to another drawing.  
220
261
 
221
262
Adding one of the predefined templates:
222
263
 
223
 
Pressing the 'Templates' button opens a second window with a small collection
224
 
of predefined structures. Simply click on the preview of the desired molecule
225
 
to add it to your drawing. The Template window can be kept open throughout a
226
 
chemtool session - if it is hidden by another window, you can move it to the
227
 
front by clicking the 'Template' button in chemtool again.
 
264
Choosing 'Templates' from the 'Tools' menu opens a second window with a small 
 
265
collection of predefined structures. 
 
266
Simply click on the image of the desired molecule to add it to your drawing. 
 
267
The Template window can be kept open throughout a chemtool session - if it 
 
268
is hidden by another window, you can move it to the front by clicking the 
 
269
'Template' button in chemtool again.
228
270
The data in the template system differ from normal chemtool drawings only by
229
271
the fact that they are stored within the program, and in a slightly awkward
230
272
format (x and y coordinates listed separately in the source file templates.h).
239
281
Chemtool is able to import files written either in the PDB format originally
240
282
used by the Protein Databank (which is now also written by most modeling
241
283
packages), or in the molfile (V2000) format developed by MDL Inc. for their
242
 
ISIS products. As both formats can contain 3D information, while chemtool
 
284
ISIS products. 
 
285
As both formats can contain 3D information, while chemtool
243
286
at least currently does 2D drawing only, the molecule is imported as a temporary3D image first, which can be rotated using the mouse (with Z-axis rotation
244
287
initiated by pressing the Ctrl key simultaneously with the (left) mouse 
245
288
button 1). After pressing the Return key, the current orientation is stored
251
294
from CONECT records, if present, or guessed from the interatomic distances.
252
295
In MDL import mode, C atom labels are automatically suppressed, and bond 
253
296
types are preserved where possible. 
 
297
If you have a version of the BABEL program installed - either the original
 
298
Babel written by Pat Walters or the current OpenBabel effort - chemtool will
 
299
automatically offer a menu option for importing from any of the file formats
 
300
this supports.
254
301
 
255
302
Determining sum formula and molecular weight:
256
303
 
263
310
reaction arrows and by the 'aromatic ring' symbol, so you should avoid these 
264
311
and check the plausibility of the generated sum formula where possible.
265
312
 
 
313
The following common abbreviations are known to cht:
 
314
Ac      #   C2  H3      O           # Acetyl
 
315
Ade     #   C5  H4  N5              # Adeninyl
 
316
Bn      #   C7  H7                  # Benzyl
 
317
Bu      #   C4  H9                  # Butyl
 
318
Bz      #   C7  H5      O           # Benzoyl
 
319
BOC     #   C5  H9      O2          # Butyloxycarbonyl
 
320
CE      #   C3  H4  N               # Cyanoethyl
 
321
Cyt     #   C4  H4  N3  O           # Cytosinyl
 
322
DBAM    #   C9  H19 N               # Dibutylaminomethylene, biradical
 
323
DMAM    #   C3  H7  N               # Dimethylaminomethylen, biradical
 
324
DMTr    #   C21 H19     O2          # Dimethoxytrityl
 
325
Et      #   C2  H5                  # Ethyl
 
326
Gua     #   C5  H4  N5  O           # Guaninyl
 
327
iBu     #   C4  H9                  # iso-Butyl
 
328
iPr     #   C3  H7                  # iso-Propyl
 
329
Me      #   C   H3                  # Methyl
 
330
Ms      #   C   H3  S   O2          # Mesyl
 
331
MOC     #   C2  H3      O2          # Methoxycarbonyl
 
332
MOM     #   C2  H5      O           # Methoxymethyl
 
333
MMTr    #   C20 H16     O           # Monomethoxytrityl
 
334
Ph      #   C6  H5                  # Phenyl
 
335
@F (phi)#   C6  H5                  # Phenyl
 
336
Pr      #   C3  H7                  # Propyl
 
337
TBDMS   #   C6  H15 Si              # tert-Butyldimethylsilyl
 
338
TBDPS   #   C16 H19 Si              # tert-Butyldiphenylsilyl
 
339
tBu     #   C4  H9                  # tert-Butyl
 
340
Tf      #   C   F3  S   O2          # Triflyl
 
341
Thy     #   C5  H5  N2  O2          # Thyminyl
 
342
TMS     #   C3  H9  Si              # Trimethylsilyl
 
343
TMTr    #   C22 H22     O3          # Dimethoxytrityl
 
344
Tol     #   C8  H7      O           # Tolyl
 
345
Tr      #   C19 H15                 # Trityl
 
346
Ts      #   C7  H7  S   O2          # Tosyl
 
347
Ura     #   C4  H3  N2  O2          # Uracilyl
 
348
Z       #   C8  H7      O2          # Benzyloxycarbonyl
266
349
 
267
350
Drawing functions not available within Chemtool:
268
351
 
269
 
For features not currently supported by chemtool, like color or 
 
352
For features not currently supported by chemtool, like patterns or 
270
353
general line-drawing functions, getting Brian Smith's XFig 
271
354
drawing package from www-epb.lbl.gov/xfig is highly recommended.
272
355
About the only thing it does not offer is support for 'chemical' linetypes
276
359
general-purpose features of xfig seems rather pointless.)
277
360
 
278
361
 
279
 
----------------------> Early history (T.Volk):
280
 
 
281
 
15.Feb.1998     I fixed a bug that sometimes crashed the program,
282
 
                when one use the center or zoom function.
283
 
 
284
 
27.Feb.1998     Another (crash) bug was fixed.
285
 
 
286
 
 
287
 
28.Feb.1998     Adding new features :
288
 
                                        export to xfig and PicTeX;
289
 
                                        moving of objects;
290
 
 
291
 
12.Mar.1998     The LaTeX and xfig-output works with 3 different
292
 
                zoom factors.
293
 
 
294
 
for later changes see the file ChangeLog
295
 
 
296
 
----------------------> Licensing :
 
362
Licensing :
297
363
 
298
364
For license information see the file 'COPYING' in this package, i.e. the
299
365
GNU General Public License.  This software comes with ABSOLUTELY NO WARRANTY.
302
368
----------------------> Primary Authors:
303
369
 
304
370
Thomas Volk      (program creator, maintainer up to 1.1.1)
305
 
Hauffstrasse 12
306
 
89077 Ulm
307
 
Germany
308
 
E-Mail:         Thomas.Volk@student.uni-ulm.de
 
371
(then a student of chemistry and biology at Ulm University)
309
372
 
310
373
Dr. Martin Kroeker (primary developer since 1.1.2)
311
 
Zum Markwald 6
312
 
63165 Muehlheim
313
 
Germany
314
 
martin@ruby.chemie.uni-freiburg.de or mk@daveg.com      
 
374
martin@ruby.chemie.uni-freiburg.de       
315
375
 
316
 
Webpage:        http://www.uni-ulm.de/~s_tvolk
317
 
Alternative site and Development versions: 
 
376
Webpage:        
318
377
http://ruby.chemie.uni-freiburg.de/~martin/chemtool/chemtool.html
319
378
 
 
379