annotate mayachemtools/README.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 INTRODUCTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 MayaChemTools is a growing collection of Perl scripts, modules, and classes
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 to support day-to-day computational discovery needs.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 The current release of MayaChemTools provides command line scripts for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 the following tasks: Manipulation of SD, CSV/TSV, Sequence/Alignments,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 and PDB files; Analysis of data in SD, CSV/TSV, and Sequence/Alignments
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 files; Information about data in SD, CSV/TSV, Sequence/Alignments, PDB,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 and fingerprints files; Exporting data from Oracle and MySQL tables into text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 files Properties of periodic table elements, amino acids, and nucleic acids;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 Elemental analysis;Generation of fingerprints corresponding to atom
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 neighborhoods, atom types, E-state indicies, extended connectivity,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 MACCS keys, path lengths, topological atom pairs, topological atom triplets,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 topological atom torsions, topological pharmacophore atom pairs, and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 topological pharmacophore atom triplets; Generation of fingerprints
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 with atom types corresponding to atomic invariants, DREIDING, E-state,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 functional class, MMFF94, SLogP, SYBYL, TPSA and UFF; Calculation of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 similarity matrices using a variety of similarity and distance coefficients;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 Calculation of physicochemical properties including rotatable bonds,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 van der Waals molecular volume, hydrogen bond donors, hydrogen bond
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 acceptors, SLogP, TPSA, molecular complexity and so on; Similarity
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 searching using fingerprints.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 Review the documentation for further details.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 INSTALLATION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 1. Add <YOUR MAYACHEMTOOLS DIR>/bin to your PATH environment variable.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 2. And check to make sure PATH doesn't contain multiple entries for MayaChemTools
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 package, and all *.pl files in <YOUR MAYACHEMTOOLS DIR>/bin are executable.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 That's it. And you're all set to try out the various scripts.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 CAVEATS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 All output files generated by MayaChemTools package contain UNIX style new line
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 character; you can modify it using ModifyNewLineChar.pl script.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 DEPENDENCIES
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 Perl v5.8 or higher. Additional Perl modules required to use database scripts: DBI,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 DBD-mysql and/or DBD-Oracle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 SUPPORTED PLATFORMS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 Whatever Perl supports: www.cpan.org/ports/. It includes support for various
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 flavors of UNIX, LINUX, Windows, and Mac operating systems running on all kinds
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 of hardware platforms.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 PERL DOWNLOAD
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 www.cpan.org
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 FEEDBACK
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 Manish Sud<msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 COPYRIGHT & LICENSE
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 the terms of the GNU Lesser General Public License. Please see GNULICENSE.txt
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 file for additional information.