annotate CADDSuite/README @ 0:bac3c274238f

Migrated tool version 0.93 from old tool shed archive to new tool shed repository
author marcel
date Tue, 07 Jun 2011 16:43:30 -0400
parents
children b7a89b15646f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
1 -----------------------------------------------------------------------
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
2 CADDSuite - A flexible and open framework and workflow system
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
3 for computer-aided drug design
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
4 -----------------------------------------------------------------------
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
5
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
6 This package contains all tools belonging to CADDSuite.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
7 For an overview over the contained tools, please see CADDSuite-description.txt.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
8 After extraction the package, you can directly start the applications using the startup-scripts in the base-folder.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
9
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
10 For more information about an individual tool, please call the tool without any parameters (or with '-h').
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
11
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
12
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
13
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
14 --------------------------------------------------------------------
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
15 Instructions for integration of CADDSuite into the workflow-system
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
16 Galaxy (http://getgalaxy.org)
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
17 --------------------------------------------------------------------
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
18
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
19
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
20 In order to install CADDSuite into your Galaxy installation, please to the following:
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
21
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
22 Let's assume $galaxybase is the base-folder of your Galaxy installation.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
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.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
24
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
25
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
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.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
27
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
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:
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
29
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
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.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
31
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
32 -- Copy molFiles.py, confFiles.py and countResidues.sh to $galaxybase/lib/galaxy/datatypes/
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
33
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
34 -- Add "#import molFiles, confFiles.py" to the beginning of the file $galaxybase/lib/galaxy/datatypes/registry.py
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
35
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
36
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
37
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
38 Last but not least, restart Galaxy.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
39 All CADDSuite tools should now appear in your Galaxy webinterface.
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
40
bac3c274238f Migrated tool version 0.93 from old tool shed archive to new tool shed repository
marcel
parents:
diff changeset
41