Development News Brief

All News Briefs

Distribution Summary 2013_08_12

Get Galaxy

Please note new upgrade syntax

new: $ hg clone
upgrade: $ hg pull
$ hg update release_2013.08.12

# Core Distribution Process

If you need a refresher about how to upgrade or this is your first upgrade in a while, please see the latest instructions at Get Galaxy. Even more details are outlined in the April 2013 News Brief.

# Tool Shed Repository Process

Required metadata reset for installed tool shed repositories

It is critical that you reset the metadata on your installed tool shed repositories when you upgrade your Galaxy instance to this revision!

When a tool shed repository is installed into your local Galaxy instance, metadata is generated for the repository as a part of the installation process and stored in the tool_shed_repository.metadatatable column in the Galaxy database. This automatic process inspects the contents of the specific revision of the installed repository and generates and stores important information about it. This metadata information is used by certain Galaxy features. As new features are added to Galaxy or the tool shed, the process that generates this installed tool shed repository metadata within the Galaxy instance may be enhanced to accommodate information about the new features. Read more…

# Tools
  1. Data Manager
  • Individual location files are now namespaced when installed from the toolshed, and
  • Will write only to the location files that were installed along with them, when installed from a toolshed.
  • Allow a named Tool Data Table to be defined more than once. If column definitions match, allow merging multiple tables.
  • Permit multiple value translations to be specified per column and also allow multiple types of value translations.

# Visualizations


  1. A visualization is now defined as a page template that is sent certain data.
  2. Created flexible (and backwards compatible) way to serve data from datasets in useful formats.
  3. Moved to a 1 file per config in VisualizationRegistry structure to improve performance.
  4. New wiki page explaining the first, lowest level of the visualizations framework. Read it here...


  1. Phyloviz: Correct d3 translate and node error, and…
  2. Scatterplot: Correct failure for data provider to get column data from certain datatypes (BED).[/ClfwTdwp](/archive/dev-news-briefs/2013-08-12/ClfwTdwp/)
  3. Trackster: Correct bug where emptying 'Histogram maximum' field causes track to disappear.

# Workflows
  1. No longer require re-import when a Workflow requires new tools to be installed, and
  2. Guarantee reproducibility in all cases by considering tool versions not just tool ids, and
  3. Improve linkage/discovery using tool versions to associate lineage.
  4. Improved import functionality for published workflows.

# UI
  1. Upgrade jQuery to v1.9.1.
  2. Include #<hda_id> scroll to usage behavior in history panel.[/OcCloWa](/archive/dev-news-briefs/2013-08-12/OcCloWa/)H
  3. Tools no longer pop up in the Workflow editor.
  4. Resume/restart a failed workflow from the point of failure by pausing (not failing) downstream jobs, permitting modifications, then continuing.[/GuDsm5](/archive/dev-news-briefs/2013-08-12/GuDsm5/)MD,
  5. Remove unnecessary display button from uploading hdas (no usable action).


  1. Allow copy of HDA to Library based on permissions.
  2. raw_data: allow un-formatted return data.
  3. Adjust ability to delete histories with correct result: History deleted, HTTP 200 response or History doesn't exist, HTTP 400 response.,,

# Admin
  1. Better use of Sphinx auto docs: ensure proper settings (in docs makefile) to capture as much in-code documentation as possible.
  2. Add scrollbar to Administration panel.

# Core
  1. In the client, handle all errors more gracefully and in the worst case, use modal in place of alert.[/F535Sdb7](/archive/dev-news-briefs/2013-08-12/F535Sdb7/)
  2. Improvements to 'bad gateway' handling by history updater.
  3. Move rendering of user quota from the history panel to the masthead template to improve timing of update.
  4. Update pbs_python to 4.3.5.

# Pull Requests Merged
  1. Fix problems with with Postgres 8.x. #97. Thanks to Lance Parsons.[/Z0Eyn](/archive/dev-news-briefs/2013-08-12/Z0Eyn/)AV2
  2. Dynamic Toolbox Filtering. #160. Thanks to John Chilton.
  3. Datatype Tracking Refactoring. #86. Thanks to John Chilton.
  4. Fix detection of 2bit files when uploading. #170. Thanks to Gert Hulselmans. (also includes patch)
  5. New loc file for SAMtools indexes to support genome variants (backward compatible). #188. Thanks to Nicola Soranzo.

# Tool Shed

Tool Shed

New Tool Shed Features

  1. #1 Repository Types

The repository types feature in the Tool Shed provides a mechanism for categorizing repositories based on their contents, specifically the set of Galaxy utilities that they contain. Galaxy utilities are tools, custom datatypes, tool and repository dependency definitions and exported Galaxy workflows. The list of Galaxy utilities will expand in the future to include other items. Associating a repository with a type results in certain behaviors related to generating metadata for the repository revisions. As new repository types are introduced over time, these special behaviors may expand beyond repository metadata. Read more…

  1. #2 Repairing installed tool shed repositories

One of the features available for repositories installed into Galaxy is the ability to repair the repository and it's dependency hierarchy. Repairing a repository hierarchy will attempt to ensure all repositories in the hierarchy are correctly installed and all tool dependencies defined for each repository in the hierarchy are correctly installed. Read more…

Tool Shed feature enhancements

  1. #1 Repositories in the tool shed that contain tools that are not tested for any reason now display a "Not tested" container within the "Automated tool test results" section of the Manage repository page. This new container displays the reason the tool was not tested.
  2. #2 Enhanced tool dependency definition

    • Add support for optionally extracting a file downloaded with the download_file tool dependency action.
    • Add a change_directory action.
    • Contributions from Björn Grüning (thanks!) adding support for a template_command action type in tool dependency definitions for the tool shed. An example of the new action tag is:
<action type="template_command" language="cheetah">...</action>
  1. #3 Allow public usernames in the tool shed to be a minimum of 3 characters instead of the Galaxy minimum of 4 characters.
  2. #4 Raise an exception with a useful message if a dependency definition file being uploaded to a repository in the tool shed is missing a required name or owner attribute for a repository dependency.
  3. #5 Contribution from Björn Grüning (thanks, again!) to extend the valid list of README files in tool shed repositories to include .rst files along with his contribution that renders README files as restructured text.
  4. #6 Pushing changesets to repositories in the tool shed from the command line:
  • Only allow changes to a single file named tool_dependencies.xml to be pushed to a repository whose type is "Tool dependency definition", and
  • For any changes that are made to dependency definition files, validate the attributes of any tags, making sure that all required attributes (toolshed, name, owner, changeset_revision) are defined since automatically populating these attributes is supported only when using the tool shed's upload utility.
  1. #7 Tool shed functional test framework
  • Add new Tool shed functional tests for the repository type feature.
  • Add Tool shed functional tests for the $ENV[] environment variable inheritance feature.
  • Tool shed functional tests for repairing an installed repository.
  1. #8 Add the ability to display tool form components that are inside conditionals for tools contained in repositories in the tool shed.
  2. #9 Fix tool shed functional tests recently broken due to experimental rendering of README files in tool shed repositories.

Accepted Tool Shed pull requests

  1. A slight variation on Nicola Soranzo's pull request (thanks!) #176 for fixing large file downloads using download_by_url.

Miscellaneous Tool Shed fixes and enhancements

  1. Fix for handling multiple repository installations simultaneously when handle repository dependencies is checked and at least 1 selected repository for installation has no repository dependencies while at least one selected repository for installation does. This scenario occurs only when searching the tool shed for tools rather than browsing it for repositories.
  2. Fix for rendering the number of tool dependencies and repository dependencies that failed to install in the tool shed automated test framework rss feed.
  3. Make sure custom datatypes contained in newly installed tool shed repositories are loaded into the upload form's File Format select list. Also, when an installed repository is uninstalled, remove the appropriate datatype extensions from the upload form's select list.
  4. Fix for setting Galaxy's time interval for checking for updates available for install tool shed repositories.
  5. Fixes for rendering Repository Actions menus when browsing the tool shed from Galaxy, and fixes for rendering workflow images for exported workflows contained in tool shed repositories.
  6. Fix for handing comments as the last element in a set_environment tag set in tool dependency definitions. Contributed by Adam Novak (thanks!!).
  7. Standardize the Repository Actions menu for repositories installed into Galaxy.
  8. Fix for tool dependency installation when tarballs raise non-fatal errors (e.g., the tarball contains a symlink to a file that does not exist on the local system).
  9. Use a template for managing tool dependencies for a specified installed tool shed repository instead of a grid.
  10. Fix for allowing the Galaxy admin to select a tool panel section when installing a repository that contains no tools but has repository dependencies that contain tools.
  11. Fix for generating information about a repository being installed that has no defined repository dependencies.
  12. Enhance tool shed repository installation process to automatically reset the attributes of a previously installed repository (that is no longer in the installed state) so that it can be installed. This streamlines the installation process when installing multiple repositories so that one or more of them do not need to be uninstalled.
  13. Add the threadpool_kill_thread_limit setting to the tool shed's sample configuration file as well as Galaxy sample configuration file.
  14. Enhance the Galaxy API for installing tool shed repositories to make sure the tool_dependency_dir setting is defined in the Galaxy configuration file if installing tool dependencies along with repositories.
  15. Miscellaneous fixes for managing an installed tool shed repository's tool dependencies.
  16. Fix for installing tool dependencies when new_file_path is not set in the Galaxy configuration file.
  17. Fix the Galaxy API for installing tool shed repositories when attempting to install a repository that was previously installed but is not longer in the installed state.
  18. Fix for checking the Galaxy environment for missing migrated tools at server startup.
  19. Contribution from Björn Grüning (thanks!!) allowing installation of a repository to progress even if a repository dependency is not available. This will handle the case where a repository dependency's file is not available due to an error in it's installation, but if possible, the dependent repository will proceed with it's installation.
  20. Fix to correctly handle comments in repository dependency definitions.
  21. Apply Peter Cock's (thanks, again!) patch for appending an .rst extension to README file names in tool shed repositories.
  22. Fix for installing a repository with a complex tool dependency where the dependent repository's tool dependency definition does not define any set_environment actions.
  23. Do not truncate tool test input dataset names, as Galaxy no longer displays them truncated.
  24. Clear tool test results when the skip tool tests option is enabled.

Tool Shed Tickets

# Security Fixes

A security vulnerability was discovered this last release cycle by Björn Grüning with Galaxy's "user impersonation" feature that can expose an administrator's active history to users whom they impersonate. It is corrected by upgrading to this distribution.

Details: Only Galaxy instances with allow_user_impersonation = True set in their configurations are affected, and only if an administrator makes use of the impersonation feature. By default, user impersonation is disabled. Read the original alert email, sent on June 12th, 2013, that includes a work-around should you choose not to upgrade immediately…

# Bug Fixes
  1. Fix bug where stopping job via admin interface causes exception.
  2. Fix bug in hpanel (Chrome) related to broken persistent expanded hda views.
  3. Fix bug where deleted user Workflows were not removed from tool menu (if added).
  4. Fix bug in reports webapp imports (thanks to Lance Parsons).
  5. Fix bug where Workflow and tool annotations are lost when importing workflows from tool shed repositories.
  6. Fix bug where setting dataset security was interfering with the the Galaxy UI.
  7. Fix bug in proper display of a permanently deleted history.
  8. Fix bugs with default genome and selection display when adding library data files.[/Hr1JdeGq](/archive/dev-news-briefs/2013-08-12/Hr1JdeGq/)

GCC 2013
**GCC 2013**

Project Updates

News, August 2013 Galaxy Update

GCC 2013 Wrap-up

GCC2013 Report: Meeting summaries, and links to videos, talks, posters, and Training Day materials.

New Way to "Use Galaxy"

**Galaxy Edition of SlipStream: Galaxy is now available as an appliance.

# About

The Galaxy Team is a part of BX at Penn State, and the Biology and Mathematics and Computer Science departments at Emory University.

Galaxy is supported in part by NSF, NHGRI, the Huck Institutes of the Life Sciences, and The Institute for CyberScience at Penn State, and Emory University.

Join us at Twitter @galaxyproject or just read our tweets [Galaxy on Twitter]( on Twitter)

Have a suggestion? Please see Using the Galaxy Issue Board.