| 1 | package PerlMol; | ||
| 2 | |||
| 3 | $VERSION = '0.3500'; | ||
| 4 | # $Id: PerlMol.pm,v 1.5 2005/05/13 20:40:33 itubert Exp $ | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | =head1 NAME | ||
| 9 | |||
| 10 | PerlMol - Perl modules for molecular chemistry | ||
| 11 | |||
| 12 | =head1 SYNOPSIS | ||
| 13 | |||
| 14 | # This is a bundle containing all of the modules | ||
| 15 | # of the PerlMol Project and their dependencies. | ||
| 16 | # This is not a real module; it is the main index | ||
| 17 | # to the documentation of the PerlMol modules. | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | PerlMol is a collection of Perl modules for chemoinformatics and computational | ||
| 22 | chemistry with the philosophy that "simple things should be simple". It should | ||
| 23 | be possible to write one-liners that use this toolkit to do meaningful | ||
| 24 | "molecular munging". The PerlMol toolkit provides objects and methods for | ||
| 25 | representing molecules, atoms, and bonds in Perl; doing substructure matching; | ||
| 26 | and reading and writing files in various formats. | ||
| 27 | |||
| 28 | =head1 DOCUMENTATION | ||
| 29 | |||
| 30 | What follows is an index of the relevant documentation. | ||
| 31 | |||
| 32 | =head2 Tutorial | ||
| 33 | |||
| 34 | =over | ||
| 35 | |||
| 36 | =item L<Chemistry::Tutorial> - A good place to start reading the documentation. | ||
| 37 | |||
| 38 | =back | ||
| 39 | |||
| 40 | =head2 Object oriented modules | ||
| 41 | |||
| 42 | The following modules are indented according to the class hierarchy: | ||
| 43 | |||
| 44 | =over | ||
| 45 | |||
| 46 | =item L<Chemistry::Obj> | ||
| 47 | |||
| 48 | =over | ||
| 49 | |||
| 50 | =item L<Chemistry::Mol> | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item L<Chemistry::Pattern> | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item L<Chemistry::FormulaPattern> | ||
| 59 | |||
| 60 | =item L<Chemistry::MidasPattern> | ||
| 61 | |||
| 62 | =back | ||
| 63 | |||
| 64 | =item L<Chemistry::Domain> | ||
| 65 | |||
| 66 | =item L<Chemistry::MacroMol> | ||
| 67 | |||
| 68 | =item L<Chemistry::Ring> | ||
| 69 | |||
| 70 | =back | ||
| 71 | |||
| 72 | =item L<Chemistry::Atom> | ||
| 73 | |||
| 74 | =over | ||
| 75 | |||
| 76 | =item L<Chemistry::Pattern::Atom> | ||
| 77 | |||
| 78 | =back | ||
| 79 | |||
| 80 | =item L<Chemistry::Bond> | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item L<Chemistry::Pattern::Bond> | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | =item L<Chemistry::File> | ||
| 91 | |||
| 92 | =over | ||
| 93 | |||
| 94 | =item L<Chemistry::File::Formula> | ||
| 95 | |||
| 96 | =item L<Chemistry::File::FormulaPattern> | ||
| 97 | |||
| 98 | =item L<Chemistry::File::MDLMol> | ||
| 99 | |||
| 100 | =item L<Chemistry::File::MidasPattern> | ||
| 101 | |||
| 102 | =item L<Chemistry::File::Mopac> | ||
| 103 | |||
| 104 | =item L<Chemistry::File::PDB> | ||
| 105 | |||
| 106 | =item L<Chemistry::File::SDF> | ||
| 107 | |||
| 108 | =item L<Chemistry::File::SLN> | ||
| 109 | |||
| 110 | =item L<Chemistry::File::SMARTS> | ||
| 111 | |||
| 112 | =item L<Chemistry::File::SMILES> | ||
| 113 | |||
| 114 | =item L<Chemistry::File::VRML> | ||
| 115 | |||
| 116 | =item L<Chemistry::File::XYZ> | ||
| 117 | |||
| 118 | =back | ||
| 119 | |||
| 120 | =item L<Chemistry::InternalCoords> | ||
| 121 | |||
| 122 | =item L<Chemistry::Mok> | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | =head2 Procedural modules | ||
| 127 | |||
| 128 | These are auxiliary modules for which object classes seemed overkill | ||
| 129 | |||
| 130 | =over | ||
| 131 | |||
| 132 | =item L<Chemistry::3DBuilder> | ||
| 133 | |||
| 134 | =item L<Chemistry::Bond::Find> | ||
| 135 | |||
| 136 | =item L<Chemistry::InternalCoords::Builder> | ||
| 137 | |||
| 138 | =item L<Chemistry::Ring::Find> | ||
| 139 | |||
| 140 | =item L<Chemistry::Canonicalize> | ||
| 141 | |||
| 142 | =back | ||
| 143 | |||
| 144 | =head2 Programs (scripts) | ||
| 145 | |||
| 146 | =over | ||
| 147 | |||
| 148 | =item L<mok> - an AWK for molecules | ||
| 149 | |||
| 150 | =back | ||
| 151 | |||
| 152 | =head2 PerlMol bundle description and contents | ||
| 153 | |||
| 154 | =over | ||
| 155 | |||
| 156 | =item L<PerlMol> - This document | ||
| 157 | |||
| 158 | =back | ||
| 159 | |||
| 160 | =head2 Publications | ||
| 161 | |||
| 162 | =over | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | Tubert-Brohman, I. Perl and Chemistry. The Perl Journal 2004-06 (subscription | ||
| 167 | required) | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | Cozens, S. Molecular Biology With Perl. The Perl Journal 2004, 8[8], 15-19 | ||
| 172 | (L<http://www.tpj.com/documents/s=7618/tpj0408/>; requires subscription) | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | F. Rosselló, G. Valiente. Chemical Graphs, Chemical Reaction Graphs, and | ||
| 177 | Chemical Graph Transformation. 2nd Int. Workshop on Graph-Based Tools, | ||
| 178 | Electronic Notes in Computer Science 2005, 127, 157-166. (abstract: | ||
| 179 | L<http://www.lsi.upc.es/%7Evaliente/abs-grabats-2004.html>; preprint full text: | ||
| 180 | L<http://tfs.cs.tu-berlin.de/grabats/Final04/valiente.pdf>; published version: | ||
| 181 | L<http://dx.doi.org/10.1016/j.entcs.2004.12.033>). | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | Rosselló, F.; Valiente, G. Graph Transformation in Molecular Biology. (Full | ||
| 186 | text: L<http://bioinfo.uib.es/~cesc/recerca/he-paper.pdf>). | ||
| 187 | |||
| 188 | =back | ||
| 189 | |||
| 190 | =head1 EXAMPLES | ||
| 191 | |||
| 192 | The "examples" directory in the PerlMol distribution file has several sample | ||
| 193 | scripts with lots of comments and a few input and output files that show how | ||
| 194 | one can use PerlMol for common tasks. They can also be browsed online at | ||
| 195 | L<http://www.perlmol.org/examples/>. Some of the examples are: | ||
| 196 | |||
| 197 | * combinatorial_enumeration | ||
| 198 | * file_conversion | ||
| 199 | * molgrep | ||
| 200 | * pdb_viewer | ||
| 201 | * peptide_builder | ||
| 202 | * polar_surface_area | ||
| 203 | |||
| 204 | =head1 VERSION INFORMATION | ||
| 205 | |||
| 206 | This is the PerlMol bundled release version 0.3500. It includes the following | ||
| 207 | distributions: | ||
| 208 | |||
| 209 | Chemistry-3DBuilder 0.10 | ||
| 210 | Chemistry-Bond-Find 0.21 | ||
| 211 | Chemistry-Canonicalize 0.10 | ||
| 212 | Chemistry-File-MDLMol 0.20 | ||
| 213 | Chemistry-File-Mopac 0.15 | ||
| 214 | Chemistry-File-PDB 0.21 | ||
| 215 | Chemistry-File-SLN 0.10 | ||
| 216 | Chemistry-File-SMARTS 0.22 | ||
| 217 | Chemistry-File-SMILES 0.44 | ||
| 218 | Chemistry-File-VRML 0.10 | ||
| 219 | Chemistry-File-XYZ 0.11 | ||
| 220 | Chemistry-FormulaPattern 0.10 | ||
| 221 | Chemistry-InternalCoords 0.18 | ||
| 222 | Chemistry-Isotope 0.11 | ||
| 223 | Chemistry-MacroMol 0.06 | ||
| 224 | Chemistry-MidasPattern 0.11 | ||
| 225 | Chemistry-Mok 0.25 | ||
| 226 | Chemistry-Mol 0.35 | ||
| 227 | Chemistry-Pattern 0.26 | ||
| 228 | Chemistry-Reaction 0.02 | ||
| 229 | Chemistry-Ring 0.18 | ||
| 230 | Math-VectorReal 1.02 | ||
| 231 | Parse-Yapp 1.05 | ||
| 232 | Statistics-Regression 0.15 | ||
| 233 | |||
| 234 | The version number of a PerlMol bundle is always the same as the version number | ||
| 235 | of the included Chemistry-Mol distribution, plus two extra digits that | ||
| 236 | distinguish between different bundles based on the same Chemistry-Mol | ||
| 237 | distribution. | ||
| 238 | |||
| 239 | =head1 SEE ALSO | ||
| 240 | |||
| 241 | The PerlMol website L<http://www.perlmol.org/> | ||
| 242 | |||
| 243 | =head1 AUTHOR | ||
| 244 | |||
| 245 | Ivan Tubert-Brohman E<lt>itub@cpan.orgE<gt> | ||
| 246 | |||
| 247 | =head1 COPYRIGHT | ||
| 248 | |||
| 249 | Copyright (c) 2005 Ivan Tubert-Brohman All rights reserved. This program is | ||
| 250 | free software; you can redistribute it and/or modify it under the same terms as | ||
| 251 | Perl itself. | ||
| 252 | |||
| 253 | =cut | ||
| 254 |