Galaxy
Galaxy is a web portal allowing to execute bioinformatics analysis in a user-friendly environment.
GenOuest has been hosting and operating two (very similar) Galaxy servers since several years:
Migration to UseGalaxy.fr
After long thought, we have decided (as of January 2023) to shut down our two Galaxy servers in the coming months, and to focus our efforts on the French national Galaxy server: UseGalaxy.fr.
Although we are focusing on a migration to UseGalaxy.fr in this document, you should be able to migrate to any other Galaxy server of your choice (like UseGalaxy.org, UseGalaxy.eu or UseGalaxy.org.au) following the same instructions.
Why this migration?
Here are the main reasons:
- UseGalaxy.fr is supported by the IFB (Institut Française de Bioinformatique). As GenOuest is a member platform of IFB, and just as we already participate to numerous other IFB projects, it feels natural to join this federating initiative
- We are actually already active contributors to the national UseGalaxy.fr server since 2020
- Maintaining a Galaxy server takes significant time and resources. As UseGalaxy.fr is becoming more mature and robust, we feel like maintaining our two local servers is an unneeded duplication of efforts
- While our instances use to have some very specific features (access to storage from the GenOuest cluster, specific tools and workflows), most of these features are now available on any other Galaxy server, including UseGalaxy.fr
But is GenOuest still interested in Galaxy?
Yes we are!
First, while you will access Galaxy at a different address, keep in mind that we will still be working on it behind the scene, with other IFB contributors.
GenOuest is also active in different international projects involving Galaxy (e.g. Gallantries, EuroScienceGateway, UseGalaxy.eu). We definitely intend to stay active contributors to the Galaxy ecosystem and to UseGalaxy.fr!
So when is the migration planned?
Here's our tentative roadmap:
- Now (January 2023): no new developments on galaxy.genouest.org or bipaa-galaxy.genouest.org, users are encouraged to start migrating to UseGalaxy.fr
- May 1st 2023: the submission of new jobs is no longer possible, but the users can still access their data and download it or transfer it to UseGalaxy.fr
- July 1st 2023: migration is officially finished, and galaxy.genouest.org or bipaa-galaxy.genouest.org are shut down. All data is permanently deleted.
If you have any questions, or if you need help in this migration, please contact us at support@genouest.org. We will do our best to make the process as smooth as possible.
What will happen to your data?
First, we would like to remind you that you should not rely (only) on Galaxy for long term storage of analyses results. Actually, the data currently stored on galaxy.genouest.org or bipaa-galaxy.genouest.org is located on an equipment that is no longer under warranty, and we do not have any backup.
With the following instructions, you should be able to either store old analyses on secured storage, or transfer unfinished analyses to UseGalaxy.fr where you will be able to continue your work.
From any Galaxy server, you can easily export an entire history into a single file (tar.gz archive, in a standard format). This file will contain each dataset from your history, as individual files, and all the metadata concerning each dataset. You can store this file on the storage of your choice for a future usage. And you can also at any time import this archive back into a new history on any Galaxy server and continue working on it as usual.
UseGalaxy.fr account
If you plan on using UseGalaxy.fr, you will first need to have an account. You can easily create a new one by clicking on the Login or Register link at the top of Galaxy's welcome page, then clicking on "Don't have an account? Register here".
If you prefer, you can also use your institution account, by clicking on the "Elixir LOGIN" button on this same page.
How to download an history
Click on history menu, and select "Export History to File":
You should see a page looking like this:
Click on the "Click here to generate a new archive for this history." link. This will launch a job on the compute cluster to generate the file containing all the history data.
Wait a moment (depending on the size of the history), and when the file is ready, a link will appear, from which you will be able to download the archive containing your history (beware, the file can be big depending on your history size).
Generating the file can take some time for big histories, you can safely disconnect and come back later to this page to check if the download link is ready (just click back on the history menu, and select "Export History to File").
How to export an history to the GenOuest cluster
Before doing this, you need to fill in your GenOuest account credentials into your Galaxy user preferences, follow the instructions to access storage spaces from the GenOuest cluster in Galaxy below to learn how to do it.
Click on history menu, and select "Export History to File":
You should see a page looking like this:
Click on "to a remote file" on the left, then click on Click to select directory.
Now click on GenOuest FTP server:
And now you need to select a directory where the exported history will be deposited by Galaxy.
Choose a name for the file that will be created, and click on Export.
Generating the file can take some time for big histories, the file will appear on the GenOuest cluster when it's finished.
How to upload an history to UseGalaxy.fr
If you don't have a GenOuest account the easiest is to export the history, download it to your hard drive, then import it to UseGalaxy.fr:
Go to your histories list:
Click on the Import history button at the top right. Choose Upload local file from your computer and select the history file you have downloaded previously.
Click on the Import history and wait for the file to be uploaded and then extracted as a new history.
Note that with this method, you might get an error when trying to transfer big histories. This is a known limitation that should be fixed some time soon. Prefer the next method (using the GenOuest cluster) if you have this problem, and if it does no work, contact us if this is blocking for you.
How to transfer an history from the GenOuest cluster to UseGalaxy.fr
If you have a GenOuest account, you can directly transfer from galaxy.genouest.org (or bipaa-galaxy.genouest.org) to UseGalaxy.fr like this:
- First configure your account on both Galaxy server to access storage spaces from the GenOuest cluster
- Then from the source Galaxy server, export your history to one of your storage volume on the cluster
- Finally from UseGalaxy.fr, import the history
Go to your histories list:
Click on the Import history button at the top right. Choose Select a remote file (e.g. Galaxy's FTP).
Now click on GenOuest FTP server:
And select the history file you have exported previously
Click on the Import history and wait for the import process to finish.
How to access storage spaces from the GenOuest cluster in Galaxy
If you have a GenOuest account, you can access directly your GenOuest cluster storage volumes from galaxy.genouest.org, bipaa-galaxy.genouest.org or UseGalaxy.fr.
This allows to transfer files directly between the cluster and Galaxy, without needing to download it on your local computer first, making the transfer much faster.
To enable this, you need to enter your GenOuest account login and password in your Galaxy user preferences (do it only once the first time you want to make use of it).
Click on the User menu at the top, then on Preferences:
Then click on Manage information:
And scroll down to the Your GenOuest/CeSGO account. There you need to write your GenOuest account login and password.
And click on the Save button at the bottom of the page.
You're done! Now you should be able to import files from the cluster into Galaxy.
Click on the Upload Data button in Galaxy, and then click on Choose remote files:
Now click on GenOuest FTP server:
Now you can navigate in the cluster storage and select the files that you want to import into Galaxy:
Use the checkboxes to select the desired files.
This method uses the same permission system as on the cluster, so you will only be able to access files that you would be able to access on the cluster.
How to ask for more quota on UseGalaxy.fr
The best place to ask for this is on the UseGalaxy.fr forum.
The default quota is 100Gb, but we can give you more if you need. Please be reasonable: if you have some finished analyses in Galaxy the best is probably to export it out of Galaxy to save space in your quota. You will always have the possibility to reimport it later if you need to access it or make new analyses on it.
How to install missing tools or to get help on UseGalaxy.fr
The best place to ask for this is on the UseGalaxy.fr forum.