Galaxy/fr: Difference between revisions
No edit summary |
No edit summary |
||
Line 96: | Line 96: | ||
** Running jobs on the gateway machine is not recommended due to limited memory and inefficiency. | ** Running jobs on the gateway machine is not recommended due to limited memory and inefficiency. | ||
* Customization: | |||
** You may need to adjust the job_conf.xml file based on tool requirements, particularly for memory allocation and walltime limits; optimizing these values is crucial to ensure tools run efficiently and do not fail due to resource constraints. | |||
* Testing: | |||
** Perform test runs to determine the appropriate memory and walltime for each tool. |
Revision as of 20:31, 5 December 2024
Introduction
Galaxy est une plateforme web open source pour la recherche biomédicale traitant de grandes quantités de données. La plateforme rend la biologie computationnelle plus accessible, sans exiger une grande expérience en programmation ou en administration de systèmes. Conçue au départ pour la recherche en génomique, Galaxy s’adapte aujourd'hui à la plupart des domaines et sert de système de gestion du flux de travail en bio-informatique. Cette liste de tutoriels présente une bonne vue d’ensemble des possibilités qu’offre Galaxy.
Vous avez deux options pour utiliser Galaxy :
- accéder directement à UseGalaxy Canada,
- demander une instance de Galaxy sur Cedar.
Tableau comparatif des options
UseGalaxy Canada | Instance de Galaxy sur Cedar | |
---|---|---|
Serveur | nuages Béluga et Arbutus | Cedar |
Configuration | aucune configuration nécessaire | vous-même |
Connaissance préalable de Linux | aucune connaissance préalable | connaissance avancée |
Gestion/Mises à jour | notre équipe UseGalaxy Canada | vous-même |
Configuration du serveur | aucune | vous-même |
Outils préinstallés | synchronisés avec UseGalaxy.eu | outils par défaut (sous-ensemble) |
Intégration avec Irida | non | oui |
Génomes de référence | contenus dans CVMFS | gérés par vous-même |
Quota | 500GB par utilisateur | espace de stockage alloué par concours |
La plateforme UseGalaxy est fortement recommandée pour le traitement de gros fichiers ou pour des tâches qui nécessitent plusieurs CPU ou GPU.
Accéder directement à UseGalaxy Canada
Pour accéder à UseGalaxy Canada, simplement suivre le lien https://starthere.usegalaxy.ca, puis cliquer sur le bouton de connexion via CILogon et sélectionner votre établissement pour vous authentifier. La plateforme détecte si vous êtes un utilisateur canadien et vous octroie automatiquement une allocation par défaut de 500GB de stockage.
Le site https://starthere.usegalaxy.ca fournit toute l’information nécessaire concernant UseGalaxy.ca et Galaxy en général, de même qu’un formulaire si vous avez besoin d’assistance, voulez rapporter un problème, ou encore faire installer de nouveaux outils ou bases de données.
Demander une instance de Galaxy sur Cedar
Chaque groupe de recherche peut obtenir une instance Galaxy sur la grappe Cedar. Puisque l’installation demande une configuration particulière, contactez notre équipe technique.
Structure du répertoire
L’installation se fait habituellement dans le répertoire /project du groupe de recherche. Le nom du répertoire le plus haut est formé par les deux premiers caractères du nom de la chercheuse ou du chercheur principal (CP), auxquels est ajouté glxy. Par exemple, pour le CP davidc, le nom du répertoire source sera daglxy; le répertoire sera localisé dans /project/group name/ où group name est le nom du groupe par défaut pour ce CP (def-davidc). Le répertoire principal pour Galaxy contient un ensemble de sous-répertoires qui est quelque peu différent du paquet Galaxy original, soit%nbsp;:
- config : contient tous les fichiers de configuration pour préparer et optimiser le serveur Galaxy. Dans cette page, nous présenterons seulement les principes de base pour notre environnement de calcul haute performance,
- galaxy.log : ce fichier contient tous les messages générés à l'ouverture et à la fermeture du serveur,
- server.log : ce fichier contient tous les messages générés pendant l'exécution.
Propriété et modification des fichiers
Tous les fichiers de votre instance Galaxy appartiennent à un pseudo-compte, un compte partagé qui est généré par un administrateur au moment de l'installation. Un pseudo-compte n'appartient pas à une personne en particulier, mais à un groupe. Tous les membres du groupe peuvent se connecter au pseudo-compte à l'aide de clés SSH. Le nom du pseudo-compte est le même que celui du répertoire Galaxy supérieur qui est formé comme expliqué ci-dessus (daglxy). Pour modifier un fichier de votre instance Galaxy, par exemple les fichiers de configuration, vous devez d'abord vous connecter au pseudo-compte. Pour ce faire, vous devez d'abord générer une paire de clés SSH, stocker votre clé publique quelque part dans votre répertoire personnel et en informer l'administrateur. L'administrateur stockera votre clé publique dans un endroit approprié, après quoi vous pourrez vous connecter au pseudo-compte.
Gestion du serveur Galaxy
La première chose à faire est de démarrer le serveur Galaxy. Ce serveur NE DOIT PAS se trouver sur un nœud de connexion ou sur un nœud de calcul de Cedar. Nous vous recommandons d'utiliser le serveur dédié appelé gateway qui contient un serveur web avec les répertoires /project et /home pertinents. Pour des raisons de sécurité, vous ne pouvez pas établir de connexion SSH à cette passerelle; cependant, nous avons conçu une interface sur cette passerelle qui vous permet de démarrer/arrêter votre serveur Galaxy et d'utiliser l'interface web de Galaxy pour communiquer avec le serveur. Pour démarrer le serveur Galaxy, suivez https://gateway.cedar.computecanada.ca/ et cliquez sur le lien Galaxy. Vous devrez entrer votre nom d'utilisateur et votre mot de passe (les mêmes que ceux que vous avez saisis dans votre compte avec l'Alliance). Après la procéduire d'authentification, la page du gestionnaire de votre serveur Galaxy sera affichée et vous pourrez gérer votre serveur ou utiliser l'interface web Galaxy.
Configuration du serveur Galaxy
La configuration du serveur se fait avec les fichiers du répertoire config. Nous n’expliquons pas ici en détail comment configurer et optimiser Galaxy. Nous vous invitons plutôt à consulter | le site web de Galaxy.
À l’installation, les variables de base sont paramétrées par l’administrateur dans le fichier de configuration galaxy.yml. Vous pouvez modifier les autres fichiers et variables de ce fichier, mais nous recommandons fortement de ne pas modifier les variables de base suivantes :
- In file
galaxy.yml
(the main configuration file):http:
contains your unique port numberdatabase_connection
is the name of your Galaxy database and your database server.virtualenv
is the path to a Python virtual environment in the gateway machinefile_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
are appropriate paths for tools, tool sheds and dependencies.
Other variables and files in this directory can be changed by the user.
Utiliser les outils
There are basically two ways to run tools in your Galaxy instance.
- Run tools on gateway (locally) where galaxy server was installed.
- Run tools by submitting jobs to cedar cluster.
Submitting jobs
Here are some key points you need to know regarding job submission:
- Default configuration:
- Galaxy uses
job_conf.xml
to define how and where jobs are executed. - By default, jobs are submitted to the Cedar cluster.
- Galaxy uses
- Avoid running locally:
- Running jobs on the gateway machine is not recommended due to limited memory and inefficiency.
- Customization:
- You may need to adjust the job_conf.xml file based on tool requirements, particularly for memory allocation and walltime limits; optimizing these values is crucial to ensure tools run efficiently and do not fail due to resource constraints.
- Testing:
- Perform test runs to determine the appropriate memory and walltime for each tool.