Mercurial > repos > marcel > caddsuite_linux_x86_64

annotate CADDSuite-1.5/README @ 15:ac342506cd4e draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CADDSuite version 1.5
author Marcel Schumann <schumann.marcel@gmail.com>
date Tue, 24 Jul 2012 11:08:49 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
1 -----------------------------------------------------------------------
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
2 CADDSuite - A flexible and open framework and workflow system
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
3 for computer-aided drug design
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
4 -----------------------------------------------------------------------
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
5
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
6 This package contains all tools belonging to CADDSuite.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
7 For an overview over the contained tools, please see CADDSuite-description.txt.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
8 After extraction the package, you can directly start the applications using the startup-scripts in the base-folder.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
9
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
10 For more information about an individual tool, please call the tool without any parameters (or with '-help').
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
11
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
12
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
13
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
14 --------------------------------------------------------------------
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
15 Instructions for integration of CADDSuite into the workflow-system
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
16 Galaxy (http://getgalaxy.org)
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
17 --------------------------------------------------------------------
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
18
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
19
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
20 In order to install CADDSuite into your Galaxy installation, please to the following:
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
21
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
22 Let's assume $galaxybase is the base-folder of your Galaxy installation.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
23 If you don't have a galaxy-installation yet, download a version from http://getgalaxy.org and follow the installation instructions shown there first.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
24
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
25
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
26 -- Extract the CADDSuite archive into a new folder $galaxybase/tools/CADDSuite, or extract it somewhere else and create a link named $galaxybase/tools/CADDSuite that points to this destination.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
27
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
28 After this, you need to copy a few files that you find in the galaxyconfig/ subfolder of this archive to the destinations specified below:
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
29
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
30 -- Copy tool_conf.xml and datatypes_conf.xml to $galaxybase if you want to setup your Galaxy instance for exclusive use of CADDSuite, or copy the contents of those files into the files already existing in $galaxybase if you want to keep using tools that came along with the Galaxy installation.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
31
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
32 -- Copy molFiles.py, confFiles.py and countResidues.sh to $galaxybase/lib/galaxy/datatypes/
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
33
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
34 -- Add "#import molFiles, confFiles.py" to the beginning of the file $galaxybase/lib/galaxy/datatypes/registry.py
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
35
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
36
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
37
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
38 Last but not least, restart Galaxy.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
39 All CADDSuite tools should now appear in your Galaxy webinterface.
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
40
ac342506cd4e CADDSuite version 1.5
Marcel Schumann <schumann.marcel@gmail.com>
parents:
diff changeset
41