View source for Galaxy/en

<languages />


== Introduction ==

Galaxy is an open source, web-based platform for data-intensive biomedical research. It aims to make computational biology accessible to research scientists that do not have computer programming or systems administration experience. Although it was initially developed for genomics research, it is largely domain-agnostic and is now used as a general workflow management system in bioinformatics.

The list of tutorials [https://training.galaxyproject.org/ here] suggests the range of applications of Galaxy.

== Galaxy on Cedar ==

On cedar we provide one Galaxy instance for every research group. Galaxy installation requires a special setup that needs to be done by Alliance staff. If you need Galaxy for your group please write an email to support team.

=== Galaxy directory structure ===

Galaxy is usually installed on the project directory of the group and it contains several sub-directories. The name of the Galaxy top directory is determined by taking the first two character of PI username + "glxy". For example if PI username is "davidc" the Galaxy top directory will be "daglxy" and it is located in <code>/project/group name/</code> where <code>group name</code> is the default group name of PI, eg., <code>def-davidc</code>. Galaxy main directory contains the following sub-directories which is slightly different than the original Galaxy package.

* '''config''': contains all required configuration files to set up and optimize the Galaxy server. Below we explain some basic concepts of some of the configuration files that need to be set up in order to be compatible with our HPC environment, however, we will not cover all concepts.  
* '''galaxy''': contains the core Galaxy package which is written mostly in Python. 
* '''logs''': contains two files, <code>galaxy.log</code> and <code>server.log</code>.  All messages during startup or shutdown of the server are written in <code>server.log</code> while all messages during the run are written in <code>galaxy.log</code>.  
* '''plugins''': contains all plugins. In the original Galaxy package, this directory is located in the <code>galaxy</code> directory. 
* '''tmp''': contains all temporary files that Galaxy needs for compiling and installing toolsheds. 
* '''venv''': a Python virtual environment directory that contains all Python package dependencies.
* '''tool-data''': contains data used by tools. See the samples in [https://galaxyproject.org/admin/data-integration data-integration].
* '''tool-dependencies''': contains all packages needed for toolsheds. By default, packages in this directory are installed using Anaconda. 
* '''database''': contains input, output, and error files of all jobs that run on cluster nodes.

=== Galaxy files ownership and modification ===

All files of your Galaxy instance belong to a "pseudo-account", a shared account that is generated by an administrator at installation time. A pseudo-account does not belong to an individual person, but belongs to a specific group. Everyone in the group can log in to the pseudo-account using [https://docs.computecanada.ca/wiki/Using_SSH_keys_in_Linux SSH keys]. The name of the pseudo-account in this case is the same name as the top Galaxy directory explained above, eg., <code>daglxy</code>. In order to modify any file of your Galaxy instance, e.g. configuration files, you first need to log in to the pseudo-account. Before you can log in you must generate an SSH key pair, store your public key somewhere in your <code>home</code> directory, and let the administrator know about that. The administrator will store your public key in an appropriate place, after which you can log in to your pseudo-account.

=== Galaxy server management ===

Starting Galaxy server is the first thing that needs to be done by users. Galaxy server should NOT be run on cedar login node or any compute node. We have a dedicated server called  "gateway" and it is used for this purpose. It contains a web server with relevant Cedar filesystems, <code>/project</code> and <code>/home</code> directories mounted on it. Users cannot make a SSH connection to this machine due to security reasons, however we have designed a web site on this machine that allows users to start/stop  their own galaxy server. The website also allows users to user Galaxy web interface to communicate with the server. To do that please go to the website [https://gateway.cedar.computecanada.ca/ https://gateway.cedar.computecanada.ca/] and click on the Galaxy link. You will be asked to enter your username and password. Your username and password is the same as your computecanada one. Once you authenticate then you will be automatically redirect to your galaxy server manager website where you can manage your server or use Galaxy web interface.

=== Galaxy configuration ===

Files in the <code>config</code> directory are used to configure your Galaxy server. Configuring and optimizing Galaxy is tricky and explaining all the configuration files is beyond the scope of this article. If you want more information about this we recommend you read documentation on the [https://docs.galaxyproject.org/en/master/admin/config.html Galaxy website].  We list below some basic variables that are set for you by the administrator.  We strongly recommend you do not change them.

* In file <code>galaxy.yml</code> (the main configuration file):
** <code>http:</code> contains your unique port number
** <code>database_connection</code> is the name of your Galaxy database and your database server.
** <code>virtualenv</code> is the path to a [[Python#Creating_and_using_a_virtual_environment|Python virtual environment]] in the gateway machine
** <code>file_path, new_file_path, tool_config_file, shed_tool_config_file, tool_dependency_dir, tool_data_path, visualization_plugins_directory, job_working_directory, cluster_files_directory, template_cache_path, citation_cache_data_dir, citation_cache_lock_dir</code> are appropriate paths for tools, tool sheds and dependencies.

<!--T:16-->
Other variables and files in this directory can be changed by the user.
=== Running Tools ===

There are basically two ways one can run tools in a Galaxy instance.  One can run them "locally", which in this case means running on the gateway machine, or one can run them by [[Running jobs|submitting jobs]] to the cluster. 

Please DO NOT run tools locally at Cedar, because the gateway machine has little memory and cannot run jobs efficiently. Galaxy is configured to submit jobs to the cluster using the file <code>job_conf.xml</code>. Some variables in this file are already set by the administrator for submitting jobs. However, you may need to optimize the entries in this file depending on the tools you will use. Please first examine the file to understand these variables and the way they are used. For example, some tools require more memory or more walltime. Please perform some tests to find out optimized job specification values for every tool you would like to run.

== Galaxy on GenAP ==


The [https://www.genap.ca/ Genetics and Genomics Analysis Platform] (GenAP) is a computing infrastructure and software environment for life science researchers offering services since 2015. GenAP aims at facilitating the work of researchers and students by offering out of the box Web applications running on an infrastructure that currently leverages Alliance Cloud and HPC resources. 

Any Alliance user can [https://www.genap.ca/p/help/introduction request an account on GenAP] free of charge. Other users can be [https://www.genap.ca/static/subsections/help/tutorials/GenAP_Online_Tutorials__Accounts_and_Authentication.pdf invited] if they have an Alliance sponsor.

GenAP offers the ability to use your own privately accessed Galaxy instance, loaded with 700+ preinstalled tools. The GenAP-Galaxy is fully integrated with the GenAP infrastructure, allowing users to leverage storage and compute resources from the Alliance as well as interact with other GenAP applications. 

===  Tools ===
GenAP-Galaxy comes with more than 700 pre-installed tools and reference Genomes. There is no need for user configuration or installation.

The GenAP team has also developed some Single-Cell tools that are integrated with GenAP visualization tools.

GenAP has also close ties with the main Galaxy community and updates of reference genomes and index files are synchronized with the main usegalaxy.org.

GenAP-Galaxy tries to keep its tool set as close as possible to those of the main Galaxy (usegalaxy.org). 

In some cases we can add new tools on request, however, this decision is made on a per case basis. 

For safety reasons users are not allowed to install tools.

===  Running tools ===

There is no need for any configuration on GenAP-Galaxy. All tools, index files and reference genomes come pre-installed.

The jobs are submitted to a cluster using slurm (no configuration needed). Jobs are submitted with default parameters ( 10GB RAM, 24hrs,  2 CPUs ). 

Through the '''Job Resources Parameters''' menu users can modify the default walltime, number of processors and RAM of a job. This is specially useful for large jobs (such as genome assembly), where the default may not be enough.



=== Galaxy documentation ===
GenAP has a vast [https://www.genap.ca/p/help/galaxy-in-genap documentation] on data analysis ( +50 tutorials ) and also [https://www.genap.ca/p/help/galaxy-in-genap how to get started] with Galaxy on GenAP.

== GenAP or Cedar, where to analyze my data ? ==

This table is to help new user to choose where to run their data. Each of these two Galaxies have specific features that may be more suitable for some research groups.

{| class="wikitable"
|-
! Feature  !! GenAP !! Cedar
|-
| Server || Arbutus || Cedar
|-
| Galaxy configuration || None || High (done by user)
|-
| Required knowledge of Linux || None || High
|-
| Management/Updates || GenAP team || User
|-
| Server configuration || None || User
|-
| Pre-installed tools || Yes || Yes (subset)
|-
| Irida integration || No || Yes
|-
| Reference Genome || Yes (through CVMFS) || Managed by user
|-
| Quota || 1.5 TB (default) || storage RAC
|}