diff readme.rst @ 1:ccadfae70b02 draft

Use $GALAXY_SLOTS instead of $SEQUEL_SITE_OPTIONS. Depend on package_blat_35x1 . Add readme.rst . Update Orione citation.
author crs4
date Wed, 05 Mar 2014 06:48:08 -0500
parents
children 208ce57f9221
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/readme.rst	Wed Mar 05 06:48:08 2014 -0500
@@ -0,0 +1,28 @@
+SEQuel wrapper
+==============
+
+Configuration
+-------------
+
+sequel_wrapper tool may be configured to use more than one CPU core by selecting an appropriate destination for this tool in Galaxy job_conf.xml file (see https://wiki.galaxyproject.org/Admin/Config/Jobs and https://wiki.galaxyproject.org/Admin/Config/Performance/Cluster ).
+
+If you are using Galaxy release_2013.11.04 or later, this tool will automatically use the number of CPU cores allocated by the job runner according to the configuration of the destination selected for this tool.
+
+If instead you are using an older Galaxy release, you should also add a line
+
+  GALAXY_SLOTS=N; export GALAXY_SLOTS
+
+(where N is the number of CPU cores allocated by the job runner for this tool) to the file
+
+  <tool_dependencies_dir>/sequel/1.0.2/crs4/sequel/<hash_string>/env.sh
+
+Version history
+---------------
+
+- Release 1: Use $GALAXY_SLOTS instead of $SEQUEL_SITE_OPTIONS. Depend on package_blat_35x1 . Add readme.rst . Update Orione citation.
+- Release 0: Initial release in the Tool Shed.
+
+Development
+-----------
+
+Development is hosted at https://bitbucket.org/crs4/orione-tools . Contributions and bug reports are very welcome!