Debian Codegraph @

README

raw
1 This document describes the Perl modules and scripts contained in this
2 distribution for parsing STAR compliant data files and dictionaries.
3
4 It contains the following parts:
5
6 -- General description
7 -- Installation instructions
8 -- Usage instructions
9 -- Copyright notice
10
11
12 General description
13 -------------------
14
15 This distribution contains a set of Perl modules for parsing STAR compliant
16 data files and dictionaries, for example CIF or mmCIF data files and
17 dictionaries. While these tools are not limited to CIF or mmCIF files, they
18 do not allow the presence of nested loops.
19
20 The following modules are included in this distribution:
21
22 STAR::Parser
23 STAR::DataBlock
24 STAR::Dictionary
25 STAR::Writer
26 STAR::Checker
27 STAR::Filter
28
29 Some simple examples of application scripts are also included.
30
31
32 Installation instructions
33 -------------------------
34
35 Unzip and untar the archive:
36
37 % gunzip STAR.tar.gz
38 % tar xvf STAR.tar
39 % cd STAR
40
41 Install the perl modules:
42
43 % perl Makefile.PL
44 % make
45 % make test
46 % make install
47
48 These commands should install the modules into a default location on your
49 system.
50
51 Alternatively, you may create a STAR directory in a location of your choice,
52 copy the "*.pm" files into the newly created STAR directory, and include a
53 "use lib" line in all of the "*.pl" scripts in the bin directory:
54
55 use lib "<path to the directory above STAR>";
56
57 The modules require Storable to be installed in your Perl distribution.
58 (See ftp://ftp.cpan.org/pub/perl/CPAN/modules/by-module/Storable/ )
59
60
61 Usage instructions
62 ------------------
63
64 Users are expected to have a working knowledge of Perl and a basic familiarity
65 of CIF or some other STAR compliant data file formats.
66
67 Detailed documentation for each "*.pm" Perl module can be extracted
68 with pod2html:
69
70 % pod2html Parser.pm > Parser.html
71
72 or viewed with perldoc:
73
74 % perldoc Parser.pm
75
76 Each "*.pl" script has a minimum description and usage information embedded,
77 which can be viewed with perldoc:
78
79 % perldoc parse.pl
80
81 The included scripts are a mixture of basic utility scripts (e.g. parse.pl or
82 check.pl), and very simplistic examples that are meant to test certain methods
83 in the modules (e.g. create.pl). Most users would generally be expected to
84 write their own customized scripts.
85
86 The included documentation should be sufficient for all the scripts and
87 modules. As a general comment, please be aware of the type of files each
88 script operates on:
89
90 parse.pl reads a CIF text file (.cif file). It has an option of saving
91 the parsed data structure as a ".cob" (cif object) file. Note that the file
92 extentions are by convention only, and are not enforced.
93
94 write.pl reads a data structure (.cob file) and outputs a CIF text file
95 (.cif file).
96
97 All other scripts operate on data structures (.cob files), *NOT* on CIF text
98 files (.cif files).
99
100 Therefore, a user will probably want to first parse files and dictionaries,
101 save the data structures (as .cob files) and then apply some of the other
102 scripts to the saved data structures:
103
104 % perl parse.pl -s 1LEP.cif
105 % perl parse.pl -Ds mmcif1000.dic
106 % perl check.pl -l 1LEP.cob cif_mm.dic.cob
107
108 etc.
109
110 More information on mmCIF can be found at these web sites:
111
112 http://pdb.rutgers.edu/mmcif/
113 http://ndbserver.rutgers.edu/mmcif/
114
115 Additional questions or comments may be directed to the author of these
116 modules and scripts:
117
118 Wolfgang Bluhm
119 [email protected]
120
121
122 Copyright notice
123 ----------------
124
125 A full copyright statement is provided with the distribution
126 (c) 2000 University of California, San Diego