Development News Brief
Get Galaxy
new: % hg clone http://www.bx.psu.edu/hg/galaxy galaxy-dist
upgrade: % hg pull -u -r 17d57db9a7c0
# EMBOSS Tool Migration
The Emboss 5.0.0 tools, datatypes and functional test data files have been removed from the Galaxy code base in this revision and have been migrated to the Galaxy tool shed. This will affect you only if you are using the Emboss 5.0.0 tools in your local Galaxy environment by having one or more of them defined in you local tool_conf.xml file.
**After you update your Galaxy code base to this revision (if you use any of the [EMBOSS](http://emboss.sourceforge.net) tools), attempting to start your Galaxy server will display a message with instructions on what to do to install the tools from the tool shed.** You can choose to not install the tools and start your Galaxy server - it will start on this second attempt.
If you decide to install the tools, the location in which the Emboss repositories will be installed is the value of the "tool_path"
attribute in in the <tool>
tag of the file named "migrated_tools_conf.xml"
in your Galaxy installation directory. The default location setting is "../shed_tools"
, which may be problematic for some cluster environments, so make sure to change it before you execute the installation process if necessary.
If your local Galaxy environment is configured to run multiple web front-ends, you should start up a single front-end for your Galaxy server and watch its paster log
to see the instructions. If you start all configured web front-ends, only the first one started will produce the instructional message, and others will start up your Galaxy server.
At any point, you can install the EMBOSS tools by executing the following from your Galaxy installation directory.
sh ./scripts/migrate_tools/0002_tools.sh
After installation, the tools should be displayed in your Galaxy tool panel in precisely the same way that they were displayed before the installation. In order for this to happen, however, you must have the tools defined in your local tool_conf.xml
file as you want them displayed in your tool panel before you perform the installation. After the installation, you can remove the entries for them from your tool_conf.xml file
.
We highly recommend that you read the following sections of the Galaxy tool shed wiki (if you have not already done so) to get all of the details about how this process works.
Migrating tools from the Galaxy distribution to the Galaxy Main tool shed
# New Tool Integration Testing
Use Galaxy's functional test framework to test tools installed into your local Galaxy instance from Tool Shed repositories that contain tools with defined functional tests. For tests to work, the repository must include a directory named test-data somewhere in its file system hierarchy, and all functional test input and output datasets must be included in this directory. Read more...
# Updates to Tool Panel Configuration
Galaxy now supports multiple tool panel XML configuration files for populating the tool panel. You can have any number of file names defined in the comma-separated list of tool panel configuration files for the "tool_config_files"
setting in your universe_wsgi.ini
file.
For example:
tool_config_files = tool_conf.xml,tool_conf1.xml,shed_tool_conf.xml,shed_tool_conf1.xml, etc.
Managing the layout of your Galaxy tool panel is easier! New tool panel items manually added to a tool panel configuration file will now be inserted into an existing integrated_tool_panel.xml file in the proper location. Read more...
# Multiprocess Job Handling
Galaxy has previously been able to split into multiple processes to better spread the load of handling web traffic, but only one process could be used to handle job management. Galaxy can now be split in to any number of web processes, and any number of job handlers. A single job manager must be run to assign jobs to handlers. If you've configured Galaxy with multiple processes as per the "Production Server" documentation, configuration changes will be necessary to use this new functionality. If you do not change your configuration, each web processes will manage its own jobs, which you almost certainly do not want. Read more...
# UCSC Display Sites
If use_remote_user = True
in your config, Galaxy previously used a hardcoded list to determine what servers were allowed to bypass security to read datasets for display. This list is now configurable via the display_servers
. If you have modified galaxy-dist/lib/galaxy/web/framework/middleware/remoteuser.py
to modify the list of hardcoded servers you will most likely experience merge conflicts upon pulling this distribution. If this is the case, you should remove your local modifications and use the display_servers
configuration option, which is documented in universe_wsgi.ini.sample.
# Enhanced OpenID Support
Abstract OpenID providers to be defined outside of the Python code and to allow customization of post-authentication actions (currently restricted to storing sreg
attributes into user preferences; but more functions can be added as needed). See individual examples in openid/
and the list of enabled OpenID providers in openid_conf.xml.sample
to add your own.
# New Configurable Tool Output Location
Tools using the process described at 'Admin/Tools/MultipleOutputFiles' to write multiple output files to the temporary directory defined as new_file_path may now write to the job working directory instead. This can have a performance benefit if there are a lot of files in the directory set in new_file_path
. A configuration option, collect_output_from
has been added that controls where Galaxy will look for these outputs. By default, it will look in both places since many of the tools in the Galaxy distribution use new_file_path
.
# Tools
Admin/Config/Tool Dependencies
-
NGS: GATK Tools (beta)
-
Added GATK version 1.4
- Compiled from v1.4-18-g80a4ce0
- Genome Analysis Toolkit (beta) tool group includes: Depth of Coverage on BAM files; Print Reads from BAM files; Realigner Target; Creator for use in local realignment; Indel Realigner - perform local realignment; Count Covariates on BAM files; Table Recalibration on BAM files; Analyze Covariates - draw plots; Unified Genotyper SNP and indel caller; Variant Annotator; Variant Filtration on VCF files; Select Variants from VCF files; Variant Recalibrator; Apply Variant Recalibration; Validate Variants; Eval Variants; Combine Variants.
- Additional tool documentation developing over next few months. For now, refer to GATK tool author help.
-