Galaxy: Difference between revisions

Line 32: Line 32:
=== Galaxy configuration ===
=== Galaxy configuration ===


All files in <code>config</code> directory are used to configure your Galaxy server. Configuring and optimizing Galaxy is very tricky and requires a broad scientific and technical knowledge and explaining all of them is beyond our topic. We assume users who are requiring galaxy have knowledge to further setup its own galaxy instance. Here we explain some important and basic setup that needed to be done by admin in order to server to work. We recommend to go though configure files and set them up appropriately. However, we strongly recommend not to overwrite the following variables that are set by the admin. Here are some of those variables:
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. Here we explain some configuration details which you should know about. We recommend you go though these configuration files and set them up appropriately. However, we strongly recommend not to overwrite the following variables that are set by the admin. Here are some of those variables:


* File <code>galaxy.yml</code>: its most important and the main configure  file. The following variables are set in this file:
* File <code>galaxy.yml</code>: its most important and the main configuration file. The following variables are set in this file:
** <code>http:</code> contain your unique port number
** <code>http:</code> contains your unique port number
** <code>database_connection</code> the name of your Galaxy database and your database server.
** <code>database_connection</code> is the name of your Galaxy database and your database server.
** <code>virtualenv</code> the path to python virtual environment in gateway machine
** <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> setup appropriate paths for tools, tool sheds and dependencies.
** <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.


* <code>job_conf.xml</code>: All variables in this files is used in job submission to cedar. Various packages have different job specification, for example package "spades" uses 8 cores with the walltime of 3 hours and job will be submission under your default group name <code>def-xxxxx</code>. Please take a look at this file and setup your desire job specification. Note that any change in these configuration files requites to restart  the server.
* <code>job_conf.xml</code>: Variables in this file are used for [[Running jobs|submitting jobs to Slurm]]. Various packages have different job specifications. For example, package "spades" uses 8 cores with a wall-time of 3 hours and the job will be submitted under your default group name <code>def-xxxxx</code>. Please take a look at this file and set up your desired job specifications. Note that any change in these configuration files requires the server to be restarted.
Bureaucrats, cc_docs_admin, cc_staff
2,879

edits